crystal.scene.replace

Plays transitions and changes the current scene. This function can be used with zero or more transitions. Transitions play in a sequence before the scene change is complete.

During transitions, the old and the new scenes both receive Scene:update callbacks. Only the new scene receives input callbacks.

Usage

crystal.scene.replace(new_scene, ...);

Arguments

Name Type Description
new_scene Scene Scene to transition to.
... Transition Transitions to play.

Returns

Name Type Description
thread Thread A thread that completes when all transitions are finished.

Examples

local new_scene = crystal.Scene:new();
crystal.scene.replace(
  new_scene,
  crystal.Transition.FadeToBlack:new(),
  crystal.Transition.FadeFromBlack:new(),
);

This site uses Just the Docs, a documentation theme for Jekyll.