List

This type represents a list box control.

This type inherits ControlContainer type. All of its base methods and fields are also available in this type.

add method expects an instance of Selectable. Passing other control types will not add them to the list.

Value bits are toggled in order of selectables. That means if the first element is toggled, so will be the first bit, etc.

__call

Constructor

Constructs the list.

Lists accept a maximum of 64 items. If you plan on having more than 64 items in your list, use unlimitedMode .

Arguments

Name	Type	Description
id	ControlID|string	ID.
height	vec2	Size.

Returns

Type	Description
List	List box instance.

Example

local list = gui.List(id, draw.Vec2(0, 60));
list.sizeToParentW = true -- Resize width to fill entire container.

---

allowMultiple

Field

Type: bool

If set to true, the list will be able to toggle multiple selectables.

---

unlimitedMode

Field

Type: bool

If set to true, the list will be able to support more than 64 items.

This is not compatible with allowMultiple .

---

GetValue

Method

Returns list's value.

Arguments

None.

Returns

Type	Description
ValueParam<bits>	Value data.

Example

local bits = list:GetValue():Get();
local first = bits:Get(1);

---

Get

Method

Returns value directly. Alias for GetValue():Get() .

Arguments

None.

Returns

Type	Description
bits	Value.

Example

local val = cb:Get()