TriggerLoader

Object
- TriggerLoader

```
public abstract class TriggerLoader
extends Object
```
The purpose of this loader is to make the life of AoM trigger scripters easier. Just ask the users to include this load trigger in their scenario. This allows you to call any function and constant in this file from within any future trigger code.

Other than the basic functions, we have also provided a trigger framework for some of the new assets. Expect this framework to expand with every next release.

We accept trigger codes from everyone who is willing to offer them. Of course the authors get full credit for their work. Also additional ideas are welcome, so we can try to work them out for you.
So far it includes:
- Useful constants from the AI file (not all), and some others like PI and E.
- The cMyID, cMyCiv, cMyCulture, cNumberNonGaiaPlayers and cGameMode variables.
- String Manipulation
- Array system
- Default QVs
- Vector QVs
- String QVs
- Army QVs
- Quest Arrays
- Math Functions
- UI Functions
- Miscellaneous Functions
Version:

2.02 (for AoM)

Change log:
v2.02: (14/02/2010) Minor bug fix in xsArraySet.
v2.01: (05/09/2009) Minor bug fix in Math_atan.
v2.00: (06/08/2008) Major update: lots of bug fixes, added array functionality and a trigger framework.
v1.02: (22/05/2008) Took out xsRestoreContextPlayer() to avoid confusion, and added some more functions.
v1.01: (17/05/2008) Added a few extra functions and generated API.
v1.00: (16/05/2008) Initial release.

Author:

