Lua and UI Reference (Civ5)

The old version of this page is available here: Lua and UI Reference (old version).

Lua

• Specificities of the Lua implementation in Civ5
• Lua introduction for confirmed developers
• Lua introduction for Python developers
• Lua reference
• Lua manual

Articles and tutorials

See also Modding Tutorials.

Civ5 API FAQ Civ5 API Reference FAQ

Map and terrain Persisting data

Adding en entry to the DiploCorner menu UI: an introduction UI: a complete guide

API

Global Functions

Objects

Static objects	Instances	Data	Events
ContentManager Game Locale Map Matchmaking Modding Network OptionsManager Path PreGame Steam TTManager UI UIManager	Area City Deal Fractal Player Plot Team TeamTechs Unit	ArtInfo DB GameDefines GameInfo GameInfoActions GameInfoTypes	Events GameEvents LuaEvents

UI Controls

See also Common UI Properties.

Miscalleneous	Buttons	Containers	Animations
Bar Context EditBox Image Instance Label Line Meter PullDown ReplayMap ScrollBar Shuttle Slider TextureBar ToolTipType	BoxButton Button CheckBox DownButton GridButton RadioButton TextButton UpButton	Box Container Grid ScrollPanel ShowOnMouseOver Stack WorldAnchor	AlphaAnim FlipAnim ScrollAnim SlideAnim

Lua Objects

Those objects are defined in Lua files and can be used through an include statement.

AssignStartingPlots FeatureGenerator FractalWorld GameplayUtilities	GenerationalInstanceManager InstanceManager MultilayeredFractal TerrainGenerator

Structures

Those objects are regular Lua tables that only contain named fields but no methods.

ActionInfo AdvisorEventInfo CityEspionageInfo Color FileHeader IntrigueInfo	MapFileInfo MapScriptInfo MapScriptOption MapScriptOptionValue ModDependency ModInfo	MultiplayerGame OverlayInfo PopupInfo ReplayInfo ScenarioInfo SpyInfo	TaskListInfo Vector2 Vector3 Vector4 WorldBuilderMapData

Objects identifiers

Those identifiers are regular integers that identify objects.

AreaID CityID CityPlotID MapOptionID PlotID UnitID

PlayerID (Players enumeration) TeamID (Teams enumeration)

Constants identifiers

Those identifiers are regular integers associated with the constants defined in Lua enumerations.

Type	Lua Enum		Type	Lua Enum
ActionSubType	ActionSubTypes		GameType	GameTypes
ActivityType	ActivityTypes		GenericWorldAnchorType	GenericWorldAnchorTypes
AdvisorType	AdvisorTypes		InfoCornerID	InfoCornerID
ButtonPopupType	ButtonPopupTypes		InterfaceDirtyBits	InterfaceDirtyBits
ButtonState	ButtonStates		KeyEventType	KeyEvents
ChatTargetType	ChatTargetTypes		KeyType	Keys
CityAIFocusType	CityAIFocusTypes		LeaderAnimationType	LeaderheadAnimationTypes
CityUpdateType	CityUpdateTypes		MajorCivApproachType	MajorCivApproachTypes
CombatPredictionType	CombatPredictionTypes		MinorCivPersonalityType	MinorCivPersonalityTypes
CommandType	CommandTypes		MinorCivQuestType	MinorCivQuestTypes
ContentType	ContentType		MouseEventType	MouseEvents
ControlType	ControlTypes		MouseType	Mouse
CoopWarState	CoopWarStates		NetError	NetErrors
DiploUIEventType	FromUIDiploEventTypes		NetKicked	NetKicked
DiploUIStateType	DiploUIStateTypes		OrderType	OrderTypes
DirectionType	DirectionTypes		PlotType	PlotTypes
DisputeLevelType	DisputeLevelTypes		PopupPriority	PopupPriority
EndGameType	EndGameTypes		ResourceUsageType	ResourceUsageTypes
EndTurnBlockingType	EndTurnBlockingTypes		SlotClaim	SlotClaim
FaithPurchaseType	FaithPurchaseTypes		SlotStatus	SlotStatus
FlowDirectionType	FlowDirectionTypes		SystemUpdateUIType	SystemUpdateUIType
FogOfWarModeType	FogOfWarModeTypes		TaskType	TaskTypes
GameMessageType	GameMessageTypes		ThreatType	ThreatTypes
GameOptionType	GameOptionTypes		TradeableItemType	TradeableItems
GameplayStateType	GameplayGameStateTypes		YieldDisplayType	YieldDisplayTypes
GameStateType	GameStateTypes

