RandomMap

Object
- RandomMap

```
public abstract class RandomMap
extends Object
```
This class provides a collection of RM commands that don't fit in any of the subcategories. Credits to HyenaStudio's (and M0nTy_PyTh0n in particular) for most of the documentation.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Local Call
RMS commands are always executed locally. If all players have the same map script, and the same seed is used, the result should be the same for all players.

See Also:

Hyena Studio's

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cMapSize` 0 = normal size 1 = large size
`int`	`cNumberNonGaiaPlayers` Total number of players, mother nature excluded.
`int`	`cNumberPlayers` Total number of players, mother nature included.
`int`	`cNumberTeams` Total number of teams.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`rmClassID(string name)` Gets class ID for given class name.
`int`	`rmDefineClass(string className)` Define a class with the given name.
`void`	`rmDefineConstant(string name, int value)` Define a constant with given name and value.
`void`	`rmEchoError(string echoString, int level)` Echoes an error string to the debugger output, can not be seen in AoT.
`void`	`rmEchoInfo(string echoString, int level)` Echoes an info string to the debugger output, can not be seen in AoT.
`void`	`rmEchoWarning(string echoString, int level)` Echoes a warning string to the debugger output, can not be seen in AoT.
`float`	`rmGetSeaLevel()` Gets the sea level for the map.
`void`	`rmRandFloat(float min, float max)` Returns a random float between min and max.
`void`	`rmRandInt(int min, int max)` Returns a random integer between min and max.
`void`	`rmSetGaiaCiv(long civ)` Sets Gaia's civilization.
`void`	`rmSetLightingSet(string name)` Sets a lighting set.
`void`	`rmSetMapSize(int x, int z)` Sets the size of the map.
`void`	`rmSetSeaLevel()` Sets the sea level for the map.
`void`	`rmSetSeaType(string name)` Sets the sea type for the map.
`void`	`rmSetStatusText(string status, float progress)` Sets the friendly cool loading screen text
`void`	`rmTerrainInitialize(string baseTerrain, float height)` Initializes the terrain to the base type and height.
`void`	`sqrt(float x)` Returns the square root of x.

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

- Field Detail
  - cMapSize
```
public final int cMapSize
```
    0 = normal size 1 = large size
  - cNumberNonGaiaPlayers
```
public final int cNumberNonGaiaPlayers
```
    Total number of players, mother nature excluded.
  - cNumberPlayers
```
public final int cNumberPlayers
```
    Total number of players, mother nature included.
    
    Note
    
    cNumberPlayers = cNumberNonGaiaPlayers + 1;
  - cNumberTeams
```
public final int cNumberTeams
```
    Total number of teams.
- Method Detail
  - sqrt
```
public void sqrt(float x)
```
    Returns the square root of x.
  - rmClassID
```
public int rmClassID(string name)
```
    Gets class ID for given class name.
  - rmDefineClass
```
public int rmDefineClass(string className)
```
    Define a class with the given name. Classes can group areas or objects together.
  - rmDefineConstant
```
public void rmDefineConstant(string name,
                             int value)
```
    Define a constant with given name and value.
  - rmEchoError
```
public void rmEchoError(string echoString,
                        int level)
```
    Echoes an error string to the debugger output, can not be seen in AoT.
  - rmEchoInfo
```
public void rmEchoInfo(string echoString,
                       int level)
```
    Echoes an info string to the debugger output, can not be seen in AoT.
  - rmEchoWarning
```
public void rmEchoWarning(string echoString,
                          int level)
```
    Echoes a warning string to the debugger output, can not be seen in AoT.
  - rmGetSeaLevel
```
public float rmGetSeaLevel()
```
    Gets the sea level for the map.
  - rmRandFloat
```
public void rmRandFloat(float min,
                        float max)
```
    Returns a random float between min and max.
  - rmRandInt
```
public void rmRandInt(int min,
                      int max)
```
    Returns a random integer between min and max.
  - rmSetGaiaCiv
```
public void rmSetGaiaCiv(long civ)
```
    Sets Gaia's civilization.
  - rmSetLightingSet
```
public void rmSetLightingSet(string name)
```
    Sets a lighting set.
  - rmSetMapSize
```
public void rmSetMapSize(int x,
                         int z)
```
    Sets the size of the map.
  - rmSetSeaLevel
```
public void rmSetSeaLevel()
```
    Sets the sea level for the map.
  - rmSetSeaType
```
public void rmSetSeaType(string name)
```
    Sets the sea type for the map. This is used if terrain is initialized to water.
  - rmSetStatusText
```
public void rmSetStatusText(string status,
                            float progress)
```
    Sets the friendly cool loading screen text
  - rmTerrainInitialize
```
public void rmTerrainInitialize(string baseTerrain,
                                float height)
```
    Initializes the terrain to the base type and height.

Class RandomMap

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

cMapSize

cNumberNonGaiaPlayers

cNumberPlayers

cNumberTeams

Method Detail

sqrt

rmClassID

rmDefineClass

rmDefineConstant

rmEchoError

rmEchoInfo

rmEchoWarning

rmGetSeaLevel

rmRandFloat

rmRandInt

rmSetGaiaCiv

rmSetLightingSet

rmSetMapSize

rmSetSeaLevel

rmSetSeaType

rmSetStatusText

rmTerrainInitialize