aom.scripting.xs.rm

Class FairLoc

Object

FairLoc

public class FairLoc
extends Object

This class provides a collection of RM commands concerning Fair Locations.

These special commands are designed to place critical resources, such as Settlements and sometimes Gold Mines. They are expensive and slow, so should not be used for many objects, but can insure that objects that "must place" are present on a map.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
int	rmAddFairLoc(string unitName, bool forward, bool inside, float minPlayerDist, float maxPlayerDist, float locDist, float edgeDist, bool playerArea, bool teamArea) Adds some fairLoc placement info.
bool	rmAddFairLocConstraint(int fairLocID, int constraintID) Add specified constraint to a fairLoc placement.
float	rmFairLocXFraction(int playerID, int index) Gets a player's fairLoc x fraction.
float	rmFairLocZFraction(int playerID, int index) Gets a player's fairLoc z fraction.
int	rmGetNumberFairLocs(int playerID) Gets a player's number of fairLocs.
bool	rmPlaceFairLocs() Places down a fairLoc and returns whether or not it was succesful.
void	rmResetFairLocs() Resets fairLoc placement info.

Methods inherited from class Object

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

Method Detail

rmAddFairLoc

public int rmAddFairLoc(string unitName,
                        bool forward,
                        bool inside,
                        float minPlayerDist,
                        float maxPlayerDist,
                        float locDist,
                        float edgeDist,
                        bool playerArea,
                        bool teamArea)

Adds some fairLoc placement info.

rmAddFairLocConstraint

public bool rmAddFairLocConstraint(int fairLocID,
                                   int constraintID)

Add specified constraint to a fairLoc placement.

rmFairLocXFraction

public float rmFairLocXFraction(int playerID,
                                int index)

Gets a player's fairLoc x fraction.

rmFairLocZFraction

public float rmFairLocZFraction(int playerID,
                                int index)

Gets a player's fairLoc z fraction.

rmGetNumberFairLocs

public int rmGetNumberFairLocs(int playerID)

Gets a player's number of fairLocs.

rmPlaceFairLocs

public bool rmPlaceFairLocs()

Places down a fairLoc and returns whether or not it was succesful.

rmResetFairLocs

public void rmResetFairLocs()

Resets fairLoc placement info.