Class Menu

constructor

• new Menu(name: string, idealWidth: number): Menu

  Parameters

  • name: string
  • idealWidth: number

  Returns Menu

ui

addBackground

• addBackground(name: string, url: string): void

  Add a background image to the menu. The image will stretch to fill the entire UI.

  Parameters

  • name: string

    image's control name
  • url: string

  Returns void

addImageButton

• addImageButton(
      name: string,
      text: string,
      imageUrl: string,
      imageWidth: string,
      imageHeight: string,
      width: string | number,
      height: string | number,
      background?: string,
      color?: string,
      top?: string | number,
      left?: string | number,
      cornerRadius?: number,
      thickness?: number,
      verticalAlignment?: number,
      horizontalAlignment?: number,
      clickCallback?: () => void,
  ): void

  Create and then add a button to the menu. The button is made of an image and a text label, and can be styled with various properties.

  Parameters

  • name: string
  • text: string
  • imageUrl: string
  • imageWidth: string
  • imageHeight: string
  • width: string | number
  • height: string | number
  • background: string = "black"
  • color: string = "white"
  • top: string | number = 0
  • left: string | number = 0
  • cornerRadius: number = 0
  • thickness: number = 0
  • verticalAlignment: number = Control.VERTICAL_ALIGNMENT_BOTTOM
  • horizontalAlignment: number = Control.HORIZONTAL_ALIGNMENT_CENTER
  • OptionalclickCallback: () => void

  Returns void

addSimpleButton

• addSimpleButton(
      name: string,
      text: string,
      width: string | number,
      height: string | number,
      background?: string,
      color?: string,
      top?: string | number,
      left?: string | number,
      cornerRadius?: number,
      thickness?: number,
      verticalAlignment?: number,
      horizontalAlignment?: number,
      clickCallback?: () => void,
  ): void

  Create and then add a simple button to the menu. The button will have a text label and can be styled with various properties.

  Parameters

  • name: string
  • text: string
  • width: string | number
  • height: string | number
  • background: string = "black"
  • color: string = "white"
  • top: string | number = 0
  • left: string | number = 0
  • cornerRadius: number = 0
  • thickness: number = 0
  • verticalAlignment: number = Control.VERTICAL_ALIGNMENT_BOTTOM
  • horizontalAlignment: number = Control.HORIZONTAL_ALIGNMENT_CENTER
  • OptionalclickCallback: () => void

  Returns void

addTextBlock

• addTextBlock(
      name: string,
      text: string,
      fontSize: number,
      color?: string,
      top?: string | number,
      left?: string | number,
      verticalAlignment?: number,
      horizontalAlignment?: number,
      fontFamily?: string,
  ): void

  Add a text block to the menu. The text block can be positioned and styled with various properties.

  Parameters

  • name: string
  • text: string
  • fontSize: number
  • color: string = "white"
  • top: string | number = 0
  • left: string | number = 0
  • verticalAlignment: number = Control.VERTICAL_ALIGNMENT_TOP
  • horizontalAlignment: number = Control.HORIZONTAL_ALIGNMENT_LEFT
  • OptionalfontFamily: string

  Returns void