Methods

Menu API

All Menu API methods are available in the global Menu object.

Menu:GetById

Returns a menu by its id.

Menu:GetById(id)
  • id: string

Menu:GetOpened

Returns the currently opened menu, if avaible.

Menu:GetOpened()

Menu:Open

Opens the given menu.

Menu:Open(menu)
  • menu: Menu

Menu:Close

Closes the currently opened menu and opens the last opened menu.

Menu:Close()

Menu:CloseAll

Closes all menus.

Menu:CloseAll()

Menu:Create

Creates a new menu and returns it.

Menu:Create(title, subtitle, position, width, maxVisibleItems, banner)
  • title: string
  • subtitle?: string
  • position?: 'top-left' | 'top-center' | 'top-right' | 'center-left' | 'center' | 'center-right' | 'bottom-left' | 'bottom-center' | `'bottom-right'
  • width?: number
  • maxVisibleItems?: number Determines how much Items are visible at once
  • banner?: string