RezEvent

# after(callback) → {RezEvent}

Adds a callback to be run after event processing is finished

Parameters:

Name	Type	Description
`callback`	`function`	a parameterless callback the runs after processing

View Source rez_event.js, line 441

Returns:

this event for method chaining

Type: RezEvent

Sets an auto-dismissing banner message displayed full-width across the viewport

Parameters:

Name	Type	Attributes	Default	Description
`message`	`string`			message to display in the banner
`options`	`object`	<optional>	{}	optional config; supports `class` (string), `onscreen` (ms, default 2000), `dark` (boolean, default true), and `vpos` (number 0-100, default 50; percent of viewport height where the banner is vertically centered)

View Source rez_event.js, line 200

Returns:

this event for method chaining

Type: RezEvent

# bannerConfig() → {object|null}

View Source rez_event.js, line 191

Returns:

the banner config ({message, cssClass, onscreen, dark, vpos}), or null

Type: object | null

# cardId() → {string|null}

View Source rez_event.js, line 72

Returns:

ID of the card to play, or null if no card action

Type: string | null

# constructor()

Creates a new event response with default values

View Source rez_event.js, line 32

# error(message) → {RezEvent}

Sets this event as an error with the specified message

Parameters:

Name	Type	Description
`message`	`string`	error message

View Source rez_event.js, line 429

Returns:

this event for method chaining

Type: RezEvent

# errorMessage() → {string|null}

View Source rez_event.js, line 126

Returns:

error message if this is an error event, or null

Type: string | null

# flash(message, kind) → {RezEvent}

Adds a flash message to be displayed to the user

Parameters:

Name	Type	Description
`message`	`string`	message to display as a flash
`kind`	`string`	optional notification kind (default: "")

View Source rez_event.js, line 169

Returns:

this event for method chaining

Type: RezEvent

# flashMessages() → {Array.<string>}

View Source rez_event.js, line 63

Returns:

array of flash messages to display

Type: Array.<string>

# hasBanner() → {boolean}

View Source rez_event.js, line 182

Returns:

true if this event has a banner message to display

Type: boolean

# hasFlash() → {boolean}

View Source rez_event.js, line 160

Returns:

true if this event has flash messages to display

Type: boolean

# hasModalCard() → {boolean}

View Source rez_event.js, line 261

Returns:

true if this event has a card to display in a modal

Type: boolean

# hasModalMessage() → {boolean}

View Source rez_event.js, line 219

Returns:

true if this event has a modal message to display

Type: boolean

# hasQueuedEvents() → {boolean}

View Source rez_event.js, line 491

Returns:

true if this event has follow-up events to raise

Type: boolean

# isError() → {boolean}

View Source rez_event.js, line 420

Returns:

true if this is an error event

Type: boolean

# modalCard(cardId, paramsopt, optionsopt) → {RezEvent}

Sets a card to be displayed as a modal dialog

Parameters:

Name	Type	Attributes	Default	Description
`cardId`	`string`			ID of the card to render in the modal
`params`	`object`	<optional>	{}	optional params passed to the card on will_embed
`options`	`object`	<optional>	{}	display options for the modal
`showDismiss`	`boolean`	<optional>	true	when false, suppresses the default OK dismiss button so the card can supply its own dismiss control
`animation`	`string`	<optional>	"scale"	entrance animation, one of `"scale"` (fade + scale up), `"fade"`, `"slide"` (slide up + fade), or `"none"`
`animationDuration`	`number`	<optional>	180	animation duration in ms

View Source rez_event.js, line 279

Returns:

this event for method chaining

Type: RezEvent

# modalCardConfig() → {object|null}

View Source rez_event.js, line 270

Returns:

the modal card config ({cardId, params, showDismiss}), or null

Type: object | null

# modalMessage(message, optionsopt) → {RezEvent}

Sets a modal message to be displayed to the user

Parameters:

Name	Type	Attributes	Default	Description
`message`	`string`			message to display in the modal body
`options`	`object`	<optional>	{}	optional config
`title`	`string`	<optional>		optional modal title
`animation`	`string`	<optional>	"scale"	entrance animation, one of `"scale"` (fade + scale up), `"fade"`, `"slide"` (slide up + fade), or `"none"`
`animationDuration`	`number`	<optional>	180	animation duration in ms

