PlayerOptionType (Civ5 Type)

From Civilization Modding Wiki
Jump to: navigation, search

This page is a part of the Lua and UI Reference (Civ5).


ID.png The PlayerOptionType pseudo-type is actually a regular integer. Pseudo-types do not exist in Lua, they only serve a documentation purpose on the wiki!
  • DB.png Integers labeled as PlayerOptionType corresponds to the ID column of the PlayerOptions XML table.


XML: the PlayerOptions table

Here are the ID and Type columns found in this table.

ID Type
0 PLAYEROPTION_WAIT_END_TURN
1 PLAYEROPTION_SHOW_FRIENDLY_MOVES
2 PLAYEROPTION_SHOW_ENEMY_MOVES
3 PLAYEROPTION_QUICK_MOVES
4 PLAYEROPTION_START_AUTOMATED
5 PLAYEROPTION_SAFE_AUTOMATION
6 PLAYEROPTION_NO_UNIT_CYCLING
7 PLAYEROPTION_LEAVE_FORESTS
8 PLAYEROPTION_MODDER_1
9 PLAYEROPTION_MODDER_2
10 PLAYEROPTION_MODDER_3


Examples

Here are different ways to query the database to retrieve the ID from the type. Those examples will return and assign the integer value 0. See also GameInfo.

local id = GameInfo.PlayerOptions.PLAYEROPTION_WAIT_END_TURN.ID
local id = GameInfo["PlayerOptions"].["PLAYEROPTION_WAIT_END_TURN"].ID
local id = GameInfo.PlayerOptions{Type="PLAYEROPTION_WAIT_END_TURN"}().ID

Alternatively you could use the ID or the type to retrieve the value of the Description column. Those examples will return and assign the value TXT_KEY_PLAYER_OPTION_WAIT_AT_END_OF_TURN.

local description = GameInfo.PlayerOptions[0].Description
local description = GameInfo["PlayerOptions"][0]["Description"]
local description = GameInfo.PlayerOptions{ID=0}().Description


Used by

bool Player:IsOption(PlayerOptionType index)
Player:SetOption(PlayerOptionType index, bool newValue)



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.