Skip to main content

[NodeMod Core]

/ .. / MenuOptions

Interface: MenuOptions

Defined in: src/core/menu.ts:25

Configuration options for creating a menu.

Properties​

title​

title: string

Defined in: src/core/menu.ts:27

Title displayed at the top of the menu

items​

items: MenuItem[]

Defined in: src/core/menu.ts:29

Array of menu items

entity?​

optional entity: Entity

Defined in: src/core/menu.ts:31

Specific entity to show menu to (if undefined, shows to all players)

time?​

optional time: number

Defined in: src/core/menu.ts:33

Auto-close timeout in seconds (-1 for no timeout)

onTimeout()?​

optional onTimeout: (client) => void

Defined in: src/core/menu.ts:35

Callback when menu times out

Parameters​

client​

Entity

Returns​

void

onExit()?​

optional onExit: (client) => void

Defined in: src/core/menu.ts:37

Callback when menu is exited

Parameters​

client​

Entity

Returns​

void

exitText?​

optional exitText: string

Defined in: src/core/menu.ts:39

Text for exit button

backText?​

optional backText: string

Defined in: src/core/menu.ts:41

Text for back button

nextText?​

optional nextText: string

Defined in: src/core/menu.ts:43

Text for next page button

prevText?​

optional prevText: string

Defined in: src/core/menu.ts:45

Text for previous page button

formatters?​

optional formatters: MenuFormatters

Defined in: src/core/menu.ts:47

Custom formatting functions