📋CMenuMultiSelect

CMenuMultiSelect metatable.

:Name(): string

Returns widget's name.

:Update(items: {nameId: string, imagePath: string, isEnabled: boolean}[], expanded [?]: boolean): nil

Updates the multiselect values.

:OneItemSelection(newState: boolean): boolean

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

:OneItemSelection(): boolean

:DragAllowed(newState: boolean): boolean

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

:DragAllowed(): boolean

:Parent(): CMenuGroup|CMenuGearAttachment

Returns widget's parent.

:Type(): Enum.WidgetType

Returns widget type.

:Open(): nil

Opens parent tabs.

:ForceLocalization(newText: string): nil

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

:ToolTip(newText: string): string

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

:ToolTip(): string

:Visible(value: boolean): nil

Gets or sets visible state. Depends on argument.

Example

-- setter
widget:Visible(false)

:Visible(): boolean

Example

-- getter
local isVisible = widget:Visible()

:Disabled(value: boolean): nil

Gets or sets disabled state. Depends on argument.

Example

-- setter
widget:Disabled( false )

:Disabled(): boolean

Example

-- getter
local isDisabled = widget:Disabled()

:Unsafe(value: boolean): nil

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

:Unsafe(): boolean

:Get(itemId: string): boolean

Returns enable state of the item in multiselect.

:Set(enabledItems: string[]): nil

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

:Set(itemId: string, value: boolean): nil

:ListEnabled(): string[]

Returns array of enabled itemIds.

:Image(imagePath: string, offset [?]: Vec2): nil

Sets widget's image.

:Icon(icon: string, offset [?]: Vec2): nil

Sets widget's icon. Icons list

Example

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

:SetCallback(callback: fun(this: CMenuMultiSelect):nil, forceCall [?]: boolean): nil

Sets widget's on change callback.

:UnsetCallback(callback: fun(this: CMenuMultiSelect):nil): nil

Removes widget's on change callback.

:UpdateBackgroundColors(colors: table<string>): nil

Updates widget's background colors.

:UpdateImageColors(colors: table<string>): nil

Updates widget's image colors.

:UpdateToolTips(colors: table<string>): nil

Updates widget's tooltips