🔑CMenuBind

CMenuBind metatable.

:Name(): string

Returns widget's name.

---

:Parent(): CMenuGroup|CMenuGearAttachment

Returns widget's parent.

---

:Type(): Enum.WidgetType

Returns widget's type.

---

:Open(): nil

Opens parent tabs.

---

:ForceLocalization(newText: string): nil

Not recommended for use due to its complexity

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(idx [?]: 0|1): Enum.ButtonCode

Returns widget's value. To get both of the buttons use Buttons method.

---

:Set(key1: Enum.ButtonCode, key2 [?]: Enum.ButtonCode): nil

Sets widget's value.

---

:Buttons(): Enum.ButtonCode, Enum.ButtonCode

Returns widget's buttons value.

---

:IsDown(): boolean

Returns true when the key or both keys is down.

---

:IsPressed(): boolean

Returns true when the key or both keys is pressed for the first time.

---

:IsToggled(): boolean

Bind stores it's toggle state and switches it when the key is pressed. This method returns this state.

---

:SetToggled(value: boolean): nil

Sets the toggle state manually.

---

: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
switch:Icon("\f{007}")

---

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

Multiple callbacks could be set.

Sets widget's on change callback.

---

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

Removes widget's on change callback.

---

:ColorPicker(name: string, color: Color): CMenuColorPickerAttachment

Creates CMenuColorPickerAttachment and attaches it to the widget.

---

:Gear(name: string, gearIcon [?]: string, useSmallFont [?]: boolean): CMenuGearAttachment

Creates CMenuGearAttachment and attaches it to the widget.

---

:Properties(name [?]: string, value [?]: string, markAsToggle [?]: boolean): nil

Updates the properties of a widget for display in the bind list.

---

:ShowInBindIsland(newStatus: boolean): boolean

Gets or sets the visibility of the bind in the bind island.

---

:ShowInBindIsland(): boolean

---

:MouseBinding(newStatus: boolean): boolean

Gets or sets the ability to bind the mouse button.

---

:MouseBinding(): boolean