Home › Engine Lua tables › ForgeUI control types › ControlBase

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.

ControlBase

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

Method	C++ signature printed by the exe	Lua signature	Owner basis
`AddChildAtIndex`	`void AddChildAtIndex( ControlBase*, int )`	`ControlBase:AddChildAtIndex(arg1: ControlBase, arg2: integer)`	unique method name
`BranchResetAnimation`	`void BranchResetAnimation( void )`	`ControlBase:BranchResetAnimation()`	unique method name
`CalculateVisibilityBox`	`void CalculateVisibilityBox( void )`	`ControlBase:CalculateVisibilityBox()`	unique method name
`ChangeParent`	`void ChangeParent( ControlBase* )`	`ControlBase:ChangeParent(arg1: ControlBase)`	unique method name
`ClearMouseEnterCallback`	`void ClearMouseEnterCallback( void )`	`ControlBase:ClearMouseEnterCallback()`	unique method name
`ClearMouseExitCallback`	`void ClearMouseExitCallback( void )`	`ControlBase:ClearMouseExitCallback()`	unique method name
`ClearMouseOverCallback`	`void ClearMouseOverCallback( void )`	`ControlBase:ClearMouseOverCallback()`	unique method name
`ClearSizeChangedCallback`	`void ClearSizeChangedCallback( void )`	`ControlBase:ClearSizeChangedCallback()`	unique method name
`ClearToolTipCallback`	`void ClearToolTipCallback( void )`	`ControlBase:ClearToolTipCallback()`	unique method name
`ClearWhenHiddenCallback`	`void ClearWhenHiddenCallback( void )`	`ControlBase:ClearWhenHiddenCallback()`	unique method name
`ClearWhenShownCallback`	`void ClearWhenShownCallback( void )`	`ControlBase:ClearWhenShownCallback()`	unique method name
`DestroyAllChildren`	`void DestroyAllChildren( void )`	`ControlBase:DestroyAllChildren()`	unique method name
`DestroyChild`	`void DestroyChild( ControlBase* )`	`ControlBase:DestroyChild(arg1: ControlBase)`	unique method name
`DisableDebugOutline`	`void DisableDebugOutline( void )`	`ControlBase:DisableDebugOutline()`	unique method name
`DoAutoSize`	—	`ControlBase:DoAutoSize(...)`	unique method name
`EnableDebugOutline`	`void EnableDebugOutline( void )`	`ControlBase:EnableDebugOutline()`	unique method name
`EnableToolTip`	`void EnableToolTip( bool )`	`ControlBase:EnableToolTip(arg1: boolean)`	unique method name
`EnableTooltipAtPos`	`void EnableTooltipAtPos( bool, float, float )`	`ControlBase:EnableTooltipAtPos(arg1: boolean, arg2: number, arg3: number)`	unique method name
`GamepadEnableTooltips`	`void GamepadEnableTooltips( bool, bool, bool, int, int )`	`ControlBase:GamepadEnableTooltips(arg1: boolean, arg2: boolean, arg3: boolean, arg4: integer, arg5: integer)`	unique method name
`GamepadUpdateTooltips`	`void GamepadUpdateTooltips( void )`	`ControlBase:GamepadUpdateTooltips()`	unique method name
`GetAlpha`	—	`ControlBase:GetAlpha()`	unique method name
`GetAnchor`	—	`ControlBase:GetAnchor()`	unique method name
`GetChildren`	—	`ControlBase:GetChildren()`	unique method name
`GetConsumeMouseButton`	`bool GetConsumeMouseButton( void ) const`	`ControlBase:GetConsumeMouseButton() -> boolean`	unique method name
`GetConsumeMouseOver`	`bool GetConsumeMouseOver( void ) const`	`ControlBase:GetConsumeMouseOver() -> boolean`	unique method name
`GetConsumeMouseWheel`	`bool GetConsumeMouseWheel( void ) const`	`ControlBase:GetConsumeMouseWheel() -> boolean`	unique method name
`GetContext`	—	`ControlBase:GetContext()`	unique method name
`GetID`	`const char* GetID( void ) const`	`ControlBase:GetID() -> string`	neighbouring methods in the code
`GetNumChildren`	`int GetNumChildren( void ) const`	`ControlBase:GetNumChildren() -> integer`	unique method name
`GetOffsetVal`	—	`ControlBase:GetOffsetVal()`	unique method name
`GetOffsetX`	`float GetOffsetX( void ) const`	`ControlBase:GetOffsetX() -> number`	unique method name
`GetOffsetY`	`float GetOffsetY( void ) const`	`ControlBase:GetOffsetY() -> number`	unique method name
`GetParent`	—	`ControlBase:GetParent()`	unique method name
`GetParentByID`	—	`ControlBase:GetParentByID()`	unique method name
`GetParentByType`	—	`ControlBase:GetParentByType()`	unique method name
`GetParentRelativeOffset`	—	`ControlBase:GetParentRelativeOffset()`	unique method name
`GetParentRelativeSizeVal`	—	`ControlBase:GetParentRelativeSizeVal()`	unique method name
`GetParentRelativeSizeX`	`float GetParentRelativeSizeX( void ) const`	`ControlBase:GetParentRelativeSizeX() -> number`	unique method name
`GetParentRelativeSizeY`	`float GetParentRelativeSizeY( void ) const`	`ControlBase:GetParentRelativeSizeY() -> number`	unique method name
`GetPath`	—	`ControlBase:GetPath()`	unique method name
`GetScreenOffset`	—	`ControlBase:GetScreenOffset()`	unique method name
`GetSize`	`FGXVector2 GetSize( void ) const`	`ControlBase:GetSize() -> FGXVector2`	unique method name
`GetSizeVal`	—	`ControlBase:GetSizeVal()`	unique method name
`GetSizeX`	`float GetSizeX( void ) const`	`ControlBase:GetSizeX() -> number`	unique method name
`GetSizeY`	`float GetSizeY( void ) const`	`ControlBase:GetSizeY() -> number`	unique method name
`GetTag`	`uint GetTag( void ) const`	`ControlBase:GetTag() -> integer`	unique method name
`GetToolTipString`	`const char* GetToolTipString( void ) const`	`ControlBase:GetToolTipString() -> string`	unique method name
`GetType`	—	`ControlBase:GetType()`	neighbouring methods in the code
`HasMouseOver`	`bool HasMouseOver( void ) const`	`ControlBase:HasMouseOver() -> boolean`	unique method name
`IsDisabled`	`bool IsDisabled( void ) const`	`ControlBase:IsDisabled() -> boolean`	unique method name
`IsEnabled`	`bool IsEnabled( void ) const`	`ControlBase:IsEnabled() -> boolean`	unique method name
`IsHidden`	`bool IsHidden( void ) const`	`ControlBase:IsHidden() -> boolean`	neighbouring methods in the code
`IsModal`	`bool IsModal( void ) const`	`ControlBase:IsModal() -> boolean`	neighbouring methods in the code
`IsToolTipEnabled`	`bool IsToolTipEnabled( void ) const`	`ControlBase:IsToolTipEnabled() -> boolean`	unique method name
`IsUsingHighlightShader`	`bool IsUsingHighlightShader( void ) const`	`ControlBase:IsUsingHighlightShader() -> boolean`	unique method name
`IsVisible`	`bool IsVisible( void ) const`	`ControlBase:IsVisible() -> boolean`	neighbouring methods in the code
`LastHitOffset`	—	`ControlBase:LastHitOffset()`	unique method name
`LocalizeAndSetToolTip`	—	`ControlBase:LocalizeAndSetToolTip()`	unique method name
`RegisterMouseEnterCallback`	`void RegisterMouseEnterCallback( function )`	`ControlBase:RegisterMouseEnterCallback(arg1: function)`	unique method name
`RegisterMouseExitCallback`	`void RegisterMouseExitCallback( function )`	`ControlBase:RegisterMouseExitCallback(arg1: function)`	unique method name
`RegisterMouseOverCallback`	`void RegisterMouseOverCallback( function )`	`ControlBase:RegisterMouseOverCallback(arg1: function)`	unique method name
`RegisterSizeChanged`	`void RegisterSizeChanged( function )`	`ControlBase:RegisterSizeChanged(arg1: function)`	unique method name
`RegisterWhenHidden`	`void RegisterWhenHidden( function )`	`ControlBase:RegisterWhenHidden(arg1: function)`	unique method name
`RegisterWhenShown`	`void RegisterWhenShown( function )`	`ControlBase:RegisterWhenShown(arg1: function)`	unique method name
`ReleaseChild`	`void ReleaseChild( ControlBase* )`	`ControlBase:ReleaseChild(arg1: ControlBase)`	unique method name
`Reparent`	`void Reparent( void )`	`ControlBase:Reparent()`	unique method name
`ReprocessAnchoring`	—	`ControlBase:ReprocessAnchoring(...)`	neighbouring methods in the code
`ReprocessAnchoring`	—	`ControlBase:ReprocessAnchoring(...)`	neighbouring methods in the code
`SetAllChildrenVisible`	`void SetAllChildrenVisible( bool )`	`ControlBase:SetAllChildrenVisible(arg1: boolean)`	unique method name
`SetAlpha`	`void SetAlpha( float )`	`ControlBase:SetAlpha(arg1: number)`	unique method name
`SetAnchor`	`void SetAnchor( const char* )`	`ControlBase:SetAnchor(arg1: string)`	unique method name
`SetAutoSize`	—	`ControlBase:SetAutoSize()`	unique method name
`SetButtonHighlightColor`	—	`ControlBase:SetButtonHighlightColor()`	unique method name
`SetColor`	—	`ControlBase:SetColor()`	neighbouring methods in the code
`SetColorByName`	—	`ControlBase:SetColorByName()`	neighbouring methods in the code
`SetConsumeMouseButton`	`void SetConsumeMouseButton( bool )`	`ControlBase:SetConsumeMouseButton(arg1: boolean)`	unique method name
`SetConsumeMouseOver`	`void SetConsumeMouseOver( bool )`	`ControlBase:SetConsumeMouseOver(arg1: boolean)`	unique method name
`SetConsumeMouseWheel`	`void SetConsumeMouseWheel( bool )`	`ControlBase:SetConsumeMouseWheel(arg1: boolean)`	unique method name
`SetDisabled`	`void SetDisabled( bool )`	`ControlBase:SetDisabled(arg1: boolean)`	neighbouring methods in the code
`SetEnabled`	`void SetEnabled( bool )`	`ControlBase:SetEnabled(arg1: boolean)`	unique method name
`SetHide`	`void SetHide( bool )`	`ControlBase:SetHide(arg1: boolean)`	neighbouring methods in the code
`SetID`	`void SetID( const char* )`	`ControlBase:SetID(arg1: string)`	unique method name
`SetModal`	`void SetModal( bool )`	`ControlBase:SetModal(arg1: boolean)`	unique method name
`SetNoClip`	`void SetNoClip( bool )`	`ControlBase:SetNoClip(arg1: boolean)`	unique method name
`SetOffset`	`void SetOffset( FGXVector2 )`	`ControlBase:SetOffset(arg1: FGXVector2)`	unique method name
`SetOffsetVal`	`void SetOffsetVal( float, float )`	`ControlBase:SetOffsetVal(arg1: number, arg2: number)`	unique method name
`SetOffsetX`	`void SetOffsetX( float )`	`ControlBase:SetOffsetX(arg1: number)`	unique method name
`SetOffsetY`	`void SetOffsetY( float )`	`ControlBase:SetOffsetY(arg1: number)`	unique method name
`SetParentRelativeSize`	`void SetParentRelativeSize( FGXVector2 )`	`ControlBase:SetParentRelativeSize(arg1: FGXVector2)`	unique method name
`SetParentRelativeSizeVal`	`void SetParentRelativeSizeVal( float, float )`	`ControlBase:SetParentRelativeSizeVal(arg1: number, arg2: number)`	unique method name
`SetParentRelativeSizeX`	`void SetParentRelativeSizeX( float )`	`ControlBase:SetParentRelativeSizeX(arg1: number)`	unique method name
`SetParentRelativeSizeY`	`void SetParentRelativeSizeY( float )`	`ControlBase:SetParentRelativeSizeY(arg1: number)`	unique method name
`SetShow`	`void SetShow( bool )`	`ControlBase:SetShow(arg1: boolean)`	unique method name
`SetShowOnMouseOut`	`void SetShowOnMouseOut( bool )`	`ControlBase:SetShowOnMouseOut(arg1: boolean)`	unique method name
`SetShowOnMouseOver`	`void SetShowOnMouseOver( bool )`	`ControlBase:SetShowOnMouseOver(arg1: boolean)`	unique method name
`SetSize`	`void SetSize( FGXVector2 )`	`ControlBase:SetSize(arg1: FGXVector2)`	neighbouring methods in the code
`SetSizeVal`	`void SetSizeVal( float, float )`	`ControlBase:SetSizeVal(arg1: number, arg2: number)`	neighbouring methods in the code
`SetSizeX`	`void SetSizeX( float )`	`ControlBase:SetSizeX(arg1: number)`	unique method name
`SetSizeY`	`void SetSizeY( float )`	`ControlBase:SetSizeY(arg1: number)`	unique method name
`SetTag`	`void SetTag( uint )`	`ControlBase:SetTag(arg1: integer)`	unique method name
`SetToolTipCallback`	`void SetToolTipCallback( function )`	`ControlBase:SetToolTipCallback(arg1: function)`	unique method name
`SetToolTipString`	—	`ControlBase:SetToolTipString()`	neighbouring methods in the code
`SetToolTipType`	—	`ControlBase:SetToolTipType()`	neighbouring methods in the code
`SetUseHighlightShader`	`void SetUseHighlightShader( bool )`	`ControlBase:SetUseHighlightShader(arg1: boolean)`	unique method name
`SortChildren`	`void SortChildren( function )`	`ControlBase:SortChildren(arg1: function)`	unique method name
`ToButtonControl`	`ButtonControl* ToButtonControl( void )`	`ControlBase:ToButtonControl() -> ButtonControl`	unique method name
`ToControlBase`	`ControlBase* ToControlBase( void )`	`ControlBase:ToControlBase() -> ControlBase`	unique method name