View Source rez_event.js, line 237

Returns:

this event for method chaining

Type: RezEvent

# noop() → {RezEvent}

No-operation method for method chaining when no action is needed

View Source rez_event.js, line 509

Returns:

this event for method chaining

Type: RezEvent

# params() → {object}

View Source rez_event.js, line 54

Returns:

the parameters object associated with this event

Type: object

# playCard(cardId) → {RezEvent}

Sets this event to play the specified card

Parameters:

Name	Type	Description
`cardId`	`string`	ID of the card to play

View Source rez_event.js, line 315

Returns:

this event for method chaining

Type: RezEvent

# queueEvent(eventName, paramsopt, optsopt) → {RezEvent}

Queues a follow-up event to be raised after this response has been dispatched (and rendered). The event fires asynchronously after delay ms, allowing the browser to paint the current render before the next event runs. This drives paced sequences such as a monster taking several actions in a row. While a locking queued sequence is in flight the event processor is "busy" and player-initiated events are ignored, preventing the player from interfering mid-sequence.

Parameters:

Name	Type	Attributes	Default	Description
`eventName`	`string`			the name of the event to raise after this response
`params`	`object`	<optional>	{}	parameters passed to the queued event's handler
`opts`	`object`	<optional>	{}	options: `delay` (ms before the event fires, default 0), `target` (id of an element to resolve the handler against first, default null), `lock` (gate player input while the queued sequence is in flight, default true)

View Source rez_event.js, line 464

Returns:

this event for method chaining

Type: RezEvent

# queuedEvents() → {Array.<object>}

View Source rez_event.js, line 500

Returns:

array of queued event descriptors {eventName, params, target, delay, lock}

Type: Array.<object>

# render() → {RezEvent}

Sets this event to trigger a view render

View Source rez_event.js, line 336

Returns:

this event for method chaining

Type: RezEvent

# renderEvent() → {boolean}

View Source rez_event.js, line 117

Returns:

true if this event should trigger a view render

Type: boolean

# runAfter()

Run any after callbacks

View Source rez_event.js, line 453

# sceneChange(sceneId) → {RezEvent}

Sets this event to change to the specified scene

Parameters:

Name	Type	Description
`sceneId`	`string`	ID of the scene to change to

View Source rez_event.js, line 356

Returns:

this event for method chaining

Type: RezEvent

# sceneChangeEvent() → {boolean}

View Source rez_event.js, line 90

Returns:

true if this event should trigger a scene change

Type: boolean

# sceneId() → {string|null}

View Source rez_event.js, line 81

Returns:

ID of the scene for scene transition, or null if no scene action

Type: string | null

# sceneInterlude(sceneId) → {RezEvent}

Sets this event to start an interlude with the specified scene

Parameters:

Name	Type	Description
`sceneId`	`string`	ID of the scene to interlude with

View Source rez_event.js, line 381

Returns:

this event for method chaining

Type: RezEvent

# sceneInterludeEvent() → {boolean}

View Source rez_event.js, line 99

Returns:

true if this event should trigger a scene interlude

Type: boolean

# sceneResume() → {RezEvent}

Sets this event to resume the previous scene from the scene stack

View Source rez_event.js, line 406

Returns:

this event for method chaining

Type: RezEvent

# sceneResumeEvent() → {boolean}

View Source rez_event.js, line 108

Returns:

true if this event should resume the previous scene

Type: boolean

# setParam(name, value) → {RezEvent}

Sets a single parameter on this event

Parameters:

Name	Type	Description
`name`	`string`	parameter name
`value`	`*`	parameter value

View Source rez_event.js, line 135

Returns:

this event for method chaining

Type: RezEvent

# setParams(params) → {RezEvent}

Replaces the entire parameters object for this event

Parameters:

Name	Type	Description
`params`	`object`	parameters object to set

View Source rez_event.js, line 148

Returns:

this event for method chaining

Type: RezEvent

# shouldChangeScene() → {boolean}

View Source rez_event.js, line 347

Returns:

true if this event should change to a new scene

