Map

Written by: Alian713, Kramb

---

1. xsGetMapName

Returning Type: string

Prototype: string xsGetMapName(bool showFileExtension)

Parameters:

1. bool showFileExtension: If this is set to true, then the returned name also contains the file extension

Returns the name of the map currently being played.

2. xsGetMapID

Returning Type: int

Prototype: int xsGetMapID()

Returns the AI map type.

3. xsGetMapHeight

Returning Type: int

Prototype: int xsGetMapHeight()

Returns the Height of the map.

4. xsGetMapWidth

Returning Type: int

Prototype: int xsGetMapWidth()

Returns the Width of the map.

5. xsGetColorMood

Returning Type: int

Prototype: int xsGetColorMood()

Returns the current color mood of the map. Refer to the Constant Reference for all the different color mood IDs

6. xsSetColorMood

Returning Type: bool

Prototype: bool xsSetColorMood(int colorMood, int interval)

Parameters:

1. int colorMood: The color mood to set
2. (Optional) int interval: The transition duration in seconds

Sets the color mood of the map with a transition time. Refer to the Constant Reference for all the different color mood IDs

7. xsTriggerVariable

Returning Type: int

Prototype: int xsTriggerVariable(int variableId)

Parameters:

1. int variableId: The ID of the variable to get the value of

Returns the value of the variable of the given variable ID.

8. xsSetTriggerVariable

Returning Type: void

Prototype: void xsSetTriggerVariable(int variableId, int value)

Parameters:

1. int variableId: The ID of the variable to set the value of
2. int value: The value to set the variable to

Sets the value of the variable of the given variable ID to the provided value.