Player Group
Player Group can be filtered to store multiple players, and traverse the player group to perform uniform actions on the players in the player group.
Functions
add_player
Add a player.
Parameter
| Variable | Type | Description |
|---|---|---|
player | player | Player. |
player_group:add_player(player)remove_player
Remove a player.
Parameter
| Variable | Type | Description |
|---|---|---|
player | player | Player. |
player_group:remove_player(player)clear_group
Clear the group.
player_group:clear_group()get_player_num
Get the number of players in a player group.
player_group:get_player_num()get_all_players
Get all players.
Return
| Type | Description |
|---|---|
| player_group | Unit group. |
player_group.get_all_players()get_player_group_by_camp
All players in the camp.
Parameter
| Variable | Type | Description |
|---|---|---|
camp | integer | Camp. |
Return
| Type | Description |
|---|---|
| player_group | Unit group. |
player_group.get_player_group_by_camp(camp)get_enemy_player_group_by_player
All hostile players of the player.
Parameter
| Variable | Type | Description |
|---|---|---|
player | player | Player. |
Return
| Type | Description |
|---|---|
| player_group | Unit group. |
player_group.get_enemy_player_group_by_player(player)get_ally_player_group_by_player
All allied players of the player.
Parameter
| Variable | Type | Description |
|---|---|---|
player | player | Player. |
Return
| Type | Description |
|---|---|
| player_group | Unit group. |
player_group.get_ally_player_group_by_player(player)get_victorious_player_group
Get all the victorious players.
Return
| Type | Description |
|---|---|
| player_group | Unit group. |
player_group.get_victorious_player_group()get_defeated_player_group
Get all defeated players.
Return
| Type | Description |
|---|---|
| player_group | Unit group. |
player_group.get_defeated_player_group()get_neutral_player_group
All non-neutral players.
Return
| Type | Description |
|---|---|
| player_group | Unit group. |
player_group.get_neutral_player_group()