Mythic_Freak & invent00r

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`cGameMode` The current game mode, possible options: cGameModeSupremacy cGameModeConquest cGameModeLightning cGameModeDeathmatch
`static int`	`cMyCiv` The civilisation ID, can be: cCivZeus cCivHades cCivPoseidon cCivIsis cCivRa cCivSet cCivLoki cCivThor cCivOdin cCivGreek cCivNorse cCivEgyptian cCivRandom cCivNature
`static int`	`cMyCulture` The culture ID, can be: cCultureGreek cCultureEgyptian cCultureNorse cCultureNature
`static int`	`cMyID` The current player number.
`static int`	`cNumberNonGaiaPlayers` The total number of players in a game, mother nature excluded.
`static double`	`e` The `double` value that is closer than any other to e, the base of the natural logarithms known as Euler's number.
`static double`	`PI` The `double` value that is closer than any other to pi, the ratio of the circumference of a circle to its diameter.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clickAtPoint(vector point)` Forces the camera to the given point with zoomToPoint, and issues a left mouse click command.
`static void`	`controlDoubleClickAtPoint(vector point)` Forces the camera to the given point with zoomToPoint, and issues a left mouse control-double-click command.
`static void`	`controlShiftDoubleClickAtPoint(vector point)` Forces the camera to the given point with zoomToPoint, and issues a left mouse control-shift-double-click command.
`static void`	`doubleClickAtPoint(vector point)` Forces the camera to the given point with zoomToPoint, and issues a left mouse double-click command.
`static void`	`enterEditorMode()` Switches the current mode to editor mode.
`static string`	`getTime()` Returns a time string formatted as hh:mm:ss or mm:ss if the game does not last an hour yet.
`static int`	`getUnit(int unitType, int action, vector center)` Returns the ID of a unit matching the following criteria:
`static bool`	`kbIsMultiplayer()` Checks if the current game is played in singleplayer or multiplayer mode.
`static int`	`kbUnitCostPerResource(int protoUnitID, int resourceID)` Returns the default cost of a unit with given protounit and resource.
`static int`	`kbUnitQueryCreate2(string qname, int unitType, int action, int statea, int playera, vector center, bool sort, float radiusa)` Creates and executes a unit query with the following results and returns the query ID.
`static void`	`leaveEditorMode()` Leaves the editor mode and returns to the actual game.
`static void`	`loadCameraOnline(string filename)` Load a camera position from a given file.
`static float`	`Math_abs(float a)` Returns the absolute value of the first argument.
`static float`	`Math_approx(float a, float approx)` Returns an approximation of the given value to a certain accuracy.
`static float`	`Math_atan(float n)` Returns the arc tangent of a value; the returned angle is in the range -PI/2 through PI/2.
`static float`	`Math_atan2(float z, float x)` Returns the angle theta from the conversion of rectangular coordinates (`x`, `y`) to polar coordinates (r, theta).
`static int`	`Math_boolToInt(bool a)` Converts a bool into an integer.
`static float`	`Math_cbrt(float s)` Returns the cubic root of a given value
`static int`	`Math_ceil(float a)` Returns the smallest (closest to negative infinity) int value that is greater than or equal to the argument and is equal to a mathematical integer.
`static float`	`Math_cos(float n)` Returns the trigonometric cosine of an angle.
`static float`	`Math_cosec(float n)` Returns the trigonometric cosecant of an angle.
`static float`	`Math_cosech(float n)` Returns the trigonometric cosecant hyperbolic of an angle.
`static float`	`Math_cosh(float n)` Returns the trigonometric cosine hyperbolic of an angle.
`static float`	`Math_cotan(float n)` Returns the trigonometric cotangent of an angle.
`static float`	`Math_cotanh(float n)` Returns the trigonometric cotangent hyperbolic of an angle.
`static float`	`Math_degreeToRadian(float degree)` Converts a degree into a radian.
`static float`	`Math_dist(vector a, vector b)` Returns the distance between 2 points in a 3D location.
`static float`	`Math_exp(float a)` Returns Euler's number e raised to the power of a `float` value.
`static float`	`Math_fact(int n)` Returns the factorial of the given param.
`static int`	`Math_floatToInt(float a)` Converts a float into an int.
`static int`	`Math_floor(float a)` Returns the largest (closest to positive infinity) int value that is less than or equal to the argument and is equal to a mathematical integer.
`static int`	`Math_gcd(int a, int b)` Returns the greatest common divisor of 2 values.
`static vector`	`Math_GetVectorial(vector a, vector b, float distance)` Unfortunately invent00r forgot what this is for, but he'll try to explain in version 3.
`static vector`	`Math_GetVectorialVector(vector a, vector b, float y)` Unfortunately invent00r forgot what this is for, but he'll try to explain in version 3.
`static bool`	`Math_intToBool(int a)` Converts an int value into a bool.
`static float`	`Math_intToFloat(int a)` Converts an int to a float.
`static int`	`Math_lcm(int a, int b)` Returns the least common multiple of 2 values.
`static float`	`Math_ln(float a, int acc)` Returns the natural logarithm (base e) of a `float` value.
`static float`	`Math_log(float base, float resa, int acc)` Returns the logarithm with given base of a `float` value.
`static float`	`Math_log10(float resa, int acc)` Returns the logarithm with base 10 of a `float` value.
`static float`	`Math_log2(float resa, int acc)` Returns the logarithm with base 2 of a `float` value.
`static float`	`Math_max(float a, float b)` Returns the highest of 2 params.
`static float`	`Math_min(float a, float b)` Returns the lowest value of 2 params.
`static float`	`Math_mod(float a, float b)` Returns the rest after division of 2 numbers.
`static bool`	`Math_pointIsInRectangle(vector topLeft, vector bottomRight, vector point)` Decides whether or not a point in 2D space is part of a rectangle.
`static float`	`Math_pow(float n, int x)` Returns the value of the first argument raised to the power of the second argument.
`static vector`	`Math_QF(float a, float b, float c)` Solves the quadratic formula to solve a quadratic equation.
`static float`	`Math_radianToDegree(float radian)` Converts a radian into a degree.
`static float`	`Math_rand()` Returns a `float` value with a positive sign, greater than or equal to `0.0` and less than `1.0`.
`static int`	`Math_round(float a)` Returns the closest int near the given float.
`static float`	`Math_sec(float n)` Returns the trigonometric secant of an angle.
`static float`	`Math_sech(float n)` Returns the trigonometric secant hyperbolic of an angle.
`static int`	`Math_sign(float a)` Returns the signum function of the argument; zero if the argument is zero, 1 if the argument is greater than zero, -1 if the argument is less than zero.
`static float`	`Math_sin(float n)` Returns the trigonometric sine of an angle.
`static float`	`Math_sinh(float n)` Returns the trigonometric sine hyperbolic of an angle.
`static float`	`Math_sqrt(float s)` Returns the square root of a given value.
`static float`	`Math_tan(float n)` Returns the trigonometric tangent of an angle.
`static float`	`Math_tanh(float n)` Returns the trigonometric tangent hyperbolic of an angle.
`static void`	`print(string text)` Outputs a piece of text to the game.
`static void`	`rightClickAtPoint(vector point)` Forces the camera to the given point with zoomToPoint, and issues a right mouse click command.
`static void`	`saveCameraOnline(string filename)` Saves the current camera position (in-game, not in the editor) to a given file.
`static void`	`shiftClickAtPoint(vector point)` Forces the camera to the given point with zoomToPoint, and issues a left mouse shift-click command.
`static void`	`shiftDoubleClickAtPoint(vector point)` Forces the camera to the given point with zoomToPoint, and issues a left mouse shift-double-click command.
`static string`	`String_charAt(string sText, int pos)` Returns a character from a given string at the given position.
`static int`	`String_length(string sText)` Returns the length of a given string.
`static float`	`String_parseFloat(string sText)` Converts a String that only holds a float into a real floating point number.
`static string`	`String_substr(string sText, int startPos, int endPos)` Returns a substring of a given string from the given start position to the end position.
`static string`	`String_toLowerCase(string sText)` Converts the input string to lower case [a-z].
`static string`	`String_toString(float a)` Converts a floating point number to a string.
`static string`	`String_toUpperCase(string sText)` Converts the input string to upper case [A-Z].
`static int`	`trGetUnitOwner(string unitName)` Returns the current owner of the unit.
`static int`	`trGetUnitOwnerByID(int unitID)` Returns the current owner of the unit.
`static void`	`trQuestVarArmyEcho(string QVAname)` Echoes the army QV to the output.
`static string`	`trQuestVarArmyGet(string QVAname)` Returns the army assigned to the given army QV.
`static int`	`trQuestVarArmyGetID(string QVAname)` Returns the army ID of the given army QV.
`static int`	`trQuestVarArmyGetPlayerID(string QVAname)` Returns the player ID of the given army QV.
`static void`	`trQuestVarArmySet(string QVAname, vector army)` Assigns an army to the given army QV.
`static void`	`trQuestVarCopy(string QVname, string QVname2)` Copies the value of 1 QV into another.
`static void`	`trQuestVarEcho(string QVname)` Echoes the value of the given QV to the system.
`static float`	`trQuestVarGet(string QVname)` Returns the float value assigned to this QV.
`static void`	`trQuestVarSet(string QVname, float QVvalue)` Assigns a float value to the given QV.
`static void`	`trQuestVarSetFromRand(string QVname, float min, float max, bool Round)` Sets a given QV to a random value in the [min,max] interval.
`static void`	`trRunEditorConsoleCommand(string cmd)` Executes a console command that can only run in editor mode.
`static void`	`trStringQuestVarEcho(string SQVname)` Echoes the SQV to the output.
`static string`	`trStringQuestVarGet(string SQVname)` Returns the string assigned to the given string QV.
`static void`	`trStringQuestVarSet(string SQVname, string SQVvalue)` Assigns a string to a given string QV.
`static void`	`trVectorQuestVarEcho(string VQVname)` Echoes the VQV to the output.
`static vector`	`trVectorQuestVarGet(string VQVname)` Returns the vector assigned to the given VQV.
`static float`	`trVectorQuestVarGetX(string VQVname)` Returns the X component of the given VQV.
`static float`	`trVectorQuestVarGetY(string VQVname)` Returns the Y component of the given VQV.
`static float`	`trVectorQuestVarGetZ(string VQVname)` Returns the Z component of the given VQV.
`static void`	`trVectorQuestVarSet(string VQVname, vector QVv)` Assigns a vector(X,Y,Z) to a VQV.
`static void`	`uiRandomLightning()` Sets the lightning completely random.
`static void`	`uiResetCamera()` Resets the camera to its default position.
`static void`	`uiSelectIdleType(string type)` Selects an idle unit of the given type, but does not focus on it.
`static void`	`uiSelectType(string type)` Selects a unit of the given type, but does not focus on it.
`static void`	`uiSelectUnit(int playerID, string unitName)` UI selects the unit, i.e.
`static void`	`uiSelectUnitByID(int playerID, int unitID)` UI selects the unit, i.e.
`static void`	`uiTrainUnit(string protoUnit, string buildingUnitName, bool repeat, int playerID)` Trains a unit using the UI commands.
`static int`	`xsArrayCreate(string ArrayName, int dimX, int dimY, float defaultvalue)` Creates a new array of float values, with given dimensions and default value.
`static bool`	`xsArrayDelete(int Aid, int posX)` Deletes an X-column from the array.
`static void`	`xsArrayEcho(string AName, int posX, int posY)` Echoes a value in the array to the output.
`static void`	`xsArrayEchoAll(string AName)` Echoes all values in the array to the output, in a linear manner.
`static void`	`xsArrayEchoAll2(string AName)` Echoes all values in the array to the output, in a matrix formation.
`static bool`	`xsArrayEqual(string AName1, string AName2)` Returns true if both arrays have the same content.
`static bool`	`xsArrayFill(int Aid, float defaultvalue, float replaceVal)` Fills the given array with a given value.
`static bool`	`xsArrayFillByName(string ArrayName, float defaultvalue, float replaceVal)` Fills the given array with a given value.
`static int`	`xsArrayFind(int Aid, int posY, int nFind)` Tries to find a value in a given row of the provided array.
`static float`	`xsArrayGet(int Aid, int posX, int posY)` Gets a value from the given array.
`static float`	`xsArrayGetByName(string ArrayName, int posX, int posY)` Gets a value from the given array.
`static float`	`xsArrayGetDefaultValue(int Aid)` Returns the default value of the given array.
`static int`	`xsArrayGetID(string ArrayName)` Converts an array name to an array ID.
`static vector`	`xsArrayGetSize(int Aid)` Returns the size of the array.
`static vector`	`xsArrayGetSizeByName(string ArrayName)` Returns the size of the array.
`static int`	`xsArrayGetSizeX(int Aid)` Returns the X-size of the given array.
`static int`	`xsArrayGetSizeXByName(string ArrayName)` Returns the X-size of the given array.
`static int`	`xsArrayGetSizeY(int Aid)` Returns the Y-size of the given array.
`static int`	`xsArrayGetSizeYByName(string ArrayName)` Returns the Y-size of the given array.
`static bool`	`xsArrayResize(int Aid, int newSizeX, int newSizeY)` Resizes the given array, filling new spots with the default value.
`static bool`	`xsArraySet(int Aid, float value, int posX, int posY)` Sets a value of the array.
`static bool`	`xsArraySetByName(string ArrayName, float value, int posX, int posY)` Sets a value of the array.
`static bool`	`xsArraySetDefaultValue(int Aid, float defaultvalue)` Sets the default value of the given array.
`static bool`	`xsArraySort(int Aid, int posY, bool Descending)` Sort a given row of the array, in chosen order.
`static bool`	`xsArraySwap(int Aid, int lineA, int lineB)` Swaps 2 columns in the given array.
`static bool`	`xsArraySwapByName(string ArrayName, int lineA, int lineB)` Swaps 2 columns in the given array.
`static void`	`xsRestoreContextPlayer()` Restores the previously saved context player.
`static void`	`xsSaveAndSetContextPlayer(int playerID)` Sets a new context player, and saves the previous one.
`static void`	`zoomToPoint(vector point)` Forced the camera to look straight down to 1 point.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PI
```
public static final double PI
```
    The double value that is closer than any other to pi, the ratio of the circumference of a circle to its diameter.
    
    See Also:
    
    Constant Field Values
  - e
```
public static final double e
```
    The double value that is closer than any other to e, the base of the natural logarithms known as Euler's number.
    
    See Also:
    
    Constant Field Values
  - cMyID
```
public static final int cMyID
```
    The current player number. Does not change by xsSetContextPlayer().
  - cNumberNonGaiaPlayers
```
public static final int cNumberNonGaiaPlayers
```
    The total number of players in a game, mother nature excluded.
  - cMyCulture
```
public static final int cMyCulture
```
    The culture ID, can be:
    - cCultureGreek
    - cCultureEgyptian
    - cCultureNorse
    - cCultureNature
  - cMyCiv
```
public static final int cMyCiv
```
    The civilisation ID, can be:
    - cCivZeus
    - cCivHades
    - cCivPoseidon
    - cCivIsis
    - cCivRa
    - cCivSet
    - cCivLoki
    - cCivThor
    - cCivOdin
    - cCivGreek
    - cCivNorse
    - cCivEgyptian
    - cCivRandom
    - cCivNature
  - cGameMode
```
public static final int cGameMode
```
    The current game mode, possible options:
    - cGameModeSupremacy
    - cGameModeConquest
    - cGameModeLightning
    - cGameModeDeathmatch
    Note
    
    Scenarios will always return cGameModeSupremacy.
- Method Detail
  - String_substr
```
public static string String_substr(string sText,
                                   int startPos,
                                   int endPos)
