aom.scripting.xs.tr

Class Player

Object

Player

public class Player
extends Object

This class provides a collection of Trigger commands concerning Players.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
int	trCurrentPlayer() Returns the current player
bool	trPlayerActive(int playerID) Returns true if the player is active.
bool	trPlayerAtPopCap(int playerID) Returns true if player is at pop cap.
int	trPlayerBuildingCount(int playerID) Returns the number of buildings for the player.
bool	trPlayerCountBuildingInProgress(int playerID, string protoName) Returns true if building is being built.
bool	trPlayerDefeated(int playerID) Returns true if the player has been defeated.
string	trPlayerGetDiplomacy(int playerID, int player2ID) Gets the diplomacy status between players.
int	trPlayerGetPopulation(int playerID) Returns the player population.
void	trPlayerGrantResources(int playerID, string resource, int amount) Grants the given amount a resource to the given player.
void	trPlayerKillAllBuildings(int playerID) Kills all of the buildings of a given player.
void	trPlayerKillAllGodPowers(int playerID) Kills all of the current God Powers of a player.
void	trPlayerKillAllUnits(int playerID) Kills all of the units of a given player.
void	trPlayerModifiedLOS(int playerID, bool canSee, int player2ID) Adds/removes LOS between players.
void	trPlayerResetBlackMap(int playerID) Resets the black map for a given human player.
void	trPlayerResetBlackMapForAllPlayers() Resets the black map for all human players
int	trPlayerResourceCount(int playerID, string resource) Returns the number of resources for the player.
void	trPlayerSetActive(int playerID) Sets the active player.
void	trPlayerSetDiplomacy(int playerID, int player2ID, string status) Sets the diplomacy status between players
void	trPlayerTechTreeEnabledGodPowers(int playerID, bool on) Enables/disables the technology tree from granting God Powers to a player.
void	trPlayerTribute(int fromID, string resource, int amount, int toID) Tributes resources to a player.
int	trPlayerUnitAndBuildingCount(int playerID) Returns the number of units and buildings for the player.
int	trPlayerUnitCount(int playerID) Returns the number of units for the player.
int	trPlayerUnitCountSpecific(int playerID, string protoName) Returns the number of proto units for the player.
void	trSetCurrentPlayerStatus(bool active) Sets the current player as active or inactive
void	trSetPlayerDefeated() When called, the player is set to defeated on the local machine.
void	trSetPlayerWon(int playerID) When called, the player is set to be victorious on the local machine.
void	trYouLose(string text) Player loses, specifies message.
void	trYouWin(string nextscenario, string text) Player wins, specifies next scenario to go to and message.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

trPlayerActive

public bool trPlayerActive(int playerID)

Returns true if the player is active.

trPlayerAtPopCap

public bool trPlayerAtPopCap(int playerID)

Returns true if player is at pop cap.

trPlayerBuildingCount

public int trPlayerBuildingCount(int playerID)

Returns the number of buildings for the player.

trPlayerCountBuildingInProgress

public bool trPlayerCountBuildingInProgress(int playerID,
                                            string protoName)

Returns true if building is being built.

trPlayerDefeated

public bool trPlayerDefeated(int playerID)

Returns true if the player has been defeated.

trPlayerGetDiplomacy

public string trPlayerGetDiplomacy(int playerID,
                                   int player2ID)

Gets the diplomacy status between players.

trPlayerGetPopulation

public int trPlayerGetPopulation(int playerID)

Returns the player population.

trPlayerGrantResources

public void trPlayerGrantResources(int playerID,
                                   string resource,
                                   int amount)

Grants the given amount a resource to the given player.

trPlayerKillAllBuildings

public void trPlayerKillAllBuildings(int playerID)

Kills all of the buildings of a given player.

trPlayerKillAllGodPowers

public void trPlayerKillAllGodPowers(int playerID)

Kills all of the current God Powers of a player.

trPlayerKillAllUnits

public void trPlayerKillAllUnits(int playerID)

Kills all of the units of a given player.

trPlayerModifiedLOS

public void trPlayerModifiedLOS(int playerID,
                                bool canSee,
                                int player2ID)

Adds/removes LOS between players.

trPlayerResetBlackMap

public void trPlayerResetBlackMap(int playerID)

Resets the black map for a given human player.

trPlayerResetBlackMapForAllPlayers

public void trPlayerResetBlackMapForAllPlayers()

Resets the black map for all human players

trPlayerResourceCount

public int trPlayerResourceCount(int playerID,
                                 string resource)

Returns the number of resources for the player.

trPlayerSetActive

public void trPlayerSetActive(int playerID)

Sets the active player.

See Also:

xsGetContextPlayer(), xsSetContextPlayer(int), trCurrentPlayer()

trCurrentPlayer

public int trCurrentPlayer()

Returns the current player

trPlayerSetDiplomacy

public void trPlayerSetDiplomacy(int playerID,
                                 int player2ID,
                                 string status)

Sets the diplomacy status between players

trPlayerTechTreeEnabledGodPowers

public void trPlayerTechTreeEnabledGodPowers(int playerID,
                                             bool on)

Enables/disables the technology tree from granting God Powers to a player.

trPlayerTribute

public void trPlayerTribute(int fromID,
                            string resource,
                            int amount,
                            int toID)

Tributes resources to a player.

trPlayerUnitAndBuildingCount

public int trPlayerUnitAndBuildingCount(int playerID)

Returns the number of units and buildings for the player.

trPlayerUnitCount

public int trPlayerUnitCount(int playerID)

Returns the number of units for the player.

trPlayerUnitCountSpecific

public int trPlayerUnitCountSpecific(int playerID,
                                     string protoName)

Returns the number of proto units for the player.

trSetPlayerDefeated

public void trSetPlayerDefeated()

When called, the player is set to defeated on the local machine.

Local Call

trSetPlayerWon

public void trSetPlayerWon(int playerID)

When called, the player is set to be victorious on the local machine.

Local Call

trSetCurrentPlayerStatus

public void trSetCurrentPlayerStatus(bool active)

Sets the current player as active or inactive

trYouLose

public void trYouLose(string text)

Player loses, specifies message.

trYouWin

public void trYouWin(string nextscenario,
                     string text)

Player wins, specifies next scenario to go to and message.