Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Migrated to Confluence 5.3
| Excerpt |
|---|
Returns an array of players objects for living allied players. |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
var allies = Players.allies; // array of allies players objects |
Return value
An array of allied Players Objects, excluding me, spectators and vacant slots.
If you want a similar array that includes me, use Players.alliesAndMe[] instead.
Notes
The indexes in the array are sequential and not based on player IDs.
Uses caching to boost performance. The cache is automatically invalidated every game tick. See Cache API for details.
Example
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Players.allies.forEach(function(ally) {
// ally = players object for current ally
// ally.id = id of allied player
}); |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
// you could do this: var isAlly = allianceExistsBetween(me, playerID); // but it won't filter out spectators or vacant slots // this, on the other hand, does filter them out: var isAlly = Players[playerID].isAlly; // if you want to know if they are living ally: var isLivingAlly = Players[playerID].isAlly && Players[playerID].isAlive; |
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||
|---|---|---|
| ||
See alsoRelated articles:
|
| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Players APITopics:
|