Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMenuBarButtonDescription

Hierarchy

Implemented by

Index

Properties

Optional bindable

bindable: Bindable

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

Optional group

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.

Optional imageHeight

imageHeight: undefined | number

Optional imagePath

imagePath: undefined | string

A replacement image to use. Used in modding.

Optional imageWidth

imageWidth: undefined | number

Optional modIndex

modIndex: undefined | number

Methods

onActivate

  • onActivate(): any
  • What should happen when this button is clicked.

    Returns any

Optional onCreate

  • onCreate(button: Button): any
  • Parameters

    Returns any

Optional onDispose

  • onDispose(button: Button): any
  • Parameters

    Returns any

Optional tooltip

  • Parameters

    Returns ITooltip

Generated using TypeDoc