GameOptionType (Civ5 Type)
This page is a part of the Lua and UI Reference (Civ5).
|
The GameOptionType 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
Lua: the GameOptionTypes enumeration
Firaxis provides a Lua enumeration named GameOptionTypes. This is just a regular global table. Its keys are the constants' names and the pairs the corresponding values.
Below are the values found in this enumeration.
Key
Value
"NO_GAMEOPTION"
-1
"GAMEOPTION_NO_CITY_RAZING"
0
"GAMEOPTION_NO_BARBARIANS"
1
"GAMEOPTION_RAGING_BARBARIANS"
2
"GAMEOPTION_ALWAYS_WAR"
3
"GAMEOPTION_ALWAYS_PEACE"
4
"GAMEOPTION_ONE_CITY_CHALLENGE"
5
"GAMEOPTION_NO_CHANGING_WAR_PEACE"
6
"GAMEOPTION_NEW_RANDOM_SEED"
7
"GAMEOPTION_LOCK_MODS"
8
"GAMEOPTION_COMPLETE_KILLS"
9
"GAMEOPTION_NO_GOODY_HUTS"
10
"GAMEOPTION_RANDOM_PERSONALITIES"
11
"GAMEOPTION_POLICY_SAVING"
12
"GAMEOPTION_PROMOTION_SAVING"
13
"GAMEOPTION_END_TURN_TIMER_ENABLED"
14
"GAMEOPTION_QUICK_COMBAT"
15
"GAMEOPTION_DISABLE_START_BIAS"
16
"GAMEOPTION_NO_SCIENCE"
17
"GAMEOPTION_NO_POLICIES"
18
"GAMEOPTION_NO_HAPPINESS"
19
"GAMEOPTION_NO_TUTORIAL"
20
"GAMEOPTION_NO_RELIGION"
21
"NUM_GAMEOPTION_TYPES"
22
Examples
Here is how to use the LUA enumeration to retrieve the ID from the type. Those examples will return and assign the integer value 0.
local id = GameOptionTypes.GAMEOPTION_NO_CITY_RAZING
local id = GameOptionTypes["GAMEOPTION_NO_CITY_RAZING"]
Used by
|
Game.SetOption(GameOptionType index, bool enabled)
|
The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.