Type: boolean

# shouldInterludeScene() → {boolean}

View Source rez_event.js, line 372

Returns:

true if this event should start a scene interlude

Type: boolean

# shouldPlayCard() → {boolean}

View Source rez_event.js, line 306

Returns:

true if this event should play a card

Type: boolean

# shouldRender() → {boolean}

View Source rez_event.js, line 327

Returns:

true if this event should trigger a view render

Type: boolean

# shouldResumeScene() → {boolean}

View Source rez_event.js, line 397

Returns:

true if this event should resume the previous scene

Type: boolean

# static after(callback) → {RezEvent}

Creates a new event that runs the specified callback after being processed

Parameters:

Name	Type	Description
`callback`	`function`	a parameterless callback the runs after processing

View Source rez_event.js, line 686

Returns:

a new event that will run the callback after processing

Type: RezEvent

Creates a new event that displays an auto-dismissing full-width banner

Parameters:

Name	Type	Attributes	Default	Description
`message`	`string`			message to display in the banner
`options`	`object`	<optional>	{}	optional config; supports `class` (string), `onscreen` (ms, default 2000), `dark` (boolean, default true), and `vpos` (number 0-100, default 50; percent of viewport height where the banner is vertically centered)

View Source rez_event.js, line 542

Returns:

a new event with the banner message set

Type: RezEvent

# static built_in() → {RezEvent}

Creates a new built-in event with default values

View Source rez_event.js, line 519

Returns:

a new empty event

Type: RezEvent

# static error(message) → {RezEvent}

Creates a new event that represents an error

Parameters:

Name	Type	Description
`message`	`string`	error message

View Source rez_event.js, line 698

Returns:

a new error event

Type: RezEvent

# static flash(message) → {RezEvent}

Creates a new event that displays a flash message

Parameters:

Name	Type	Description
`message`	`string`	flash message to display

View Source rez_event.js, line 530

Returns:

a new event with the flash message

Type: RezEvent

# static modalCard(cardId, paramsopt, optionsopt) → {RezEvent}

Creates a new event that displays a card as a modal dialog

Parameters:

Name	Type	Attributes	Default	Description
`cardId`	`string`			ID of the card to render in the modal
`params`	`object`	<optional>	{}	optional params passed to the card on will_embed
`options`	`object`	<optional>	{}	display options for the modal
`showDismiss`	`boolean`	<optional>	true	when false, suppresses the default OK dismiss button so the card can supply its own dismiss control
`animation`	`string`	<optional>	"scale"	entrance animation (`"scale"\|"fade"\|"slide"\|"none"`)
`animationDuration`	`number`	<optional>	180	animation duration in ms

View Source rez_event.js, line 571

Returns:

a new event with the modal card set

Type: RezEvent

# static modalMessage(message, optionsopt, optionsopt) → {RezEvent}

Creates a new event that displays a modal dialog

Parameters:

Name	Type	Attributes	Default	Description
`message`	`string`			modal body message
`options`	`object`	<optional>	{}	optional config; supports `title` (string)
`options`	`object`	<optional>	{}	optional config; supports `title`, `animation` (`"scale"\|"fade"\|"slide"\|"none"`, default `"scale"`) and `animationDuration` (ms, default `180`)

View Source rez_event.js, line 555

Returns:

a new event with the modal message set

Type: RezEvent

# static noop() → {RezEvent}

Creates a new event that performs no action

View Source rez_event.js, line 675

Returns:

a new empty event

Type: RezEvent

# static playCard(cardId) → {RezEvent}

Creates a new event that plays the specified card

Parameters:

Name	Type	Description
`cardId`	`string`	ID of the card to play

View Source rez_event.js, line 590

Returns:

a new event that plays the specified card

Type: RezEvent

# static queueEvent(eventName, paramsopt, optsopt) → {RezEvent}

Creates a new event that queues a follow-up event

Parameters:

Name	Type	Attributes	Default	Description
`eventName`	`string`			the name of the event to raise after this response
`params`	`object`	<optional>	{}	parameters passed to the queued event's handler
`opts`	`object`	<optional>	{}	options: `delay`, `target`, `lock` (see instance method)

