Hierarchy

Implemented by

Properties

bindable?: default

Adds the bindable's current bind translation to the tooltip automatically.

group?: string | number

Sorts this menu bar button into a group of other similar menu bar buttons.

Internally, MenuBarButtonGroup.Meta and MenuBarButtonGroup.World are used. Not providing a group adds it to an unsorted group.

imageCount?: number

The number of alternate textures that this image has. Not supported for most things.

imagePath?: string

A replacement image to use. Used in modding.

modIndex?: number

Do not provide or modify this value, only reference it. This is set by the modding system during the process of registration.

order?: number | false

The order index of this menu bar button. If not provided, this button will be put at the end. If false, the button will not appear by default

See

DEFAULT_MENU_BAR_BUTTON_ORDER

size?: IVector2

The size of the icon. Defaults to 12x12

Methods

  • What should happen when this button is clicked.

    Parameters

    Returns any

  • Parameters

    Returns any

  • Parameters

    Returns any

Generated using TypeDoc