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

New Properties

AutoSize

Format: Unknown.

Usage: Unknown.

CSize

Format: Unknown.

Usage: Unknown.

CTexStart

Format: Unknown.

Usage: Unknown.

LCSize

Format: Unknown.

Usage: Unknown.

LCTexStart

Format: Unknown.

Usage: Unknown.

LLSize

Format: Unknown.

Usage: Unknown.

LLTexStart

Format: Unknown.

Usage: Unknown.

LRSize

Format: Unknown.

Usage: Unknown.

LRTexStart

Format: Unknown.

Usage: Unknown.

LSize

Format: Unknown.

Usage: Unknown.

LTexStart

Format: Unknown.

Usage: Unknown.

NoStateChange

Format: Unknown.

Usage: Unknown.

Padding

Format: Unknown.

Usage: Unknown.

RSize

Format: Unknown.

Usage: Unknown.

RTexStart

Format: Unknown.

Usage: Unknown.

StateOffsetIncrement

Format: Unknown.

Usage: Unknown.

Texture

Format: Unknown.

Usage: Unknown.

UC

Format: Unknown.

Usage: Unknown.

UCSize

Format: Unknown.

Usage: Unknown.

UCTexStart

Format: Unknown.

Usage: Unknown.

UL

Format: Unknown.

Usage: Unknown.

ULSize

Format: Unknown.

Usage: Unknown.

ULTexStart

Format: Unknown.

Usage: Unknown.

URSize

Format: Unknown.

Usage: Unknown.

URTexStart

Format: Unknown.

Usage: Unknown.

New Instance Methods

Methods are functions that belong to an object. Instance methods are invoked through a colon, as in caller:SomeMethod(<args>), where caller is an instance of Grid.
A colon implictly passes the caller object as the first argument. That is, the former call is equivalent to this one: caller.SomeMethod(caller, <args>)

				`___________________________`
					`SetVoid2(ProcessType process)`
					`SetVoids(ResourceType building, ResourceType addToList)`
					`DoAutoSize()`
					`SetTextureOffset(Vector2 questionOffset)`
					`RegisterCallback(MouseType OnSearchTextEnter, (void func(PolicyBranchType policyBranchIndex, UnitType y, Button button)) OnClose = nil)`
					`SetText(string localizedString)`
					`SetVoid1(OrderType MAINTAIN_GOLD)`

Inherited from ControlBase

XML Properties: none.

				`___________________________`
					`BuildEntry(string arg0, table arg1)`
					`CalculateInternals()`
					`CalculateInternalSize()`
					`CalculateSize()`
					`ClearEntries()`
				`Button`	`GetButton()`
					`RegisterCheckHandler((void func(bool bIsChecked)) OnPolicyInfo)`
					`RegisterSelectionCallback((void func(FaithPurchaseType v1, int v2)) OnChatTarget)`
					`SetCheck(bool cityBanners)`
					`SetPercent(int percentDone)`
					`SetPercents(float productionProgressPercent, float productionProgressPlusThisTurnPercent)`
					`SetScrollValue(int arg0)`
					`SetTexture(string textureName)`
					`SetTextureOffsetVal(int arg0, int offset)`
					`UnloadTexture()`
					`SetVoid2(ProcessType process)`
					`SetVoids(ResourceType building, ResourceType addToList)`
				`string`	`GetText()`
					`LocalizeAndSetText(string name, int searchString = nil, string minFaithForProphet = nil, unknown arg3, unknown arg4, unknown arg5, unknown arg6, unknown arg7, unknown arg8, string arg9, unknown arg10, unknown arg11)`
					`RegisterCallback(MouseType OnSearchTextEnter, (void func(PolicyBranchType policyBranchIndex, UnitType y, Button button)) OnClose = nil)`
					`SetText(string localizedString)`
					`SetVoid1(OrderType MAINTAIN_GOLD)`

Common

XML Properties: IDDisabled

				`___________________________`
					`ChangeParent(Image parent)`
					`DestroyAllChildren()`
				`string`	`GetID()`
					`GetNumChildren`
					`IsDisabled`
					`ReleaseChild(WorldAnchor arg0)`
					`SetDisabled(bool disableBanners)`
					`SortChildren((void func(unknown a, unknown b)) SortFunction)`

Layout

