Documentation

Class

RezEvent

RezEvent()

Constructor

# new RezEvent()

Represents a game event response in the Rez game engine. Events are used to communicate the results of user interactions and specify what actions should be taken (scene changes, card plays, flash messages, etc.). Supports method chaining for building complex event responses.

View Source rez_event.js, line 5

Example
// Create an event that plays a card and shows a message
return RezEvent.playCard("next_card").flash("Moving forward!").render();

Methods

# 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 377

this event for method chaining

RezEvent

# cardId() → {string|null}

View Source rez_event.js, line 68

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

string | null

# constructor()

Creates a new event response with default values

View Source rez_event.js, line 30

# 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 365

this event for method chaining

RezEvent

# errorMessage() → {string|null}

View Source rez_event.js, line 122

error message if this is an error event, or null

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 165

this event for method chaining

RezEvent

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

View Source rez_event.js, line 59

array of flash messages to display

Array.<string>

# hasFlash() → {boolean}

View Source rez_event.js, line 156

true if this event has flash messages to display

boolean

# hasModal() → {boolean}

View Source rez_event.js, line 178

true if this event has a modal message to display

boolean

# hasModalCard() → {boolean}

View Source rez_event.js, line 210

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

boolean

# isError() → {boolean}

View Source rez_event.js, line 356

true if this is an error event

boolean

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; supports title (string)

View Source rez_event.js, line 196

this event for method chaining

RezEvent

# modalCard(cardId, paramsopt) → {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

View Source rez_event.js, line 228

this event for method chaining

RezEvent

# modalCardConfig() → {object|null}

View Source rez_event.js, line 219

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

object | null

# modalMessage() → {object|null}

View Source rez_event.js, line 187

the modal message config, or null

object | null

# noop() → {RezEvent}

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

View Source rez_event.js, line 400

this event for method chaining

RezEvent

# params() → {object}

View Source rez_event.js, line 50

the parameters object associated with this event

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 251

this event for method chaining

RezEvent

# render() → {RezEvent}

Sets this event to trigger a view render

View Source rez_event.js, line 272

this event for method chaining

RezEvent

# renderEvent() → {boolean}

View Source rez_event.js, line 113

true if this event should trigger a view render

boolean

# runAfter()

Run any after callbacks

View Source rez_event.js, line 389

# 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 292

this event for method chaining

RezEvent

# sceneChangeEvent() → {boolean}

View Source rez_event.js, line 86

true if this event should trigger a scene change

boolean

# sceneId() → {string|null}

View Source rez_event.js, line 77

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

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 317

this event for method chaining

RezEvent

# sceneInterludeEvent() → {boolean}

View Source rez_event.js, line 95

true if this event should trigger a scene interlude

boolean

# sceneResume() → {RezEvent}

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

View Source rez_event.js, line 342

this event for method chaining

RezEvent

# sceneResumeEvent() → {boolean}

View Source rez_event.js, line 104

true if this event should resume the previous scene

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 131

this event for method chaining

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 144

this event for method chaining

RezEvent

# shouldChangeScene() → {boolean}

View Source rez_event.js, line 283

true if this event should change to a new scene

boolean

# shouldInterludeScene() → {boolean}

View Source rez_event.js, line 308

true if this event should start a scene interlude

boolean

# shouldPlayCard() → {boolean}

View Source rez_event.js, line 242

true if this event should play a card

boolean

# shouldRender() → {boolean}

View Source rez_event.js, line 263

true if this event should trigger a view render

boolean

# shouldResumeScene() → {boolean}

View Source rez_event.js, line 333

true if this event should resume the previous scene

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 541

a new event that will run the callback after processing

RezEvent

# static built_in() → {RezEvent}

Creates a new built-in event with default values

View Source rez_event.js, line 410

a new empty event

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 553

a new error event

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 421

a new event with the flash message

RezEvent

# static modal(message, 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)

View Source rez_event.js, line 433

a new event with the modal message set

RezEvent

# static modalCard(cardId, paramsopt) → {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

View Source rez_event.js, line 446

a new event with the modal card set

RezEvent

# static noop() → {RezEvent}

Creates a new event that performs no action

View Source rez_event.js, line 530

a new empty event

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 459

a new event that plays the specified card

RezEvent

# static render() → {RezEvent}

Creates a new event that triggers a view render

View Source rez_event.js, line 471

a new event that triggers a render

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 495

a new event that changes to the specified scene

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 507

a new event that starts an interlude

RezEvent

# static sceneResume() → {RezEvent}

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

View Source rez_event.js, line 519

a new event that resumes the previous scene

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 482

a new event with the specified parameter

RezEvent