TransitionCommand
Extends: ESCBaseCommand < Resource
Description
transition transition_name mode [delay]
Runs a transition effect - generally used when entering or leaving a room.
Transitions are implemented as Godot shaders. Custom transitions can be made
by creating a shader in the game/scenes/transitions/shaders/
folder within
the escoria-core plugin folder.
Parameters
transition_name: Name of the transition shader from one of the transition directories
mode: Set to
in
to transition into orout
to transition out of the roomdelay: Delay in seconds before starting the transition (default:
1.0
)
@ESC
Method Descriptions
configure
func configure() -> ESCCommandArgumentDescriptor
Return the descriptor of the arguments of this command
validate
func validate(arguments: Array)
Validate whether the given arguments match the command descriptor
run
func run(command_params: Array) -> var
Run the command
interrupt
func interrupt()
Function called when the command is interrupted.