Files
gymkhana-actions/docs/api/ESCTransitionPlayer.md
Dennis Ploeger df78b52b8a feat: This enables user-defined transition and uses a tween to animate the transitions (#405)
* feat: This enables user-defined transition and uses a tween to animate the transitions

fixes #344

* docs: Automatic update of API docs

* docs: Automatic update of API docs

Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
2021-09-28 11:30:40 +02:00

1.1 KiB

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

Method Descriptions

transition

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

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.

Signals

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