Menu

A chest menu from ui.menu. Players cannot take or move items in it; clicks go to onClick. Changes show at once to everyone who has it open. Slots are 0 to rows * 9 - 1.

Methods

menu:set(slot: number, item: string | MenuItem, count: number?, name: string?, ...string: any)#

Fills a slot: set(slot, item, count?, name?, ...lore) or set(slot, { item = .., lore = { .. } }). count 1..99, at most 16 lore lines.

menu:glow(slot: number, glow: boolean)#

Turns the glint on a filled slot on or off. Raises if the slot is empty.

menu:clear(slot: number?)#

Empties a slot, or every slot when nil.

menu:setTitle(title: string)#

Changes the title.

menu:onClick(fn: ((player: Player, slot: number, click: ClickKind) -> ())?)#

Sets the click handler, which gets the player, the 0-based slot and the click kind. nil removes it.

menu:onClose(fn: ((player: Player) -> ())?)#

Sets the handler for a player closing the menu themselves (not for close or destroy). nil removes it.

menu:open(player: Player)#

Opens the menu for a player, replacing any menu they have open.

menu:close(player: Player?)#

Closes it for one player, or for every viewer when nil.

menu:destroy()#

Closes it for everyone and frees it. Using the handle afterwards raises.