XML Properties: SizeOffsetAnchorAnchorSide

				`___________________________`
				`unknown, int`	`GetOffsetVal()`
				`int`	`GetOffsetX()`
				`int`	`GetOffsetY()`
				`Vector2`	`GetSize()`
				`int, int`	`GetSizeVal()`
				`int`	`GetSizeX()`
				`int`	`GetSizeY()`
					`ReprocessAnchoring()`
					`SetAnchor(string arg0)`
					`SetOffset(Vector2 offset)`
					`SetOffsetVal(int xOffset, int yOffset)`
					`SetOffsetX(int xOffset)`
					`SetOffsetY(int TOP_COMPENSATION)`
					`SetSize(table blockSize)`
					`SetSizeVal(int baseWidth, int newHeight)`
					`SetSizeX(int width)`
					`SetSizeY(int newSizeY)`

Appearance

XML Properties: HiddenStyleNoClipColorBranchAlpha

				`___________________________`
					`BranchResetAnimation()`
					`CalculateVisibilityBox`
				`int`	`IsHidden()`
					`SetAlpha(float DimAlpha)`
					`SetColor(table fadeColor, int arg1)`
					`SetColorByName(string colorSet)`
					`SetColorChannel(int arg0, float arg1)`
					`SetColorVal(int arg0, int arg1 = nil, int arg2 = nil, int arg3 = nil)`
					`SetHide(int disablePolicies)`
					`SetNoClip`

Interaction

XML Properties: NeedsMouseOverConsumeMouseConsumeMouseOverConsumeMouseWheelConsumeMouseButton

				`___________________________`
					`GetConsumeMouseButton`
					`GetConsumeMouseOver`
					`GetConsumeMouseWheel`
				`bool`	`HasMouseOver()`
					`SetConsumeMouseButton`
					`SetConsumeMouseOver(bool arg0)`
					`SetConsumeMouseWheel`

Tool Tip

XML Properties: ToolTipToolTipType

				`___________________________`
					`EnableToolTip(bool arg0)`
					`GetToolTipString`
					`IsToolTipEnabled`
					`LocalizeAndSetToolTip(string description, string minFaithForProphet = nil, string threshold, string moodText, string spyRank, string spyName, string spyRank, string spyName, unknown arg8, unknown arg9, string arg10, unknown arg11, unknown arg12)`
					`SetToolTipCallback((void func(Slider control)) TipHandler)`
					`SetToolTipString(string foodToolTip)`
					`SetToolTipType(string arg0)`

Source code samples

Too many occurences. Only 10 out of 2013 are listed.

ActionInfoPanel.xml

UI/InGame/WorldView/ActionInfoPanel.xml


`0017`	<Grid Size="320,36" Anchor="C,C" Offset="0,0" Style="Grid9Production8" />

Advisors.xml

UI/InGame/WorldView/Advisors.xml


`0081`	<Grid Size="168,28" Anchor="R,T" AnchorSide="O.I" Offset="12,186" Style="Grid9BlackTint8" Hidden="1" >

CityStateDiploPopup.xml

UI/InGame/Popups/CityStateDiploPopup.xml


`0006`	<Grid Size="560,670" Anchor="C,C" Offset="0,100" Padding="0,0" Style="Grid9DetailFive140" ConsumeMouse="1">

CivilopediaScreen.xml

UI/Civilopedia/CivilopediaScreen.xml


`0681`	<Grid Anchor="R,T" Offset="0,24" Size="436,200" Padding="0,0" Style="GridBlackIndent8" Hidden="0" ID="HistoryFrame">

`0852`	<Grid Anchor="L,T" Offset="0,24" Size="204,36" Padding="0,0" Style="GridBlackIndent8" Hidden="0" ID="ProductionFrame">

Demographics.xml

UI/InGame/Popups/Demographics.xml


`0042`	<Grid Anchor="L,T" Offset="0,0" Style="WindowGrid" Size="956,24" >

DiploList.xml (G&K)

DLC/Expansion/UI/InGame/DiploList.xml


`0050`	<Grid Anchor="C,C" Size="478,27" Offset="0,0" Padding="0,0" Style="Grid9FrameTurns"/>

DiploRelationships.xml (G&K)

DLC/Expansion/UI/InGame/Popups/DiploRelationships.xml


`0051`	<Grid Size="420,50" Offset="0,0" Padding="0,0" Style="Grid9FrameTurnsHL" ID="LeaderButtonHL"/>

OptionsMenu.xml

UI/Options/OptionsMenu.xml


`0053`	<Grid Anchor="C,C" Offset="0,0" Size="233,26" Style="Grid9FrameTurns" Hidden="1" ID="IFaceHighlight" />

UnitFlagManager.xml

UI/InGame/UnitFlagManager.xml


`0059`	<Grid Anchor="C,C" Size="40,22" Offset="0,0" Padding="0,0" Style="Grid9FrameTurns" />

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.

Grid (Civ5 Type)

Contents

New Properties

New Instance Methods

Inherited from ControlBase

Common

Layout

Appearance

Interaction

Tool Tip

Source code samples

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools