# Module `REGION_SCRIPT_INTERFACE`

Extensions to the game's region object.

## Functions

GetMemoryAddress () | Returns the memory address of the region object as a hexadecimal string.
GetPopulationSurplus () | Gets the population surplus for the region (points used to expand settlement slots).
SetPopulationSurplus (value) | Sets the population surplus for the region (points used to expand settlement slots).
GetGrowthPoints () | Gets the number of growth points for the region (accumulated growth).
SetGrowthPoints (value) | Sets the number of growth points for the region (accumulated growth).

## Functions

GetMemoryAddress ()
  Returns the memory address of the region object as a hexadecimal string.

  ### Returns:

  string memory address (e.g. "0x12345678")
GetPopulationSurplus ()
  Gets the population surplus for the region (points used to expand settlement slots).

  ### Returns:

  integer population surplus
SetPopulationSurplus (value)
  Sets the population surplus for the region (points used to expand settlement slots).

  ### Parameters:

  - value integer new population surplus
GetGrowthPoints ()
  Gets the number of growth points for the region (accumulated growth).

  ### Returns:

  integer number of growth points
SetGrowthPoints (value)
  Sets the number of growth points for the region (accumulated growth).

  ### Parameters:

  - value integer new number of growth points

generated by LDoc 1.5.0