CMenuMultiSelect

CMenuMultiSelect metatable.

_Name

:Name(): string

Returns widget's name.

_Update

:Update(items, [expanded], [saveToConfig]): nil

Name	Type	Description
items	{nameId: string, imagePath: string, isEnabled: boolean}[]	See CMenuGroup:MultiSelect.
expanded [?]	boolean	false if you want to create MultiSelect in collapsed state. (default: false)
saveToConfig [?]	boolean	true if you want to save to config (default: false)

Updates the multiselect values.

_{OneItemSelection}

:OneItemSelection(newState): boolean

Name	Type	Description
newState	boolean

Gets or sets one item selection state. One item selection allows only one item to be selected. Depends on the argument.

_{OneItemSelection}

:OneItemSelection(): boolean

_DragAllowed

:DragAllowed(newState): boolean

Name	Type	Description
newState	boolean

Gets or sets drag allowed state. Drag allows items to be ordered by cursor. Depends on the argument.

_DragAllowed

:DragAllowed(): boolean

_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
widget:Visible(false)

_Visible

:Visible(): boolean

Example

-- getter
local isVisible = widget:Visible()

_Disabled

:Disabled(value): nil

Name	Type	Description
value	boolean

Gets or sets disabled state. Depends on argument.

Example

-- setter
widget:Disabled( false )

_Disabled

:Disabled(): boolean

Example

-- getter
local isDisabled = widget: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(itemId): boolean

Name	Type	Description
itemId	string

Returns enable state of the item in multiselect.

_Set

:Set(enabledItems): nil

Name	Type	Description
enabledItems	string[]	A table of enabled items; other items will be disabled.

Sets a new value for the item by itemId or sets a new list of enabled items

_Set

:Set(itemId, value): nil

Name	Type	Description
itemId	string
value	boolean

_List

:List(): string[]

Returns array of itemIds.

_ListEnabled

:ListEnabled(): string[]

Returns array of enabled itemIds.

_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
widget:Icon("\u{f007}")

_SetCallback

Multiple callbacks could be set.

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

Name	Type	Description
callback	fun(this: CMenuMultiSelect):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: CMenuMultiSelect):nil	function to be removed from widget's callbacks.

Removes widget's on change callback.

_{UpdateBackgroundColors}

:UpdateBackgroundColors(colors): nil

Name	Type	Description
colors	table<string>	Table with background colors.

Updates widget's background colors.

_{UpdateImageColors}

:UpdateImageColors(colors): nil

Name	Type	Description
colors	table<string>	Table with image colors.

Updates widget's image colors.

_{UpdateToolTips}

:UpdateToolTips(colors): nil

Name	Type	Description
colors	table<string>	Table with new tooltips

Updates widget's tooltips