Home › Engine Lua tables › ForgeUI control types › ButtonControlBase

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.

ButtonControlBase

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

C++ base classes (from the exe RTTI, see engine classes): 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
`ClearCallback`	—	`ButtonControlBase:ClearCallback()`	neighbouring methods in the code
`DoLeftClick`	`void DoLeftClick( void )`	`ButtonControlBase:DoLeftClick()`	unique method name
`ForceSetFocus`	`void ForceSetFocus( void )`	`ButtonControlBase:ForceSetFocus()`	unique method name
`GetVoid1`	`int GetVoid1( void ) const`	`ButtonControlBase:GetVoid1() -> integer`	neighbouring methods in the code
`GetVoid2`	`int GetVoid2( void ) const`	`ButtonControlBase:GetVoid2() -> integer`	neighbouring methods in the code
`GrantedMouseOver`	`void GrantedMouseOver( void )`	`ButtonControlBase:GrantedMouseOver()`	unique method name
`HasTouchOver`	`bool HasTouchOver( void )`	`ButtonControlBase:HasTouchOver() -> boolean`	unique method name
`IsSelected`	`bool IsSelected( void )`	`ButtonControlBase:IsSelected() -> boolean`	unique method name
`IsTrackingLeftMouseButton`	`bool IsTrackingLeftMouseButton( void )`	`ButtonControlBase:IsTrackingLeftMouseButton() -> boolean`	unique method name
`IsTrackingMiddleMouseButton`	`bool IsTrackingMiddleMouseButton( void )`	`ButtonControlBase:IsTrackingMiddleMouseButton() -> boolean`	unique method name
`IsTrackingRightMouseButton`	`bool IsTrackingRightMouseButton( void )`	`ButtonControlBase:IsTrackingRightMouseButton() -> boolean`	unique method name
`IsTrackingTouch`	`bool IsTrackingTouch( void )`	`ButtonControlBase:IsTrackingTouch() -> boolean`	unique method name
`LostMouseOver`	`void LostMouseOver( void )`	`ButtonControlBase:LostMouseOver()`	unique method name
`ReceiveCallbacksIfDisabled`	`void ReceiveCallbacksIfDisabled( bool )`	`ButtonControlBase:ReceiveCallbacksIfDisabled(arg1: boolean)`	unique method name
`RegisterCallback`	—	`ButtonControlBase:RegisterCallback()`	neighbouring methods in the code
`SetFocus`	`void SetFocus( void )`	`ButtonControlBase:SetFocus()`	unique method name
`SetSelected`	`void SetSelected( bool )`	`ButtonControlBase:SetSelected(arg1: boolean)`	unique method name
`SetVisState`	—	`ButtonControlBase:SetVisState()`	unique method name
`SetVoid1`	`void SetVoid1( int )`	`ButtonControlBase:SetVoid1(arg1: integer)`	neighbouring methods in the code
`SetVoid2`	`void SetVoid2( int )`	`ButtonControlBase:SetVoid2(arg1: integer)`	neighbouring methods in the code
`SetVoids`	`void SetVoids( int, int )`	`ButtonControlBase:SetVoids(arg1: integer, arg2: integer)`	neighbouring methods in the code
`UnFocus`	`void UnFocus( void )`	`ButtonControlBase:UnFocus()`	unique method name