aom.scripting.xs.rm

Class Player

Object

Player

public class Player
extends Object

This class provides a collection of RM commands concerning Players.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
void	rmAddPlayerResource(int playerID, string resourceName, float amount) Adds to a player's resource amount.
int	rmGetNumberPlayersOnTeam(int teamID) Gets the number of players on the given team
int	rmGetPlayerCiv(int playerID) Gets the civilization of the specified player.
int	rmGetPlayerCulture(int playerID) Gets the culture of the specified player.
string	rmGetPlayerName(int playerID) Gets a player's nickname.
int	rmGetPlayerTeam(int playerID) Gets the team the specified player is on.
void	rmMultiplyPlayerResource(int playerID, string resourceName, float factor) Multiplies a player's resource amount by the given factor.
void	rmPlacePlayer(int playerID, float xFraction, float zFraction) Sets one player location.
void	rmPlacePlayersCircular(float minFraction, float maxFraction, float angleVariation) Makes a circle of player locations.
void	rmPlacePlayersLine(float x1, float z1, float x2, float z2, float distVariation, float spacingVariation) Makes a line of player locations.
void	rmPlacePlayersSquare(float dist, float distVariation, float spacingVariationfloat) Makes a square of player locations.
void	rmPlayerLocXFraction(int playerID) Gets a player's start location x fraction.
void	rmPlayerLocZFraction(int playerID) Gets a player's start location z fraction.
void	rmSetPlacementSection(float fromPercent, float toPercent) When placing players in a circle or square, this command allows you to skip part of the circle or square, in essence removing a slice from the pie (maybe you want to fit an ocean in there like in Sea of Worms).
void	rmSetPlacementTeam(int teamID) Sets the team to place.
void	rmSetPlayerArea(int playerID, int areaID) Sets a player's 'official' area.
void	rmSetPlayerLocation(int playerID, float xFraction, float zFraction) Manually sets a player's starting location.
void	rmSetPlayerPlacementArea(float minX, float minZ, float maxX, float maxZ) Sets the area of the map to use for player placement.
void	rmSetPlayerResource(int playerID, string resourceName, float amount) Sets a player's resource amount.
void	rmSetTeamArea(int teamID, int areaID) Sets a team's 'official' area.
void	rmSetTeamSpacingModifier(float modifier) Sets the team spacing modifier.

Methods inherited from class Object

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

Method Detail

rmAddPlayerResource

public void rmAddPlayerResource(int playerID,
                                string resourceName,
                                float amount)

Adds to a player's resource amount.

Parameters:

resourceName -

• "food"
• "wood"
• "gold"
• "favor"

rmGetNumberPlayersOnTeam

public int rmGetNumberPlayersOnTeam(int teamID)

Gets the number of players on the given team

rmGetPlayerCiv

public int rmGetPlayerCiv(int playerID)

Gets the civilization of the specified player.

See Also:

ArtificialIntelligence.cCivZeus, ArtificialIntelligence.cCivHades, ArtificialIntelligence.cCivPoseidon, ArtificialIntelligence.cCivIsis, ArtificialIntelligence.cCivRa, ArtificialIntelligence.cCivSet, ArtificialIntelligence.cCivLoki, ArtificialIntelligence.cCivThor, ArtificialIntelligence.cCivOdin, ArtificialIntelligence.cCivGaia, ArtificialIntelligence.cCivKronos, ArtificialIntelligence.cCivOuranos, ArtificialIntelligence.cCivGreek, ArtificialIntelligence.cCivNorse, ArtificialIntelligence.cCivEgyptian, ArtificialIntelligence.cCivAtlantean, ArtificialIntelligence.cCivRandom, ArtificialIntelligence.cCivNature

rmGetPlayerCulture

public int rmGetPlayerCulture(int playerID)

Gets the culture of the specified player.

See Also:

ArtificialIntelligence.cCultureGreek, ArtificialIntelligence.cCultureEgyptian, ArtificialIntelligence.cCultureNorse, ArtificialIntelligence.cCultureAtlantean, ArtificialIntelligence.cCultureNature

rmGetPlayerName

public string rmGetPlayerName(int playerID)

Gets a player's nickname.

rmGetPlayerTeam

public int rmGetPlayerTeam(int playerID)

Gets the team the specified player is on.

rmPlacePlayer

