Home › Engine Lua tables › ForgeUI control types › LuaContext

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.

LuaContext

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

C++ base classes (from the exe RTTI, see engine classes): ForgeUI::ContextBase > 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
`BuildInstance`	`ControlBase* BuildInstance( const char*, table )`	`LuaContext:BuildInstance(arg1: string, arg2: table) -> ControlBase`	unique method name
`BuildInstanceForControl`	`ControlBase* BuildInstanceForControl( const char, table, ControlBase )`	`LuaContext:BuildInstanceForControl(arg1: string, arg2: table, arg3: ControlBase) -> ControlBase`	unique method name
`BuildInstanceForControlAtIndex`	`ControlBase* BuildInstanceForControlAtIndex( const char, table, ControlBase, int )`	`LuaContext:BuildInstanceForControlAtIndex(arg1: string, arg2: table, arg3: ControlBase, arg4: integer) -> ControlBase`	unique method name
`CallParentShowHideHandler`	`void CallParentShowHideHandler( bool )`	`LuaContext:CallParentShowHideHandler(arg1: boolean)`	unique method name
`ClearContextParameters`	`void ClearContextParameters( void )`	`LuaContext:ClearContextParameters()`	unique method name
`ClearPopupParameters`	`void ClearPopupParameters( void )`	`LuaContext:ClearPopupParameters()`	unique method name
`ClearRefreshHandler`	`void ClearRefreshHandler( void )`	`LuaContext:ClearRefreshHandler()`	unique method name
`ClearRequestRefresh`	`void ClearRequestRefresh( void )`	`LuaContext:ClearRequestRefresh()`	unique method name
`ClearUpdate`	`void ClearUpdate( void )`	`LuaContext:ClearUpdate()`	unique method name
`ClearUpdateGamepad`	`void ClearUpdateGamepad( void )`	`LuaContext:ClearUpdateGamepad()`	unique method name
`GetBaseFileName`	—	`LuaContext:GetBaseFileName()`	neighbouring methods in the code
`GetContextParameters`	—	`LuaContext:GetContextParameters()`	unique method name
`GetLuaFileName`	—	`LuaContext:GetLuaFileName()`	unique method name
`GetPopupParameters`	—	`LuaContext:GetPopupParameters()`	unique method name
`IsHotLoad`	`bool IsHotLoad( void ) const`	`LuaContext:IsHotLoad() -> boolean`	unique method name
`LoadNewContext`	—	`LuaContext:LoadNewContext()`	unique method name
`Reload`	`void Reload( void )`	`LuaContext:Reload()`	unique method name
`RequestRefresh`	`void RequestRefresh( void )`	`LuaContext:RequestRefresh()`	unique method name
`SetAppLostFocusHandler`	`void SetAppLostFocusHandler( function )`	`LuaContext:SetAppLostFocusHandler(arg1: function)`	unique method name
`SetAppRegainedFocusHandler`	`void SetAppRegainedFocusHandler( function )`	`LuaContext:SetAppRegainedFocusHandler(arg1: function)`	unique method name
`SetHideHandler`	`void SetHideHandler( function )`	`LuaContext:SetHideHandler(arg1: function)`	unique method name
`SetInitHandler`	`void SetInitHandler( function )`	`LuaContext:SetInitHandler(arg1: function)`	unique method name
`SetInputHandler`	—	`LuaContext:SetInputHandler()`	unique method name
`SetPostInit`	`void SetPostInit( function )`	`LuaContext:SetPostInit(arg1: function)`	unique method name
`SetRefreshHandler`	`void SetRefreshHandler( function )`	`LuaContext:SetRefreshHandler(arg1: function)`	unique method name
`SetShowHandler`	`void SetShowHandler( function )`	`LuaContext:SetShowHandler(arg1: function)`	unique method name
`SetShowHideHandler`	`void SetShowHideHandler( function )`	`LuaContext:SetShowHideHandler(arg1: function)`	unique method name
`SetShutdown`	`void SetShutdown( function )`	`LuaContext:SetShutdown(arg1: function)`	unique method name
`SetShutdownGamepad`	`void SetShutdownGamepad( function )`	`LuaContext:SetShutdownGamepad(arg1: function)`	unique method name
`SetUpdate`	`void SetUpdate( function )`	`LuaContext:SetUpdate(arg1: function)`	unique method name
`SetUpdateGamepad`	`void SetUpdateGamepad( function )`	`LuaContext:SetUpdateGamepad(arg1: function)`	unique method name
`UnifyClickAndTap`	`void UnifyClickAndTap( bool )`	`LuaContext:UnifyClickAndTap(arg1: boolean)`	unique method name