View Source rez_event.js, line 613

Returns:

a new event that queues the specified follow-up event

Type: RezEvent

# static render() → {RezEvent}

Creates a new event that triggers a view render

View Source rez_event.js, line 602

Returns:

a new event that triggers a render

Type: RezEvent

# static sceneChange(sceneId) → {RezEvent}

Creates a new event that changes to the specified scene

Parameters:

Name	Type	Description
`sceneId`	`string`	ID of the scene to change to

View Source rez_event.js, line 640

Returns:

a new event that changes to the specified scene

Type: RezEvent

# static sceneInterlude(sceneId) → {RezEvent}

Creates a new event that starts an interlude with the specified scene

Parameters:

Name	Type	Description
`sceneId`	`string`	ID of the scene to interlude with

View Source rez_event.js, line 652

Returns:

a new event that starts an interlude

Type: RezEvent

# static sceneResume() → {RezEvent}

Creates a new event that resumes the previous scene from the stack

View Source rez_event.js, line 664

Returns:

a new event that resumes the previous scene

Type: RezEvent

# static setParam(param, value) → {RezEvent}

Creates a new event with a single parameter set

Parameters:

Name	Type	Description
`param`	`string`	parameter name
`value`	`*`	parameter value

View Source rez_event.js, line 627

Returns:

a new event with the specified parameter

Type: RezEvent

# new RezEvent()

Example

Methods

# after(callback) → {RezEvent}

Parameters:

# banner(message, optionsopt) → {RezEvent}

Parameters:

# bannerConfig() → {object|null}

# cardId() → {string|null}

# constructor()

# error(message) → {RezEvent}

Parameters:

# errorMessage() → {string|null}

# flash(message, kind) → {RezEvent}

Parameters:

# flashMessages() → {Array.<string>}

# hasBanner() → {boolean}

# hasFlash() → {boolean}

# hasModalCard() → {boolean}

# hasModalMessage() → {boolean}

# hasQueuedEvents() → {boolean}

# isError() → {boolean}

# modalCard(cardId, paramsopt, optionsopt) → {RezEvent}

Parameters:

# modalCardConfig() → {object|null}

# modalMessage(message, optionsopt) → {RezEvent}

Parameters:

# noop() → {RezEvent}

# params() → {object}

# playCard(cardId) → {RezEvent}

Parameters:

# queueEvent(eventName, paramsopt, optsopt) → {RezEvent}

Parameters:

# queuedEvents() → {Array.<object>}

# render() → {RezEvent}

# renderEvent() → {boolean}

# runAfter()

# sceneChange(sceneId) → {RezEvent}

Parameters:

# sceneChangeEvent() → {boolean}

# sceneId() → {string|null}

# sceneInterlude(sceneId) → {RezEvent}

Parameters:

# sceneInterludeEvent() → {boolean}

# sceneResume() → {RezEvent}

# sceneResumeEvent() → {boolean}

# setParam(name, value) → {RezEvent}

Parameters:

# setParams(params) → {RezEvent}

Parameters:

# shouldChangeScene() → {boolean}

# shouldInterludeScene() → {boolean}

# shouldPlayCard() → {boolean}

# shouldRender() → {boolean}

# shouldResumeScene() → {boolean}

# static after(callback) → {RezEvent}

Parameters:

# static banner(message, optionsopt) → {RezEvent}

Parameters:

# static built_in() → {RezEvent}

# static error(message) → {RezEvent}

Parameters:

# static flash(message) → {RezEvent}

Parameters:

# static modalCard(cardId, paramsopt, optionsopt) → {RezEvent}

Parameters:

# static modalMessage(message, optionsopt, optionsopt) → {RezEvent}

Parameters:

# static noop() → {RezEvent}

# static playCard(cardId) → {RezEvent}

Parameters:

# static queueEvent(eventName, paramsopt, optsopt) → {RezEvent}

Parameters:

# static render() → {RezEvent}

# static sceneChange(sceneId) → {RezEvent}

Parameters:

# static sceneInterlude(sceneId) → {RezEvent}

Parameters:

# static sceneResume() → {RezEvent}

# static setParam(param, value) → {RezEvent}