ESCTransitionPlayer

Description

A transition player for scene changes

const IN = 0 # enum "TRANSITION\_MODE"

const OUT = 1 # enum "TRANSITION\_MODE"

const TRANSITION_ID_INSTANT = -1

Id to represent instant/no transitions

const TRANSITION_INSTANT = "instant"

Instant transition type

var transition_id: int

Id of the transition. Allows keeping track of the actual transition being played or finished

signal transition_done(transition_id: Variant)

Emitted when the transition was played

Name	Type	Description	Required?
transition_id	`Variant`	Identifier of the transition that completed.	yes

func transition(transition_name: String, mode: int, duration: float) -> int

Play a transition animation

Name	Type	Description	Required?
transition_name	`String`	Name of the transition to play (if empty string, uses the default transition).	no
mode	`int`	Mode to transition (in/out).	no
duration	`float`	The duration the transition should take.	no

Returns the transition id. (int)

func get_transition(name: String) -> String

The full path for a transition shader based on its name

Name	Type	Description	Required?
name	`String`	Transition name whose material path should be resolved.	yes

Returns the full path for a transition shader based on its name the full path to the shader or an empty string if it can’t be found. (String)

func has_transition(name: String) -> bool

True whether the transition scene has a transition corresponding to name provided.

Name	Type	Description	Required?
name	`String`	Transition name to check for availability.	yes

Returns true whether the transition scene has a transition corresponding to name provided. true if a transition exists with given name. (bool)

func reset_shader_cutoff() -> void

Resets the current material’s cutoff parameter instantly.

None.

Returns nothing.