Home › Engine Lua tables › ForgeUI control types › ListBoxControl

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.

ListBoxControl

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

C++ base classes (from the exe RTTI, see engine classes): ForgeUI::ListBoxControlBase > 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
`GetEntries`	`table GetEntries( void )`	`ListBoxControl:GetEntries() -> table`	unique method name
`GetIndexedEntry`	`table GetIndexedEntry( uint )`	`ListBoxControl:GetIndexedEntry(arg1: integer) -> table`	unique method name
`GetSelectedEntry`	`table GetSelectedEntry( void )`	`ListBoxControl:GetSelectedEntry() -> table`	neighbouring methods in the code
`GetSelectedIndex`	`uint GetSelectedIndex( void ) const`	`ListBoxControl:GetSelectedIndex() -> integer`	neighbouring methods in the code
`HasEntries`	`bool HasEntries( void )`	`ListBoxControl:HasEntries() -> boolean`	unique method name
`SetEntries`	`void SetEntries( table, uint )`	`ListBoxControl:SetEntries(arg1: table, arg2: integer)`	neighbouring methods in the code
`SetSelectedIndex`	`void SetSelectedIndex( uint, bool )`	`ListBoxControl:SetSelectedIndex(arg1: integer, arg2: boolean)`	neighbouring methods in the code