```
    Returns a substring of a given string from the given start position to the end position.
    
    Parameters:
    
    sText - the input string
    
    startPos - the position to start at
    
    endPos - the position to end
    
    Since:
    
    1.00
    
    Returns:
    
    the new substring
    Author:
    invent00r
  - String_length
```
public static int String_length(string sText)
```
    Returns the length of a given string.
    
    Parameters:
    
    sText - the input string
    
    Since:
    
    1.00
    
    Returns:
    
    the length of the given string
    Author:
    invent00r
  - String_charAt
```
public static string String_charAt(string sText,
                                   int pos)
```
    Returns a character from a given string at the given position.
    
    Parameters:
    
    sText - the input string
    
    pos - the position of the wanted char
    
    Since:
    
    1.00
    
    Returns:
    
    the char at position (pos)
    Author:
    invent00r
  - String_toUpperCase
```
public static string String_toUpperCase(string sText)
```
    Converts the input string to upper case [A-Z].
    
    Parameters:
    
    sText - the input string
    
    Since:
    
    1.00
    
    Returns:
    
    The upper case string
    Author:
    invent00r
  - String_toLowerCase
```
public static string String_toLowerCase(string sText)
```
    Converts the input string to lower case [a-z].
    
    Parameters:
    
    sText - the input string
    
    Since:
    
    1.00
    
    Returns:
    
    the lower case string
    Author:
    invent00r
  - String_parseFloat
```
public static float String_parseFloat(string sText)
```
    Converts a String that only holds a float into a real floating point number.
    
    Parameters:
    
    sText - the input string
    
    Since:
    
    1.00
    
    Returns:
    
    the float that was parsed from the string
    Author:
    invent00r
  - String_toString
```
public static string String_toString(float a)
```
    Converts a floating point number to a string.
    
    Parameters:
    
    a - the input float
    
    Since:
    
    1.00
    
    Returns:
    
    the string that was created from the float
    Author:
    invent00r
  - Math_mod
```
public static float Math_mod(float a,
                             float b)
```
    Returns the rest after division of 2 numbers.
    
    Parameters:
    
    a - The input number.
    
    b - The modulus.
    
    Since:
    
    1.00
    
    Returns:
    
    a % b
    Author:
    Mythic_Freak
  - Math_floor
```
public static int Math_floor(float a)
```
    Returns the largest (closest to positive infinity) int value that is less than or equal to the argument and is equal to a mathematical integer.
    
    Parameters:
    
    a - The input number.
    
    Since:
    
    1.00
    
    Returns:
    
    Returns the largest (closest to positive infinity) int value that is less than or equal to the argument and is equal to a mathematical integer.
    Author:
    Mythic_Freak
  - Math_ceil
```
public static int Math_ceil(float a)
```
    Returns the smallest (closest to negative infinity) int value that is greater than or equal to the argument and is equal to a mathematical integer.
    
    Parameters:
    
    a - The input number.
    
    Since:
    
    1.00
    
    Returns:
    
    Returns the smallest (closest to negative infinity) int value that is greater than or equal to the argument and is equal to a mathematical integer.
    Author:
    Mythic_Freak
  - Math_radianToDegree
```
public static float Math_radianToDegree(float radian)
```
    Converts a radian into a degree.
    
    Parameters:
    
    radian - The angle in radians.
    
    Since:
    
    1.00
    
    Returns:
    
    The angle in degrees.
    Author:
    Mythic_Freak
  - Math_degreeToRadian
```
public static float Math_degreeToRadian(float degree)
```
    Converts a degree into a radian.
    
    Parameters:
    
    degree - The angle in degrees.
    
    Since:
    
    1.00
    
    Returns:
    
    The angle in radians.
    Author:
    Mythic_Freak
  - Math_intToBool
```
public static bool Math_intToBool(int a)
```
    Converts an int value into a bool.
    
    Parameters:
    
    a - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    false if a is 0, true otherwise
    Author:
    Mythic_Freak
  - Math_boolToInt
```
public static int Math_boolToInt(bool a)
```
    Converts a bool into an integer.
    
    Parameters:
    
    a - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    1 if a is true, 0 otherwise
    Author:
    Mythic_Freak
  - Math_intToFloat
```
public static float Math_intToFloat(int a)
```
    Converts an int to a float.
    
    Parameters:
    
    a - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the new float
    Author:
    Mythic_Freak
  - Math_floatToInt
```
public static int Math_floatToInt(float a)
```
    Converts a float into an int.
    
    Parameters:
    
    a - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the new int
    Author:
    Mythic_Freak
  - Math_pow
```
public static float Math_pow(float n,
                             int x)