public void rmPlacePlayer(int playerID,
                          float xFraction,
                          float zFraction)

Sets one player location. You can use this to place players anywhere. Once a player is placed, it won't be repositioned by any future calls to the various rmPlacePlayers functions.

rmPlacePlayersCircular

public void rmPlacePlayersCircular(float minFraction,
                                   float maxFraction,
                                   float angleVariation)

Makes a circle of player locations. Places players in a circle. Variation is determined by the difference between the min and max. Angle variation determines whether players are equidistant or can be slightly closer or farther apart.

rmPlacePlayersLine

public void rmPlacePlayersLine(float x1,
                               float z1,
                               float x2,
                               float z2,
                               float distVariation,
                               float spacingVariation)

Makes a line of player locations. Sometimes you will want players to be placed in a line. Anatolia places each team on a line, while Vinlandsaga places all players in a line. Using a line placement is not easy because there may not be enough room for player areas or resources. X and Z determine the starting and ending locations of the line. DistVariation determines how far from the line player areas can vary, and spacingVariation determines how much space there is among points along the line where players are placed.

rmPlacePlayersSquare

public void rmPlacePlayersSquare(float dist,
                                 float distVariation,
                                 float spacingVariationfloat)

Makes a square of player locations. Places players in a square, which automatically adjusts to a rectangle for rectangular maps. Unlike the circle, variance here is determined by a plus or minus (the distVariation) off of the mean distance. SpacingVariation determines whether players are equidistant or can be slightly closer or farther apart.

rmPlayerLocXFraction

public void rmPlayerLocXFraction(int playerID)

Gets a player's start location x fraction.

rmPlayerLocZFraction

public void rmPlayerLocZFraction(int playerID)

Gets a player's start location z fraction.

rmSetPlacementSection

public void rmSetPlacementSection(float fromPercent,
                                  float toPercent)

When placing players in a circle or square, this command allows you to skip part of the circle or square, in essence removing a slice from the pie (maybe you want to fit an ocean in there like in Sea of Worms). The default for fromPercent is 0, and the default for toPercent is 1. That means use the whole circle or square. You can pass in something like 0.25 and 0.50 to have the players placed from 25% in to 50% in along the circle or square. For circular placement, 0 is at 9h00, 0.25 is at 12h00, 0.5 is at 3h00, and 0.75 is at 6h00. For square placement (think of the square as a line that follows a square), 0 is at 6h00, 0.25 is at 9h00, 0.5 is at 12h00, and 0.75 is at 3h00.

rmSetPlacementTeam

public void rmSetPlacementTeam(int teamID)

Sets the team to place. Use this before calling the various rmPlacePlayers functions, and only players on the specified team will get placed. Remember: the first teamID is 0, the second is 1, etc. Pass in -1 for the teamID to place all teams (or actually all players that haven't been placed yet).

rmSetPlayerArea

public void rmSetPlayerArea(int playerID,
                            int areaID)

Sets a player's 'official' area.

rmSetPlayerLocation

public void rmSetPlayerLocation(int playerID,
                                float xFraction,
                                float zFraction)

Manually sets a player's starting location.

rmSetPlayerPlacementArea

public void rmSetPlayerPlacementArea(float minX,
                                     float minZ,
                                     float maxX,
                                     float maxZ)

Sets the area of the map to use for player placement. Use this command if, for example, you want to place players in one quadrant of a map.

rmSetPlayerResource

public void rmSetPlayerResource(int playerID,
                                string resourceName,
                                float amount)

Sets a player's resource amount.

Parameters:

resourceName -

• "food"
• "wood"
• "gold"
• "favor"

rmSetTeamArea

public void rmSetTeamArea(int teamID,
                          int areaID)

Sets a team's 'official' area.

rmSetTeamSpacingModifier

public void rmSetTeamSpacingModifier(float modifier)

Sets the team spacing modifier. Normally, all players are placed equidistant. This command allows you to force team members closer together. Values of 0.3-0.5 return the best results. Values less than 0.25 may not provide enough space for starting resources.

rmMultiplyPlayerResource

public void rmMultiplyPlayerResource(int playerID,
                                     string resourceName,
                                     float factor)

Multiplies a player's resource amount by the given factor.

Parameters:

resourceName -

• "food"
• "wood"
• "gold"
• "favor"