Data identifiers

Those identifiers are regular integers that identify the data rows defined in the XML data files.

Type	Xml Table	Lua Enum
ActionType	Commands
ArtStyleType	ArtStyleTypes
AutomateType	Automates
BeliefType	Beliefs	BeliefTypes
BuildActionType	Builds
BuildingClassType	BuildingClasses
BuildingType	Buildings
CalendarType	Calendars
CivilizationType	Civilizations
ClimateType	Climates
ColorType	Colors
DiploResponseType	Diplomacy_Responses
DomainType	Domains	DomainTypes
EraType	Eras
FeatureType	Features	FeatureTypes
FlavorType	Flavors
GameSpeedType	GameSpeeds
GoodyType	GoodyHuts
HandicapType	HandicapInfos
HurryType	HurryInfos
ImprovementType	Improvements
InterfaceMode	InterfaceModes	InterfaceModeTypes
InvisibilityScopeType	InvisibleInfos
LeaderType	Civilization_Leaders
MinorCivTraitType	MinorCivTraits	MinorCivTraitTypes
MissionType	Missions	MissionTypes
MultiOptionType	MultiplayerOptions
NotificationType	Notifications	NotificationTypes
PlayerOptionType	PlayerOptions
PolicyBranchType	PolicyBranchTypes	PolicyBranchTypes
PolicyType	Policies
ProcessType	Processes
ProjectType	Projects
PromotionType	UnitPromotions
ReligionType	Religions	ReligionTypes
ReplayMessageType	ReplayDataSets
ResourceType	Resources
RouteType	Routes
SpecialistType	Specialists
SpecialUnitType	SpecialUnits
TechType	Technologies
TerrainType	Terrains	TerrainTypes
UnitAIType	UnitAIInfos
UnitClassType	UnitClasses
UnitCombatType	UnitCombatInfos
UnitType	Units
VictoryType	Victories
VoteSourceType	VoteSources
VoteType	Votes
YieldType	Yields	YieldTypes

Categories

Civ5 API

Civ5 Types

Civ5 Methods and Functions

Civ5 Thematic Categories: Terrain

Civ5 Features & Natural wonders API

Civ5 Fog API

Civ5 Goodies API

Civ5 Improvements API

Civ5 Resources API

Civ5 Rivers API

Civ5 Terrain API

Civ5 Terrain Ownership API

Civ5 Yields API

Civ5 Thematic Categories: Development

Civ5 Buildings API

Civ5 Cities API

Civ5 City Production API

Civ5 Culture API

Civ5 Food & Population API

Civ5 Gold API

Civ5 Golden Age API

Civ5 Great People API

Civ5 Happiness API

Civ5 Policies API

Civ5 Religion API

Civ5 Science API

Civ5 Specialists API

Civ5 Thematic Categories: Units

Civ5 Barbarians API

Civ5 Combat API

Civ5 Movement API

Civ5 Unit Experience API

Civ5 Units API

Civ5 Thematic Categories: Diplomacy

Civ5 City States API

Civ5 Diplomacy API

Civ5 Espionnage API

Civ5 Players API

Civ5 Trade API

Civ5 United Nations API

Civ5 Thematic Categories: General

Civ5 Game Settings API

Civ5 Notification API

Civ5 Score API

Civ5 Turns API

Civ5 Victory API

Contributing

• Contributors guide to the Civ5 API
• Category:Civ5 API Templates
• Category:Civ5 API Images

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.