Home › Engine Lua tables › ForgeUI control types › CheckBoxControl

Engine executable. Settings and tools of the game program (CivilizationVI.exe), usable without a mod. Mostly undocumented debug and configuration functionality; descriptions come from analysis of the executable and have not all been tried in the running game.

CheckBoxControl

ForgeUI control type (ForgeUI::CheckBoxControl). 14 methods, called on an instance with a colon: Controls.SomeName:Method(...).

C++ base classes (from the exe RTTI, see engine classes): ForgeUI::ButtonControlBase > ForgeUI::ControlBase. Whether the Lua type also exposes the base class methods was not checked; the methods below are those registered on this type itself.

Method	C++ signature printed by the exe	Lua signature	Owner basis
`GetButton`	`ButtonControl* GetButton( void )`	`CheckBoxControl:GetButton() -> ButtonControl`	neighbouring methods in the code
`GetTextButton`	`TextButtonControl* GetTextButton( void )`	`CheckBoxControl:GetTextButton() -> TextButtonControl`	unique method name
`IsChecked`	`bool IsChecked( void )`	`CheckBoxControl:IsChecked() -> boolean`	unique method name
`RegisterCheckHandler`	`void RegisterCheckHandler( function )`	`CheckBoxControl:RegisterCheckHandler(arg1: function)`	unique method name
`SetAndCall`	`void SetAndCall( bool )`	`CheckBoxControl:SetAndCall(arg1: boolean)`	neighbouring methods in the code
`SetCheck`	`void SetCheck( bool )`	`CheckBoxControl:SetCheck(arg1: boolean)`	neighbouring methods in the code
`SetCheckColor`	—	`CheckBoxControl:SetCheckColor()`	unique method name
`SetCheckTexture`	`bool SetCheckTexture( const char* )`	`CheckBoxControl:SetCheckTexture(arg1: string) -> boolean`	unique method name
`SetCheckTextureOffsetVal`	`void SetCheckTextureOffsetVal( float, float )`	`CheckBoxControl:SetCheckTextureOffsetVal(arg1: number, arg2: number)`	unique method name
`SetCheckTextureSizeVal`	`void SetCheckTextureSizeVal( float, float )`	`CheckBoxControl:SetCheckTextureSizeVal(arg1: number, arg2: number)`	unique method name
`SetUnCheckColor`	—	`CheckBoxControl:SetUnCheckColor()`	unique method name
`SetUnCheckTexture`	`bool SetUnCheckTexture( const char* )`	`CheckBoxControl:SetUnCheckTexture(arg1: string) -> boolean`	unique method name
`SetUnCheckTextureOffsetVal`	`void SetUnCheckTextureOffsetVal( float, float )`	`CheckBoxControl:SetUnCheckTextureOffsetVal(arg1: number, arg2: number)`	unique method name
`SetUnCheckTextureSizeVal`	`void SetUnCheckTextureSizeVal( float, float )`	`CheckBoxControl:SetUnCheckTextureSizeVal(arg1: number, arg2: number)`	unique method name