```
    Returns the value of the first argument raised to the power of the second argument.
    
    Parameters:
    
    n - The base.
    
    x - The exponent.
    
    Since:
    
    1.00
    
    Returns:
    
    n^x
    Author:
    Mythic_Freak
  - Math_abs
```
public static float Math_abs(float a)
```
    Returns the absolute value of the first argument.
    
    Parameters:
    
    a - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    a if a>=0; -a if a<0
    Author:
    Mythic_Freak
  - Math_fact
```
public static float Math_fact(int n)
```
    Returns the factorial of the given param.
    
    Parameters:
    
    n - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    n!
    Author:
    Mythic_Freak
    
    Author:
    Matei
  - Math_round
```
public static int Math_round(float a)
```
    Returns the closest int near the given float.
    
    Parameters:
    
    a - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the closest int
    Author:
    Mythic_Freak
  - Math_approx
```
public static float Math_approx(float a,
                                float approx)
```
    Returns an approximation of the given value to a certain accuracy.
    
    Parameters:
    
    a - the value to approximate
    
    approx - the required accuracy
    
    Since:
    
    1.00
    
    Returns:
    
    the approximated value
    Author:
    Mythic_Freak
  - Math_gcd
```
public static int Math_gcd(int a,
                           int b)
```
    Returns the greatest common divisor of 2 values.
    
    Parameters:
    
    a - The first input value.
    
    b - The second input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the greatest common divisor of a and b
    Author:
    Mythic_Freak
  - Math_lcm
```
public static int Math_lcm(int a,
                           int b)
```
    Returns the least common multiple of 2 values.
    
    Parameters:
    
    a - The first input value.
    
    b - The second input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the least common multiple of a and b
    Author:
    Mythic_Freak
  - Math_atan
```
public static float Math_atan(float n)
```
    Returns the arc tangent of a value; the returned angle is in the range -PI/2 through PI/2.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the arc tangent of n
    Author:
    Matei
  - Math_atan2
```
public static float Math_atan2(float z,
                               float x)
```
    Returns the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta). This method computes the phase theta by computing an arc tangent of y/x in the range of -PI to PI.
    
    Parameters:
    
    z - the ordinate coordinate
    
    x - the abscissa coordinate
    
    Since:
    
    1.00
    
    Returns:
    
    the theta component of the point (r, theta) in polar coordinates that corresponds to the point (x, y) in Cartesian coordinates.
    Author:
    Matei
  - Math_cos
```
public static float Math_cos(float n)
```
    Returns the trigonometric cosine of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the cosine of n
    Author:
    Matei
  - Math_sin
```
public static float Math_sin(float n)
```
    Returns the trigonometric sine of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the sine of n
    Author:
    Matei
  - Math_tan
```
public static float Math_tan(float n)
```
    Returns the trigonometric tangent of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the tangent of n
    Author:
    Mythic_Freak
  - Math_cotan
```
public static float Math_cotan(float n)
```
    Returns the trigonometric cotangent of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the cotangent of n
    Author:
    Mythic_Freak
  - Math_sec
```
public static float Math_sec(float n)
```
    Returns the trigonometric secant of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the secant of n
    Author:
    Mythic_Freak
  - Math_cosec
```
public static float Math_cosec(float n)
```
    Returns the trigonometric cosecant of an angle.
    
    Parameters:
    
    n - angle in radian
    
    Since:
    
    1.00
    
    Returns:
    
    the cosecant of n
    Author:
    Mythic_Freak
  - Math_sinh
```
public static float Math_sinh(float n)
```
    Returns the trigonometric sine hyperbolic of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the sine hyperbolic of n
    Author:
    Mythic_Freak
  - Math_cosh
```
public static float Math_cosh(float n)
```
    Returns the trigonometric cosine hyperbolic of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the cosine hyperbolic of n
    Author:
    Mythic_Freak
  - Math_tanh
```
public static float Math_tanh(float n)
```
    Returns the trigonometric tangent hyperbolic of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the tangent hyperbolic of n
    Author:
    Mythic_Freak
  - Math_cotanh
```
public static float Math_cotanh(float n)
```
    Returns the trigonometric cotangent hyperbolic of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the cotangent hyperbolic of n
    Author:
    Mythic_Freak
  - Math_sech
```
public static float Math_sech(float n)
```
    Returns the trigonometric secant hyperbolic of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the secant hyperbolic of n
    Author:
    Mythic_Freak
  - Math_cosech
```
public static float Math_cosech(float n)
```
    Returns the trigonometric cosecant hyperbolic of an angle.
    
    Parameters:
    
    n - angle in radians
    
    Since:
    
    1.00
    
    Returns:
    
    the cosecant hyperbolic of n
    Author:
    Mythic_Freak
  - Math_sqrt
```
public static float Math_sqrt(float s)
```
    Returns the square root of a given value.
    
    Parameters:
    
    s - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the square root of s
    Author:
    invent00r
  - Math_cbrt
```
public static float Math_cbrt(float s)
```
    Returns the cubic root of a given value
    
    Parameters:
    
    s - The input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the cubic root of s
    Author:
    invent00r
  - Math_QF
```
public static vector Math_QF(float a,
                             float b,
                             float c)
```
    Solves the quadratic formula to solve a quadratic equation.
    
    Parameters:
    
    a - the a as in ax� + bx + c
    
    b - the b as in ax� + bx + c
    
    c - the c as in ax� + bx + c
    
    Since:
    
    1.00
    
    Returns:
    
    The first component of the result vector is the first solution. The second component of the result vector is the second solution.
    Author:
    invent00r
  - Math_max
```
public static float Math_max(float a,
                             float b)
```
    Returns the highest of 2 params.
    
    Parameters:
    
    a - The first input value.
    
    b - The second input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the highest value out of a and b
    Author:
    Mythic_Freak
  - Math_min
```
public static float Math_min(float a,
                             float b)
```
    Returns the lowest value of 2 params.
    
    Parameters:
    
    a - The first input value.
    
    b - The second input value.
    
    Since:
    
    1.00
    
    Returns:
    
    the lowest value out of a and b
    Author:
    Mythic_Freak
  - Math_dist
```
public static float Math_dist(vector a,
                              vector b)
```
    Returns the distance between 2 points in a 3D location.
    
    Parameters:
    
    a - the first point
    
    b - the second point
    
    Since:
    
    1.00
    
    Returns:
    
    the distance d(a,b)
    Author:
    invent00r
  - Math_exp
```
public static float Math_exp(float a)
```
    Returns Euler's number e raised to the power of a float value.
    
    Parameters:
    
    a - The exponent.
    
    Since:
    
    1.00
    
    Returns:
    
    e^a
    Author:
    Mythic_Freak
  - Math_ln
```
public static float Math_ln(float a,
                            int acc)
