DomainType (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 DomainType 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 DomainType corresponds to the ID column of the Domains XML table.
  • Lua.png The standard (unmodded) values in the ID and Type columns are also stored in the DomainTypes Lua enumeration.


Lua: the DomainTypes enumeration

Firaxis provides a Lua enumeration named DomainTypes. This is just a regular global table. Its keys are the constants' names and the pairs the corresponding values.

  • This specific enumeration contains data from the Domains data table.
  • They are stored as key/value pairs: the keys are the strings from the Type column and the values are the integers from the ID column.

Radioactive.png Be careful: this enumeration do not reflect the changes, additions and deletions made by mods. As a result it is advised to rely on GameInfo instead.


Below are the values found in this enumeration.

Key Value
"NO_DOMAIN" -1
"DOMAIN_SEA" 0
"DOMAIN_AIR" 1
"DOMAIN_LAND" 2
"DOMAIN_IMMOBILE" 3
"DOMAIN_HOVER" 4
"NUM_DOMAIN_TYPES" 5


XML: the Domains table

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

ID Type
0 DOMAIN_SEA
1 DOMAIN_AIR
2 DOMAIN_LAND
3 DOMAIN_IMMOBILE
4 DOMAIN_HOVER


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 = DomainTypes.DOMAIN_SEA
local id = DomainTypes["DOMAIN_SEA"]


Used by

int City:GetDomainFreeExperience(DomainType index)
int City:GetDomainProductionModifier(DomainType index)
Team:ChangeExtraMoves(DomainType index, int change)
int Team:GetExtraMoves(DomainType index)
int Unit:CargoSpaceAvailable(SpecialUnitType specialCargo, DomainType domainCargo)
DomainType Unit:DomainCargo()
int Unit:DomainModifier(DomainType domain)
DomainType Unit:GetDomainType()
int Unit:GetExtraDomainModifier(DomainType index)



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.