Player

Alliances

Alliance Aspect

• Returns true of the source player is treating the target player with the specified alliance aspect. To check if two players are mutually treating each other with a given alliance aspect, use this function again with the players in reverse order.

Get Relationship Between Players

• Returns true of the source player is treating the target player as ally, enemy, or neutral. Use the Mutual options to check if two players treat each other as mutual allies, enemies, or neutrals.

Set Alliance Aspect

• Sets the alliance aspect of one player towards another player, but not vice-versa. This action will turn enable or disable the chosen Alliance Aspect, such as shared vision or hostility, for the Source Player towards the Target Player. Pushable means that the Target Player's units are allowed to push the Source Player's units out of the way if they are trying to path through them.

Set Alliance

• Sets alliance settings between two players. This action will determined how two players treat each other, such as whether or not their units fight. Pushable means that one player's units are allowed to push another player's units out of the way if they are trying to path through them.

Set Alliance (One-Way)

• Sets the alliance settings of one player towards another player, but not vice-versa. This action will determine how the Source Player treats the Target Player, such as whether or not the Source Player's units fight the Target Player's units. Pushable means that the Target Player's units are allowed to push the Source Player's units out of the way if they are trying to path through them.

Set Alliance For Player Group

• Changes alliance settings for all players in the player group. Each player applies the requested alliance setting to every other player in the player group. Pushable means that one player's units are allowed to push another player's units out of the way if they are trying to path through them.

Clear Alliance

Make Ally

Charges And Cooldowns

Add Charge Regen Time For Player

• Adds to the amount of time it takes to regenerate the specified player charge link.

Add Charge Used For Player

• Consumes the specified number of charges for the specified player charge link.

Add Cooldown For Player

• Adds time to the specified player cooldown link.

Player Charge Regen

• Returns the charge regen time for the specified player charge link.

Player Charge Used

• Returns the number of charges used for the specified player charge link.

Player Cooldown

• Returns the cooldown time for the specified player cooldown link.

Pause/Unpause All Charges For Player

• Pauses or unpauses regen for all charges for the specified player.

Pause/Unpause All Cooldowns For Player

• Pauses or unpauses all cooldowns for the specified player.

Remove Charge Regen Time For Player

• Clears the amount of time it takes to regenerate the specified player charge link.

Remove Charge Used For Player

• Clears the number of used charges for the specified player charge link.

Remove Cooldown For Player

• Clears the specified player cooldown link.

Difficulty Levels

APM Of Difficulty Level

• Returns the actions per minute for the difficulty level specified.

Difficulty Level Is Enabled

• Returns true if the difficulty level is enabled.

Name Of Difficulty Level

• Returns the name of the difficulty level.

Name Of Campaign Difficulty Level

• Returns the campaign name of the difficulty level.

Difficulty Level For Player

• Returns the difficulty level for the specified player.

Set Player Difficulty Level

• Sets the difficulty level for the specified player.

Player Settings

Triggering Player

• Returns the triggering player as an integer.

Triggering Player Property

• Returns the triggering player property in response to "Player Property Changed" events.

Triggering Player Property Change (Real)

• Returns the triggering player property amount changed in response to "Player Property Changed" events.

Triggering Player Property Change (Integer)

• Returns the triggering player property amount changed in response to "Player Property Changed" events.

Player Color

• Returns the player color of the player.

Player Property

• Returns the value of the specified player property as an integer.

Player Flag Check

• Returns true if the specified flag is enabled.

Modify Player Property

• Modifies player properties such as resources.

Name Of Player

• Returns the name of the player.

Race Of Player

• Returns the race of the player.

Player Score Value (Real)

• Returns a statistic for the specified player as a real.

Player Score Value (Integer)

• Returns a statistic for the specified player as an integer.

Modify Player Score (Real)

• Modifies player properties such as resources.

Modify Player Score (Integer)

• Modifies player score such as units killed.

Set Player Color

• Sets the player color for the player.

Turn Player Flag On/Off

• Enables or disables the specified flag for the player.

Start Location Of Player

• Returns the point value of the start location for the player.

Status Of Player

• Returns the status of the player.

Controller Of Player

• Returns the controller of the specified player. This function can return as Computer, User, None, or Neutral.