```
    Returns the natural logarithm (base e) of a float value.
    
    Parameters:
    
    a - the value to calculate ln on
    
    acc - the wanted accuracy: higher accuracy(1000+) will slow down calculation
    
    Since:
    
    1.00
    
    Returns:
    
    ln(a)
    Author:
    Mythic_Freak
  - Math_log
```
public static float Math_log(float base,
                             float resa,
                             int acc)
```
    Returns the logarithm with given base of a float value.
    
    Parameters:
    
    base - the base value of the logarithm
    
    resa - the value to calculate log on
    
    acc - the wanted accuracy: higher accuracy(1000+) will slow down calculation
    
    Since:
    
    1.00
    
    Returns:
    
    log_base(resa)
    Author:
    Mythic_Freak
  - Math_log2
```
public static float Math_log2(float resa,
                              int acc)
```
    Returns the logarithm with base 2 of a float value.
    
    Parameters:
    
    resa - the value to calculate log2 on
    
    acc - the wanted accuracy: higher accuracy(1000+) will slow down calculation
    
    Since:
    
    1.00
    
    Returns:
    
    log2(resa)
    Author:
    Mythic_Freak
  - Math_log10
```
public static float Math_log10(float resa,
                               int acc)
```
    Returns the logarithm with base 10 of a float value.
    
    Parameters:
    
    resa - the value to calculate log10 on
    
    acc - the wanted accuracy: higher accuracy(1000+) will slow down calculation
    
    Since:
    
    1.00
    
    Returns:
    
    log10(resa)
    Author:
    Mythic_Freak
  - Math_rand
```
public static float Math_rand()
```
    Returns a float value with a positive sign, greater than or equal to 0.0 and less than 1.0. Returned values are chosen pseudorandomly with (approximately) uniform distribution from that range.
    
    Since:
    
    1.00
    
    Returns:
    
    a random number in the [0,1] interval
    Author:
    invent00r
  - Math_sign
```
public static int Math_sign(float a)
```
    Returns the signum function of the argument; zero if the argument is zero, 1 if the argument is greater than zero, -1 if the argument is less than zero.
    
    Parameters:
    
    a -
    
    Since:
    
    1.00
    
    Returns:
    
    -1 if a < 0; 0 if a = 0; 1 if a > 0
    Author:
    Mythic_Freak
  - Math_pointIsInRectangle
```
public static bool Math_pointIsInRectangle(vector topLeft,
                                           vector bottomRight,
                                           vector point)
```
    Decides whether or not a point in 2D space is part of a rectangle.
    
    Parameters:
    
    topLeft - the topleft point of the rectangle
    
    bottomRight - the bottomright point of the rectangle
    
    point - the point to check
    
    Since:
    
    1.00
    
    Returns:
    
    true if the point is in the rectangle, false otherwise.
    Author:
    Mythic_Freak
  - Math_GetVectorial
```
public static vector Math_GetVectorial(vector a,
                                       vector b,
                                       float distance)
```
    Unfortunately invent00r forgot what this is for, but he'll try to explain in version 3. -_-"
    
    Parameters:
    
    a -
    
    b -
    
    distance -
    
    Since:
    
    1.00
    
    Returns:
    
    Author:
    invent00r
  - Math_GetVectorialVector
```
public static vector Math_GetVectorialVector(vector a,
                                             vector b,
                                             float y)
```
    Unfortunately invent00r forgot what this is for, but he'll try to explain in version 3. -_-"
    
    Parameters:
    
    a -
    
    b -
    
    y -
    
    Since:
    
    1.00
    
    Returns:
    
    Author:
    invent00r
  - uiSelectUnit
```
public static void uiSelectUnit(int playerID,
                                string unitName)
```
    UI selects the unit, i.e. not trigger selection.
    
    Parameters:
    
    playerID - the owner of the unit
    
    unitName - the scenario name of this unit
    Author:
    Mythic_Freak & invent00r
    
    Since:
    
    1.00
  - uiSelectUnitByID
```
public static void uiSelectUnitByID(int playerID,
                                    int unitID)
```
    UI selects the unit, i.e. not trigger selection.
    
    Parameters:
    
    playerID - the owner of the unit
    
    unitID - the unit ID�
    Author:
    Mythic_Freak & invent00r
    
    Since:
    
    1.00
  - uiResetCamera
```
public static void uiResetCamera()
```
    Resets the camera to its default position.
    
    Since:
    
    1.01
  - uiRandomLightning
```
public static void uiRandomLightning()
```
    Sets the lightning completely random.
    Author:
    nottud
    
    Since:
    
    1.01
  - uiSelectType
```
public static void uiSelectType(string type)
```
    Selects a unit of the given type, but does not focus on it.
    
    Parameters:
    
    type - the unit type to select
    Author:
    Mythic_Freak
    
    Since:
    
    1.01
  - uiSelectIdleType
```
public static void uiSelectIdleType(string type)
```
    Selects an idle unit of the given type, but does not focus on it.
    
    Parameters:
    
    type - the unit type to select
    Author:
    Mythic_Freak
    
    Since:
    
    1.01
  - uiTrainUnit
```
public static void uiTrainUnit(string protoUnit,
                               string buildingUnitName,
                               bool repeat,
                               int playerID)
```
    Trains a unit using the UI commands.
    
    Parameters:
    
    protoUnit - the protounit to train
    
    buildingUnitName - the scenario name of the building to train the unit from
    
    repeat - turn autoqueue on or not?
    
    playerID - the player that should train the unit
    Author:
    Mythic_Freak & invent00r
    
    Since:
    
    1.01
    
    Note
    
    Repeat is disabled in this version.
  - xsSaveAndSetContextPlayer
```
public static void xsSaveAndSetContextPlayer(int playerID)
```
    Sets a new context player, and saves the previous one. Can be nested.
    
    Parameters:
    
    playerID - the new context player
    
    Since:
    
    2.00
    
    See Also:
    
    Author: Mythic_Freak
  - xsRestoreContextPlayer
```
public static void xsRestoreContextPlayer()
```
    Restores the previously saved context player. Can be nested.
    
    Since:
    
    2.00
    
    See Also:
    
    Author: Mythic_Freak
  - kbIsMultiplayer
```
public static bool kbIsMultiplayer()
```
    Checks if the current game is played in singleplayer or multiplayer mode.
    
    Since:
    
    2.00
    
    Returns:
    
    true if the game is played in multiplayer mode, else false.
    Author:
    invent00r
  - kbUnitCostPerResource
```
public static int kbUnitCostPerResource(int protoUnitID,
                                        int resourceID)
