Checkbox

This type represents a checkbox control.

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

__call

Constructor

Constructs the checkbox.

Arguments

Name	Type	Description
id	ControlID|string	ID.

Returns

Type	Description
Checkbox	Checkbox instance.

Example

local cb = gui.Checkbox('my_id');

---

GetValue

Method

Returns checkbox' value.

Arguments

None.

Returns

Type	Description
ValueParam<bool>	Value data.

Example

local val = cb:GetValue():Get();

---

Get

Method

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

Arguments

None.

Returns

Type	Description
boolean	Value.

Example

local val = cb:GetValueRaw()

---

SetValue

Method

Sets checkbox' value.

It is advised to use this method instead of ValueParam's Set method.

Arguments

Name	Type	Description
val	bool	New value.

Returns

Nothing.

Example

cb:SetValue(true);