Interface IReturnClickOptions<TReturn>

Options for a prompt with a custom return value.

Type Parameters

  • TReturn

Hierarchy

Properties

if? message? order? return showDuringDelays?

Properties

Optional if

if?: boolean

Only create the prompt if true. Defaults to true.

Optional message

message?: Message

Optional message to display to the prompted player.

Optional order

order?: number

Sorting order for displaying a message about this prompt in the message bar. Defaults to 0. Messages with the same order value are sorted by newest first.

return

return: TReturn

When the player responds to the prompt, resolve with this value.

Optional showDuringDelays

showDuringDelays?: boolean

Show this prompt when delays are active. Defaults to false.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc