Scene

Changes the current scene image with an optional fade transition.

Command Name: scene | scene_await

Require Target: False

Parameters

Parameter
Type
Required
Default
Valid Values
Description

sceneName*

string

–

The name of the scene to transition to. Must match a loaded scene in the _scenes collection.

fadeDuration

number

0.0 (non await) 0.5 (with await)

value ≥ 0

The duration in seconds for the fade effect, if enabled. Default is 0.0 (non await) | 0.5 (with await) seconds.

Examples

  1. Show Scene 

    <<scene bg_savior_in_mirror>>

  2. Show Scene With Fade 

    <<scene bg_savior_in_mirror 0.75>>

Last updated