```
    Returns the default cost of a unit with given protounit and resource. Does not calcuate any price reductions.
    
    Parameters:
    
    protoUnitID - the protonit ID to retrieve the cost from
    
    resourceID - the resource to check
    
    Since:
    
    2.00
    
    Returns:
    
    the default resource cost for a given unit.
    Author:
    invent00r
  - trGetUnitOwnerByID
```
public static int trGetUnitOwnerByID(int unitID)
```
    Returns the current owner of the unit.
    
    Parameters:
    
    unitID - the unit ID to check
    
    Since:
    
    1.00
    
    Returns:
    
    the owner ID of the unit
    Author:
    Mythic_Freak
  - trGetUnitOwner
```
public static int trGetUnitOwner(string unitName)
```
    Returns the current owner of the unit.
    
    Parameters:
    
    unitName - the scenario name of the unit
    
    Since:
    
    1.00
    
    Returns:
    
    the owner ID of the unit
    Author:
    Mythic_Freak
  - enterEditorMode
```
public static void enterEditorMode()
```
    Switches the current mode to editor mode.
    Author:
    nottud
    
    Since:
    
    1.01
  - leaveEditorMode
```
public static void leaveEditorMode()
```
    Leaves the editor mode and returns to the actual game.
    Author:
    nottud
    
    Since:
    
    1.01
  - trRunEditorConsoleCommand
```
public static void trRunEditorConsoleCommand(string cmd)
```
    Executes a console command that can only run in editor mode.
    
    Parameters:
    
    cmd - the command to execute
    Author:
    nottud
    
    Since:
    
    1.01
  - getUnit
```
public static int getUnit(int unitType,
                          int action,
                          vector center)
```
    Returns the ID of a unit matching the following criteria:
    
    Parameters:
    
    unitType - the type of the unit
    
    action - the current action of the unit
    
    center - the unit closest to this point will be returned if it is provided, else it will pick a random unit from the results.
    
    Since:
    
    1.01
    
    Returns:
    
    returns the ID of the chosen unit.
    Author:
    Mythic_Freak
  - kbUnitQueryCreate2
```
public static int kbUnitQueryCreate2(string qname,
                                     int unitType,
                                     int action,
                                     int statea,
                                     int playera,
                                     vector center,
                                     bool sort,
                                     float radiusa)
```
    Creates and executes a unit query with the following results and returns the query ID.
    
    Parameters:
    
    qname - the name of the query
    
    unitType - the unit type to search for
    
    action - the current action of the unit
    
    statea - the current state of the unit
    
    playera - the unit owner
    
    center - if sort is enabled the results will be sorted based on the distance to this point, ascending
    
    sort - true if the results should be sorted in ascending order
    
    radiusa - the max radius the units may be from the center point
    
    Since:
    
    1.01
    
    Returns:
    
    the query ID
    Author:
    Mythic_Freak
  - print
```
public static void print(string text)
```
    Outputs a piece of text to the game.
    
    Parameters:
    
    text - the text for output
    Author:
    Mythic_Freak & invent00r
    
    Since:
    
    1.01
  - getTime
```
public static string getTime()
```
    Returns a time string formatted as hh:mm:ss or mm:ss if the game does not last an hour yet.
    
    Since:
    
    1.02
    
    Returns:
    
    the time string
    Author:
    Mythic_Freak & invent00r
  - saveCameraOnline
```
public static void saveCameraOnline(string filename)
```
    Saves the current camera position (in-game, not in the editor) to a given file.
    
    Parameters:
    
    filename - the name of the file to store the camera position
    Author:
    Mythic_Freak
    
    Since:
    
    1.02
  - loadCameraOnline
```
public static void loadCameraOnline(string filename)
```
    Load a camera position from a given file.
    
    Parameters:
    
    filename - the name of the file to retrieve the camera postion from
    Author:
    Mythic_Freak
    
    Since:
    
    1.02
  - zoomToPoint
```
public static void zoomToPoint(vector point)
```
    Forced the camera to look straight down to 1 point.
    
    Parameters:
    
    point - the point to zoom at.
    Author:
    nottud
    
    Since:
    
    1.02
    
    Note
    
    This function is very inaccurate, and may fail for certain elevations.
  - clickAtPoint
```
public static void clickAtPoint(vector point)
```
    Forces the camera to the given point with zoomToPoint, and issues a left mouse click command.
    
    Parameters:
    
    point - the point to click
    Author:
    Mythic_Freak
    
    Since:
    
    1.02
  - shiftClickAtPoint
```
public static void shiftClickAtPoint(vector point)
```
    Forces the camera to the given point with zoomToPoint, and issues a left mouse shift-click command.
    
    Parameters:
    
    point - the point to click
    Author:
    Mythic_Freak
    
    Since:
    
    1.02
  - doubleClickAtPoint
```
public static void doubleClickAtPoint(vector point)
```
    Forces the camera to the given point with zoomToPoint, and issues a left mouse double-click command.
    
    Parameters:
    
    point - the point to click
    Author:
    Mythic_Freak
    
    Since:
    
    1.02
  - shiftDoubleClickAtPoint
```
public static void shiftDoubleClickAtPoint(vector point)
```
    Forces the camera to the given point with zoomToPoint, and issues a left mouse shift-double-click command.
    
    Parameters:
    
    point - the point to click
    Author:
    Mythic_Freak
    
    Since:
    
    1.02
  - controlDoubleClickAtPoint
```
public static void controlDoubleClickAtPoint(vector point)
```
    Forces the camera to the given point with zoomToPoint, and issues a left mouse control-double-click command.
    
    Parameters:
    
    point - the point to click
    Author:
    Mythic_Freak
    
    Since:
    
    2.00
  - controlShiftDoubleClickAtPoint
```
public static void controlShiftDoubleClickAtPoint(vector point)
```
    Forces the camera to the given point with zoomToPoint, and issues a left mouse control-shift-double-click command.
    
    Parameters:
    
    point - the point to click
    Author:
    Mythic_Freak
    
    Since:
    
    2.00
  - rightClickAtPoint
```
public static void rightClickAtPoint(vector point)
```
    Forces the camera to the given point with zoomToPoint, and issues a right mouse click command.
    
    Parameters:
    
    point - the point to click
    Author:
    Mythic_Freak
    
    Since:
    
    1.02
  - trQuestVarSet
```
public static void trQuestVarSet(string QVname,
                                 float QVvalue)
```
    Assigns a float value to the given QV.
    
    Parameters:
    
    QVname - the QV name
    
    QVvalue - the float value to assign
    Author:
    invent00r
    
    Since:
    
    1.00
  - trQuestVarGet
```
public static float trQuestVarGet(string QVname)
```
    Returns the float value assigned to this QV.
    
    Parameters:
    
    QVname - the QV name
    
    Since:
    
    1.00
    
    Returns:
    
    the float value assigned to this QV.
    
    Note
    
    uninitialized QVs start at -1.
    Author:
    invent00r
  - trQuestVarSetFromRand
```
public static void trQuestVarSetFromRand(string QVname,
                                         float min,
                                         float max,
                                         bool Round)
```
    Sets a given QV to a random value in the [min,max] interval.
    
    Parameters:
    
    QVname - the QV name
    
    min - the minimum bound
    
    max - the maximum bound
    
    Round - true if the values should be rounded to the closest integer value.
    Author:
    invent00r
    
    Since:
    
    1.00
  - trQuestVarEcho
```
public static void trQuestVarEcho(string QVname)
```
    Echoes the value of the given QV to the system.
    
    Parameters:
    
    QVname - the QV name
    Author:
    invent00r
    
    Since:
    
    1.00
  - trQuestVarCopy
```
public static void trQuestVarCopy(string QVname,
                                  string QVname2)
```
    Copies the value of 1 QV into another.
    
    Parameters:
    
    QVname - the QV name of the source QV
    
    QVname2 - the QV name of the desiniation QV
    Author:
    invent00r
    
    Since:
    
    1.00
  - trVectorQuestVarSet
```
public static void trVectorQuestVarSet(string VQVname,
                                       vector QVv)
