ESCTransitionPlayer

Extends: ColorRect

Description

A transition player for scene changes

Enumerations

TRANSITION_MODE

const TRANSITION_MODE: Dictionary = {"IN":0,"OUT":1}

The valid transition modes

Constants Descriptions

TRANSITION_ID_INSTANT

const TRANSITION_ID_INSTANT: int = -1

Id to represent instant/no transitions

TRANSITION_INSTANT

const TRANSITION_INSTANT: String = "instant"

Instant transition type

Property Descriptions

transition_id

var transition_id: int = 0

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

Method Descriptions

transition

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

get_transition

func get_transition(name: String) -> String

Returns the full path for a transition shader based on its name

Parameters

  • name: The name of the transition to test

Returns the full path to the shader or an empty string, if it can’t be found

has_transition

func has_transition(name: String) -> bool

Returns true whether the transition scene has a transition corresponding to name provided.

Parameters

  • name: The name of the transition to test

Returns true if a transition exists with given name.

reset_shader_cutoff

func reset_shader_cutoff() -> void

Resets the current material’s cutoff parameter instantly.

Signals

  • signal transition_done(transition_id): Emitted when the transition was played