CMenuSwitch

CMenuSwitch metatable.

_Name

:Name(): string

Returns widget's name.

_Parent

:Parent(): CMenuGroup | CMenuGearAttachment

Returns widget's parent.

_Type

:Type(): Enum.WidgetType

Returns widget type.

_Open

:Open(): nil

Opens parent tabs.

_{ForceLocalization}

Not recommended for use due to its complexity

:ForceLocalization(newText): nil

Name	Type	Description
newText	string

Changes text in the widget. The path to the widget is not affected. May be used for dynamic text customization or recolor.

_ToolTip

:ToolTip(newText): string

Name	Type	Description
newText	string

Gets or sets tooltip. Tooltip is displayed when mouse cursor is over the widget. Depends on the argument.

_ToolTip

:ToolTip(): string

_Visible

:Visible(value): nil

Name	Type	Description
value	boolean

Gets or sets visible state. Depends on argument.

Example

-- setter
switch:Visible(false)

_Visible

:Visible(): boolean

Example

-- getter
local isVisible = switch:Visible()

_Disabled

:Disabled(value): nil

Name	Type	Description
value	boolean

Gets or sets disabled state. Depends on argument.

Example

-- setter
switch:Disabled( false )

_Disabled

:Disabled(): boolean

Example

-- getter
local isDisabled = switch:Disabled()

_Unsafe

:Unsafe(value): nil

Name	Type	Description
value	boolean

Gets or sets unsafe state. Unsafe widgets have warning sign. Depends on argument.

_Unsafe

:Unsafe(): boolean

_Get

:Get(): boolean

Returns widget's value.

_Set

:Set(value): nil

Name	Type	Description
value	boolean

Sets widget's value.

_Image

:Image(imagePath, [offset]): nil

Name	Type	Description
imagePath	string	Path to the image.
offset [?]	Vec2	Optional image offset. (default: {0.0, 0.0})

Sets widget's image.

_ImageHandle

:ImageHandle(imageHandle, [offset]): nil

Name	Type	Description
imageHandle	integer
offset [?]	Vec2	Optional image offset. (default: {0.0, 0.0})

Sets tab's image by already created handle.

_Icon

:Icon(icon, [offset]): nil

Name	Type	Description
icon	string	icon unicode.
offset [?]	Vec2	Optional icon offset. (default: {0.0, 0.0})

Sets widget's icon. Icons list

Example

--https://fontawesome.com/icons/user?f=classic&s=solid
switch:Icon("\u{f007}")

_SetCallback

Multiple callbacks could be set.

`:SetCallback(callback, [forceCall]):` **`nil`**

Name	Type	Description
callback	fun(this: CMenuSwitch):nil	function to be called on widget change.
forceCall [?]	boolean	true if you want to call callback on widget creation. (default: false)

Sets widget's on change callback.

_{UnsetCallback}

:UnsetCallback(callback): nil

Name	Type	Description
callback	fun(this: CMenuSwitch):nil	function to be removed from widget's callbacks.

Removes widget's on change callback.

_ColorPicker

:ColorPicker(name, color): CMenuColorPickerAttachment

Name	Type	Description
name	string	Name of the attachment.
color	Color	Default color.

Creates CMenuColorPickerAttachment and attaches it to the widget.

_Gear

:Gear(name, [gearIcon], [useSmallFont]): CMenuGearAttachment

Name	Type	Description
name	string	Name of the attachment.
gearIcon [?]	string	Gear FontAwesome icon. (default: "\uf013")
useSmallFont [?]	boolean	Use small font for gear icon. (default: true)

Creates CMenuGearAttachment and attaches it to the widget.