User:DonQuich: Difference between revisions

From Civilization Modding Wiki
Jump to navigationJump to search
m (testing my bot)
mNo edit summary
 
(58 intermediate revisions by the same user not shown)
Line 1: Line 1:
''This page is a part of the [[Lua and UI Reference]].''
Developer of the bot that generated the initial versions of the [[Lua and UI Reference (Civ5)]] on mid-2012.


Parameters flagged with this pseudo-type are actually '''integers'''. <br/>
CivFanatics profile: [http://forums.civfanatics.com/member.php?u=210491 DonQuiche]
Pseudo-types do not exist in LUA, they only serve a documentation purpose on the wiki.<br/>
Integers labeled as 'TerrainID' corresponds to the 'ID' column of the [[Civ5Terrains]] XML table.<br/>
The values in the 'ID' and 'Type' columns are also dynamically stored on startup in the '''TerrainTypes''' LUA enumeration.<br/>




==TerrainTypes enumeration ==
== Mods ==
A LUA enumeration is a just a regular table. <br/>
* [http://forums.civfanatics.com/showthread.php?t=436912 Ingame Editor (IGE)]
It is commonly used to store constants, the keys being the constants' names and the pairs the corresponding values.<br/>
* [http://forums.civfanatics.com/showthread.php?p=11646470 Reseed]


On startup, the game reads the [[Civ5Terrains]] data table and stores key/value pairs in the LUA enumeration. <br/>
The keys are the strings from the 'Type' column and the values are the integers from the 'ID' column.<br/>


Below are the values found in an unmodded game updated with Gods & Kings 1.0.1.705 (August 2012).
== My scratchpad: pages to salvage ==
 
* [[Lua Game Objects/NotificationTypes]]
{|
* [[SetHappiness]] - Warning and link
|-
* [[HasPolicy]] Good example for HasPolicy and [[SetHasPolicy]]
!align="left" |Key
* [[GetMinorCivType]] - Good example for player name (add it to Player.GetName?)
!
* Warning about graphics refresh on SetTerrainType
!align="left" |Value
* Warning and code snippet on SetOwner.
|-
* Events.ActivePlayerTurnStart - specify human besides of "active" - exclude AI
| "NO_TERRAIN"
* [[GameEvents.PlayerCanConstruct(playerID, buildingTypeID)]] - Example of building constructible with a policy.
|
* [[Events.SerialEventCityDestroyed (Civ5 API)]] Advise the reader to see SerialEventCityCaptured or copy/paste.
| -1
* [[Events.SpecificCityInfoDirty (Civ5 API)]] : add "Fired when something in a particular city was changed. E.g. building created/sold, specialists reallocated, and some other things. ".
|-
* [[SerialEventCityPopulationChanged]]: fixes the 2k wiki description. Also copy example.
| "TERRAIN_GRASS"
* Events.SerialEventCityCaptured: "fired when city is captured or traded to an another civ. "
|
* GameEvents.UnitGetSpecialExploreTarget(iPlayerID, iUnitID) - appears to be triggered when the 'explore' order is given, or some subset thereof. The unit structure for the relevant unit is manipulated to set the explore target.
| 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 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 [[Civ5Lua/GameInfo|GameInfo]].<pre>
local id = GameInfo.Civ5Terrains.TERRAIN_GRASS.ID
local id = GameInfo["Civ5Terrains"]["TERRAIN_GRASS"]["ID"]
local id = GameInfo.Civ5Terrains{Type="TERRAIN_GRASS"}().ID
</pre>
Alternatively you could use this ID to retrieve the value of the 'Description' column. Those examples will return and assign ''"TXT_KEY_TERRAIN_GRASS"''.<pre>
local description = GameInfo.Civ5Terrains.TERRAIN_GRASS.Description
local description = GameInfo["Civ5Terrains"]["TERRAIN_GRASS"]["Description"]
local description = GameInfo.Civ5Terrains{ID="TERRAIN_GRASS"}().Description
</pre>
Here is how to use the LUA enumeration to retrieve the ID from the 'type'. The variable 'id' will be assigned the value 9.<pre>
local id = TerrainTypes.NUM_TERRAIN_TYPES
local id = TerrainTypes["NUM_TERRAIN_TYPES"]
</pre>
 
 
==Referencing methods==
*'''void''' [[Civ5Lua/Plot|Plot]]:[[Civ5Lua/Plot/SetTerrainType|SetTerrainType]]([[Civ5Lua/TerrainID|TerrainID]] type)
 
[[Category:Civ5Lua]]

Latest revision as of 08:21, 22 September 2012

Developer of the bot that generated the initial versions of the Lua and UI Reference (Civ5) on mid-2012.

CivFanatics profile: DonQuiche


Mods


My scratchpad: pages to salvage

Retrieved from "https://modiki.civfanatics.com/index.php?title=User:DonQuich&oldid=13689"