User:DonQuich
This page is a part of the Lua and UI Reference.
The 'TerrainID' pseudo-type is actually a regular integer.
Pseudo-types do not exist in LUA, they only serve a documentation purpose on the wiki!
Integers labeled as 'TerrainID' corresponds to the 'ID' column of the Civ5Terrains XML table.
The values in the 'ID' and 'Type' columns are also dynamically stored on startup in the TerrainTypes LUA enumeration.
TerrainTypes enumeration
A LUA enumeration is a just a regular table.
It is commonly used to store constants, the keys being the constants' names and the pairs the corresponding values.
On startup, the game reads the Civ5Terrains data table and stores key/value pairs in the LUA enumeration.
The keys are the strings from the 'Type' column and the values are the integers from the 'ID' column.
Below are the values found in an unmodded game updated with Gods & Kings 1.0.1.705 (August 2012).
| Key (integer) | Value (string) | |
|---|---|---|
| "NO_TERRAIN" | -1 | |
| "TERRAIN_GRASS" | 0 | |
| "TERRAIN_PLAINS" | 1 | |
| "TERRAIN_DESERT" | 2 | |
| "TERRAIN_TUNDRA" | 3 | |
| "TERRAIN_SNOW" | 4 | |
| "TERRAIN_COAST" | 5 | |
| "TERRAIN_OCEAN" | 6 | |
| "TERRAIN_MOUNTAIN" | 7 | |
| "TERRAIN_HILL" | 8 | |
| "NUM_TERRAIN_TYPES" | 9 |
Examples
Here is how to use the LUA enumeration to retrieve the ID from the 'type'. The variable 'id' will be assigned the integer value.0.
local id = TerrainTypes.TERRAIN_GRASS local id = TerrainTypes["TERRAIN_GRASS"]
Here are different ways to query the database to retrieve the ID from the 'type'. The variable 'id' will be assigned the value 0. See also GameInfo.
local id = GameInfo.Civ5Terrains.TERRAIN_GRASS.ID
local id = GameInfo["Civ5Terrains"]["TERRAIN_GRASS"]["ID"]
local id = GameInfo.Civ5Terrains{Type="TERRAIN_GRASS"}().ID
Alternatively you could use this ID to retrieve the value of the 'Description' column. Those examples will return and assign "TXT_KEY_TERRAIN_GRASS".
local description = GameInfo.Civ5Terrains.TERRAIN_GRASS.Description
local description = GameInfo["Civ5Terrains"]["TERRAIN_GRASS"]["Description"]
local description = GameInfo.Civ5Terrains{ID="TERRAIN_GRASS"}().Description
Methods using those identifiers
- void Plot:SetTerrainType(TerrainID type)
