Home › Engine Lua tables › ForgeUI control types › EditBoxControl

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.

EditBoxControl

ForgeUI control type (ForgeUI::EditBoxControl). 27 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
`ClearString`	`void ClearString( void )`	`EditBoxControl:ClearString()`	unique method name
`DropFocus`	`void DropFocus( void )`	`EditBoxControl:DropFocus()`	unique method name
`GetButtonIconText`	`const char* GetButtonIconText( void )`	`EditBoxControl:GetButtonIconText() -> string`	unique method name
`GetMaxCharacters`	`uint GetMaxCharacters( void ) const`	`EditBoxControl:GetMaxCharacters() -> integer`	unique method name
`GetNumberInput`	`bool GetNumberInput( void ) const`	`EditBoxControl:GetNumberInput() -> boolean`	unique method name
`GetText`	—	`EditBoxControl:GetText()`	neighbouring methods in the code
`GetTextControl`	`TextControl* GetTextControl( void )`	`EditBoxControl:GetTextControl() -> TextControl`	neighbouring methods in the code
`GetVoid1`	`int GetVoid1( void ) const`	`EditBoxControl:GetVoid1() -> integer`	neighbouring methods in the code
`GetVoid2`	`int GetVoid2( void ) const`	`EditBoxControl:GetVoid2() -> integer`	neighbouring methods in the code
`HasFocus`	`bool HasFocus( void ) const`	`EditBoxControl:HasFocus() -> boolean`	unique method name
`LocalizeAndSetText`	—	`EditBoxControl:LocalizeAndSetText()`	neighbouring methods in the code
`RegisterCallback`	`void RegisterCallback( function )`	`EditBoxControl:RegisterCallback(arg1: function)`	neighbouring methods in the code
`RegisterCharCallback`	`void RegisterCharCallback( function )`	`EditBoxControl:RegisterCharCallback(arg1: function)`	unique method name
`RegisterCommitCallback`	`void RegisterCommitCallback( function )`	`EditBoxControl:RegisterCommitCallback(arg1: function)`	unique method name
`RegisterHasFocusCallback`	`void RegisterHasFocusCallback( function )`	`EditBoxControl:RegisterHasFocusCallback(arg1: function)`	unique method name
`RegisterLostFocusCallback`	`void RegisterLostFocusCallback( function )`	`EditBoxControl:RegisterLostFocusCallback(arg1: function)`	unique method name
`RegisterStringChangedCallback`	`void RegisterStringChangedCallback( function )`	`EditBoxControl:RegisterStringChangedCallback(arg1: function)`	unique method name
`SetButtonIconText`	`void SetButtonIconText( const char* )`	`EditBoxControl:SetButtonIconText(arg1: string)`	unique method name
`SetEnableSpaceReplacement`	`void SetEnableSpaceReplacement( bool )`	`EditBoxControl:SetEnableSpaceReplacement(arg1: boolean)`	unique method name
`SetFocusStop`	`void SetFocusStop( int )`	`EditBoxControl:SetFocusStop(arg1: integer)`	unique method name
`SetMaxCharacters`	`void SetMaxCharacters( uint )`	`EditBoxControl:SetMaxCharacters(arg1: integer)`	unique method name
`SetNumberInput`	`void SetNumberInput( bool )`	`EditBoxControl:SetNumberInput(arg1: boolean)`	unique method name
`SetText`	`void SetText( const char* )`	`EditBoxControl:SetText(arg1: string)`	neighbouring methods in the code
`SetVoid1`	`void SetVoid1( int )`	`EditBoxControl:SetVoid1(arg1: integer)`	neighbouring methods in the code
`SetVoid2`	`void SetVoid2( int )`	`EditBoxControl:SetVoid2(arg1: integer)`	neighbouring methods in the code
`SetVoids`	`void SetVoids( int, int )`	`EditBoxControl:SetVoids(arg1: integer, arg2: integer)`	neighbouring methods in the code
`TakeFocus`	`void TakeFocus( void )`	`EditBoxControl:TakeFocus()`	unique method name