CheckBox (Civ5 Type)
This page is a part of the Lua and UI Reference (Civ5).
New Properties
ButtonTexture
- Format: Unknown.
- Usage: Unknown.
CheckTexture
- Format: Unknown.
- Usage: Unknown.
ColorLayer0
- Format: Unknown.
- Usage: Unknown.
ColorLayer1
- Format: Unknown.
- Usage: Unknown.
IsChecked
- Format: Unknown.
- Usage: Unknown.
NoStateChange
- Format: Unknown.
- Usage: Unknown.
RadioGroup
- Format: Unknown.
- Usage: Unknown.
TextAnchor
- Format: Unknown.
- Usage: Unknown.
TextAnchorSide
- Format: Unknown.
- Usage: Unknown.
TextOffset
- Format: Unknown.
- Usage: Unknown.
Texture
- 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 CheckBox.
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>)
 |
 |
||||
|
|
Button
|
GetTextButton()
| ||
|
|
|
int
|
IsChecked()
|
Inherited from ButtonBase
|
|
||||
|
|
|
|
ClearCallback(MouseType arg0)
| ||
|
|
|
IsTrackingMiddleMouseButton
| ||
|
|
|
|
IsTrackingRightMouseButton
| ||
|
|
|
|
SetVoid2(ProcessType process)
| ||
|
|
|
|
SetVoids(ResourceType building, ResourceType addToList)
| ||
|
|
|
ActionType
|
GetVoid1()
| ||
|
|
|
ResourceType
|
GetVoid2()
| ||
|
|
|
bool
|
IsTrackingLeftMouseButton()
| ||
|
|
|
|
RegisterCallback(MouseType OnSearchTextEnter, (void func(PolicyBranchType policyBranchIndex, UnitType y, Button button)) OnClose = nil)
| ||
|
|
|
|
SetVoid1(OrderType MAINTAIN_GOLD)
|
Inherited from TextBase
XML Properties: StringFontFontStyleWrapWidthTruncateWidthReduceOnTruncateLeadingOffsetColorSetColor0Color1Color2Color3ForceIMEForceNonIME
|
|
||||
|
|
|
string
|
GetText()
| ||
|
|
|
|
SetFontByName(string arg0)
| ||
|
|
|
|
SetForceIME
| ||
|
|
|
|
SetForceNonIME
| ||
|
|
|
|
SetString(unknown arg0)
| ||
|
|
|
|
SetTruncateWidth(int width)
| ||
|
|
|
|
SetWrapWidth(PlayerID arg0)
| ||
|
|
|
|
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)
| ||
|
|
|
|
SetText(string localizedString)
|
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
|
|
||||
|
|
|
|
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 143 are listed.
DebugMode.xml
UI/InGame/DebugMode.xml
0208
|
<CheckBox Anchor="L,C" ID="UnitSpecRenderDiffuse_Checkbox" Void1="1"/> |
GraphicsPanel.xml
UI/InGame/GraphicsPanel.xml
0007
|
<CheckBox String="Terrain" Anchor="R,C" TextAnchor="R,C" ID="TerrainToggle" Void2="1" IsChecked="1"/> |
0009
|
<CheckBox String="Cities" Anchor="R,C" TextAnchor="R,C" ID="CityToggle" Void2="3" IsChecked="1"/> |
InstalledPanel.xml
UI/FrontEnd/Modding/InstalledPanel.xml
0214
|
<CheckBox ButtonTexture="assets/UI/Art/Controls/CheckBox2TheBox.dds" TextAnchorSide="Right" Font="TwCenMT20" TextOffset="40,0" IsChecked="0" ID="ShowDLCMods" String="TXT_KEYMODDING_SHOWDLCMODS" ConsumeMouse="1" /> |
MiniMapPanel.xml
UI/InGame/WorldView/MiniMapPanel.xml
0039
|
<CheckBox Anchor="L,T" TextAnchorSide="Right" Offset="0,0" TextOffset="40,0" IsChecked="0" ID="ShowResources" String="TXT_KEY_MAP_OPTIONS_RESOURCE_ICONS" /> |
OptionsMenu.xml
UI/Options/OptionsMenu.xml
0101
|
<CheckBox String="TXT_KEY_OPSCREEN_SPLAYER_QUICK_COMBAT" LeadingOffset="-10" WrapWidth="350" Anchor="R,C" ID="SPQuickCombatCheckBox" ToolTip="TXT_KEY_OPSCREEN_SPLAYER_QUICK_COMBAT_TT" /> |
0113
|
<CheckBox String="TXT_KEY_OPSCREEN_CIVILIAN_YIELDS" LeadingOffset="-10" WrapWidth="350" Anchor="R,C" ID="CivilianYieldsCheckbox" ToolTip="TXT_KEY_OPSCREEN_CIVILIAN_YIELDS_TT" /> |
0150
|
<CheckBox Anchor="R,C" String="TXT_KEY_OPSCREEN_AUTOSIZE_UI" IsChecked="1" ID="AutoUIAssetsCheck" ToolTip="TXT_KEY_OPSCREEN_AUTOSIZE_UI_TT" /> |
ReplayViewer.xml
UI/InGame/Popups/ReplayViewer.xml
0039
|
<CheckBox ButtonTexture="assets/UI/Art/Controls/CheckBox.dds" Anchor="R,C" Offset="5,0" TextOffset="40,0" IsChecked="1" ID="ShowHide" ConsumeMouse="1" /> |
StagingRoom.xml
UI/FrontEnd/Multiplayer/StagingRoom.xml
0079
|
<CheckBox Anchor="R,T" Offset="6,3" ID="EnableCheck" ToolTip="TXT_KEY_MP_DISABLE_SLOT" /> |
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.