```
    Assigns a vector(X,Y,Z) to a VQV.
    
    Parameters:
    
    VQVname - the vector QV name
    
    QVv - the vector to assign
    Author:
    invent00r
    
    Since:
    
    1.00
  - trVectorQuestVarGet
```
public static vector trVectorQuestVarGet(string VQVname)
```
    Returns the vector assigned to the given VQV.
    
    Parameters:
    
    VQVname - the vector QV name
    
    Since:
    
    1.00
    
    Returns:
    
    the vector assigned to VQVname
    
    Note
    
    uninitialized QVs start at (-1,-1,-1).
    Author:
    invent00r
  - trVectorQuestVarGetX
```
public static float trVectorQuestVarGetX(string VQVname)
```
    Returns the X component of the given VQV.
    
    Parameters:
    
    VQVname - the vector QV name
    
    Since:
    
    1.00
    
    Returns:
    
    the X component of VQVname
    Author:
    invent00r
  - trVectorQuestVarGetY
```
public static float trVectorQuestVarGetY(string VQVname)
```
    Returns the Y component of the given VQV.
    
    Parameters:
    
    VQVname - the vector QV name
    
    Since:
    
    1.00
    
    Returns:
    
    the Y component of VQVname
    Author:
    invent00r
  - trVectorQuestVarGetZ
```
public static float trVectorQuestVarGetZ(string VQVname)
```
    Returns the Z component of the given VQV.
    
    Parameters:
    
    VQVname - the vector QV name
    
    Since:
    
    1.00
    
    Returns:
    
    the Z component of VQVname
    Author:
    invent00r
  - trVectorQuestVarEcho
```
public static void trVectorQuestVarEcho(string VQVname)
```
    Echoes the VQV to the output.
    
    Parameters:
    
    VQVname - the vector QV to echo
    Author:
    invent00r
    
    Since:
    
    1.00
  - trStringQuestVarSet
```
public static void trStringQuestVarSet(string SQVname,
                                       string SQVvalue)
```
    Assigns a string to a given string QV.
    
    Parameters:
    
    SQVname - the string QV name
    
    SQVvalue - the value to be assigned
    Author:
    invent00r
    
    Since:
    
    1.00
  - trStringQuestVarGet
```
public static string trStringQuestVarGet(string SQVname)
```
    Returns the string assigned to the given string QV.
    
    Parameters:
    
    SQVname - the string QV
    
    Since:
    
    1.00
    
    Returns:
    
    the string assigned to SQVname
    Author:
    invent00r
  - trStringQuestVarEcho
```
public static void trStringQuestVarEcho(string SQVname)
```
    Echoes the SQV to the output.
    
    Parameters:
    
    SQVname - the string QV to echo
    Author:
    invent00r
    
    Since:
    
    1.00
  - trQuestVarArmySet
```
public static void trQuestVarArmySet(string QVAname,
                                     vector army)
```
    Assigns an army to the given army QV.
    
    Parameters:
    
    QVAname - the army QV
    
    army -
    Author:
    invent00r
    
    Since:
    
    2.00
  - trQuestVarArmyGet
```
public static string trQuestVarArmyGet(string QVAname)
```
    Returns the army assigned to the given army QV.
    
    Parameters:
    
    QVAname - the army QV
    
    Since:
    
    2.00
    
    Returns:
    
    the value assigned to the army QV
    Author:
    invent00r
  - trQuestVarArmyGetID
```
public static int trQuestVarArmyGetID(string QVAname)
```
    Returns the army ID of the given army QV.
    
    Parameters:
    
    QVAname - the army QV
    
    Since:
    
    2.00
    
    Returns:
    
    the army ID of the army QV.
    Author:
    invent00r & Mythic_Freak
  - trQuestVarArmyGetPlayerID
```
public static int trQuestVarArmyGetPlayerID(string QVAname)
```
    Returns the player ID of the given army QV.
    
    Parameters:
    
    QVAname - the army QV
    
    Since:
    
    2.00
    
    Returns:
    
    the player ID of the army QV.
    Author:
    invent00r
  - trQuestVarArmyEcho
```
public static void trQuestVarArmyEcho(string QVAname)
```
    Echoes the army QV to the output.
    
    Parameters:
    
    QVAname - the army QV
    Author:
    invent00r & Mythic_Freak
    
    Since:
    
    2.00
  - xsArrayGetID
```
public static int xsArrayGetID(string ArrayName)
```
    Converts an array name to an array ID.
    
    Parameters:
    
    ArrayName - the array name
    
    Since:
    
    2.00
    
    Returns:
    
    the array ID.
    Author:
    invent00r
  - xsArrayGetSizeByName
```
public static vector xsArrayGetSizeByName(string ArrayName)
```
    Returns the size of the array. The X-component is the X-size, and the Y-component is the Y-size.
    
    Parameters:
    
    ArrayName - the name of the array
    
    Since:
    
    2.00
    
    Returns:
    
    a vector containing the 2 size values.
    Author:
    invent00r
  - xsArrayGetSizeXByName
```
public static int xsArrayGetSizeXByName(string ArrayName)
```
    Returns the X-size of the given array.
    
    Parameters:
    
    ArrayName - the name of the array
    
    Since:
    
    2.00
    
    Returns:
    
    the X-size of the array.
    Author:
    invent00r
  - xsArrayGetSizeYByName
```
public static int xsArrayGetSizeYByName(string ArrayName)
```
    Returns the Y-size of the given array.
    
    Parameters:
    
    ArrayName - the name of the array
    
    Since:
    
    2.00
    
    Returns:
    
    the Y-size of the array.
    Author:
    invent00r
  - xsArrayGetSize
```
public static vector xsArrayGetSize(int Aid)
```
    Returns the size of the array. The X-component is the X-size, and the Y-component is the Y-size.
    
    Parameters:
    
    Aid - the ID of the array
    
    Since:
    
    2.00
    
    Returns:
    
    a vector containing the 2 size values.
    Author:
    invent00r
  - xsArrayGetSizeX
```
public static int xsArrayGetSizeX(int Aid)
```
    Returns the X-size of the given array.
    
    Parameters:
    
    Aid - the ID of the array
    
    Since:
    
    2.00
    
    Returns:
    
    the X-size of the array.
    Author:
    invent00r
  - xsArrayGetSizeY
```
public static int xsArrayGetSizeY(int Aid)
```
    Returns the Y-size of the given array.
    
    Parameters:
    
    Aid - the ID of the array
    
    Since:
    
    2.00
    
    Returns:
    
    the Y-size of the array.
    Author:
    invent00r
  - xsArraySetDefaultValue
```
public static bool xsArraySetDefaultValue(int Aid,
                                          float defaultvalue)
```
    Sets the default value of the given array.
    
    Parameters:
    
    Aid - the array ID
    
    defaultvalue - the default value to set
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArrayGetDefaultValue
```
public static float xsArrayGetDefaultValue(int Aid)
```
    Returns the default value of the given array.
    
    Parameters:
    
    Aid - the array ID
    
    Since:
    
    2.00
    
    Returns:
    
    the default value.
    Author:
    invent00r
  - xsArraySetByName
```
public static bool xsArraySetByName(string ArrayName,
                                    float value,
                                    int posX,
                                    int posY)
```
    Sets a value of the array.
    
    Parameters:
    
    ArrayName - the name of the array
    
    value - the value to set
    
    posX - the X-position
    
    posY - the Y-position
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArraySet
```
public static bool xsArraySet(int Aid,
                              float value,
                              int posX,
                              int posY)
```
    Sets a value of the array.
    
    Parameters:
    
    Aid - the ID of the array
    
    value - the value to set
    
    posX - the X-position
    
    posY - the Y-position
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArrayFill
```
public static bool xsArrayFill(int Aid,
                               float defaultvalue,
                               float replaceVal)
```
    Fills the given array with a given value.
    
    Parameters:
    
    Aid - the array ID
    
    defaultvalue - the value to fill the array with
    
    replaceVal - if this value is set, only those values will be overwritten in the array.
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArrayFillByName
```
public static bool xsArrayFillByName(string ArrayName,
                                     float defaultvalue,
                                     float replaceVal)
```
    Fills the given array with a given value.
    
    Parameters:
    
    ArrayName - the name of the array
    
    defaultvalue - the value to fill the array with
    
    replaceVal - if this value is set, only those values will be overwritten in the array.
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArrayResize
```
public static bool xsArrayResize(int Aid,
                                 int newSizeX,
                                 int newSizeY)
```
    Resizes the given array, filling new spots with the default value.
    
    Parameters:
    
    Aid - the array ID
    
    newSizeX - the new X-size
    
    newSizeY - the new Y-size
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArrayCreate
```
public static int xsArrayCreate(string ArrayName,
                                int dimX,
                                int dimY,
                                float defaultvalue)
```
    Creates a new array of float values, with given dimensions and default value.
    
    Parameters:
    
    ArrayName - the array name
    
    dimX - the X-size
    
    dimY - the Y-size
    
    defaultvalue - the default value
    
    Since:
    
    2.00
    
    Returns:
    
    the array ID.
    Author:
    invent00r
  - xsArrayGetByName
```
public static float xsArrayGetByName(string ArrayName,
                                     int posX,
                                     int posY)
```
    Gets a value from the given array.
    
    Parameters:
    
    ArrayName - the array name
    
    posX - the X-position
    
    posY - the Y-position
    
    Since:
    
    2.00
    
    Returns:
    
    the value found at ArrayName[posX][posY].
    Author:
    invent00r
  - xsArrayGet
```
public static float xsArrayGet(int Aid,
                               int posX,
                               int posY)
```
    Gets a value from the given array.
    
    Parameters:
    
    Aid - the array ID
    
    posX - the X-position
    
    posY - the Y-position
    
    Since:
    
    2.00
    
    Returns:
    
    the value found at Aid[posX][posY].
    Author:
    invent00r
  - xsArrayEcho
```
public static void xsArrayEcho(string AName,
                               int posX,
                               int posY)
```
    Echoes a value in the array to the output.
    
    Parameters:
    
    AName - the name of the array
    
    posX - the X-position
    
    posY - the Y-position
    Author:
    Mythic_Freak & invent00r
    
    Since:
    
    2.00
  - xsArrayEchoAll
```
public static void xsArrayEchoAll(string AName)
```
    Echoes all values in the array to the output, in a linear manner.
    
    Parameters:
    
    AName - the name of the array
    Author:
    Mythic_Freak & invent00r
    
    Since:
    
    2.00
  - xsArrayEchoAll2
```
public static void xsArrayEchoAll2(string AName)
```
    Echoes all values in the array to the output, in a matrix formation. Only works for relatively small arrays.
    
    Parameters:
    
    AName - the name of the array
    Author:
    Mythic_Freak & invent00r
    
    Since:
    
    2.00
  - xsArrayEqual
```
public static bool xsArrayEqual(string AName1,
                                string AName2)
```
    Returns true if both arrays have the same content.
    
    Parameters:
    
    AName1 - the name of array 1
    
    AName2 - the name of array 2
    
    Since:
    
    2.00
    
    Returns:
    
    true if all values match, otherwise false.
    Author:
    Mythic_Freak & invent00r
  - xsArraySwapByName
```
public static bool xsArraySwapByName(string ArrayName,
                                     int lineA,
                                     int lineB)
```
    Swaps 2 columns in the given array.
    
    Parameters:
    
    ArrayName - the name of the array
    
    lineA - column 1 to swap
    
    lineB - column 2 to swap
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArraySwap
```
public static bool xsArraySwap(int Aid,
                               int lineA,
                               int lineB)
```
    Swaps 2 columns in the given array.
    
    Parameters:
    
    Aid - the ID of the array
    
    lineA - column 1 to swap
    
    lineB - column 2 to swap
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArraySort
```
public static bool xsArraySort(int Aid,
                               int posY,
                               bool Descending)
```
    Sort a given row of the array, in chosen order.
    
    Parameters:
    
    Aid - the array ID
    
    posY - the row to sort
    
    Descending - the compare operator
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r
  - xsArrayFind
```
public static int xsArrayFind(int Aid,
                              int posY,
                              int nFind)
```
    Tries to find a value in a given row of the provided array.
    
    Parameters:
    
    Aid - the array ID
    
    posY - the row number
    
    nFind - the value to search for
    
    Since:
    
    2.00
    
    Returns:
    
    the X-position of the found element, or -1 in case the value was not present.
    Author:
    invent00r
  - xsArrayDelete
```
public static bool xsArrayDelete(int Aid,
                                 int posX)
```
    Deletes an X-column from the array.
    
    Parameters:
    
    Aid - the array ID
    
    posX - the column to delete
    
    Since:
    
    2.00
    
    Returns:
    
    true if the operation was successful.
    Author:
    invent00r

Class TriggerLoader

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

PI

e

cMyID

cNumberNonGaiaPlayers

cMyCulture

cMyCiv

cGameMode

Method Detail

String_substr

String_length

String_charAt

String_toUpperCase

String_toLowerCase

String_parseFloat

String_toString

Math_mod

Math_floor

Math_ceil

Math_radianToDegree

Math_degreeToRadian

Math_intToBool

Math_boolToInt

Math_intToFloat

Math_floatToInt

Math_pow

Math_abs

Math_fact

Math_round

Math_approx

Math_gcd

Math_lcm

Math_atan

Math_atan2

Math_cos

Math_sin

Math_tan

Math_cotan

Math_sec

Math_cosec

Math_sinh

Math_cosh

Math_tanh

Math_cotanh

Math_sech

Math_cosech

Math_sqrt

Math_cbrt

Math_QF

Math_max

Math_min

Math_dist

Math_exp

Math_ln

Math_log

Math_log2

Math_log10

Math_rand

Math_sign

Math_pointIsInRectangle

Math_GetVectorial

Math_GetVectorialVector

uiSelectUnit

uiSelectUnitByID

uiResetCamera

uiRandomLightning

uiSelectType

uiSelectIdleType

uiTrainUnit

xsSaveAndSetContextPlayer

xsRestoreContextPlayer

kbIsMultiplayer

kbUnitCostPerResource

trGetUnitOwnerByID

trGetUnitOwner

enterEditorMode