Skip to content

Background Switch

Description

Switch the background scene of the game scene, with support for transition effects.

Syntax

text
background [background resource name] <effect type>

Parameters

ParameterRequiredExampleDescription
Background resource nameYesmorning_forestBackground name configured in the background list
Effect typeNofadeTransition effect (default: instant switch)

Supported Effect Types

The following background switching effects are supported. Each effect has its own visual style:

EffectDescription
noneInstant switch
fadeFade in/out
eraseErase
blindsBlinds
waveWave
vortexVortex
windmillWindmill
cyberglitchCyber glitch

If no effect type is specified, none (instant switch) is used by default.

Examples

text
# Switch from daytime to night (fade effect)
background night_street fade

# Battle scene switch (instant switch)
background battle_field none

# Memory scene (erase effect)
background memory_flash erase

# Dream scene (vortex effect)
background dream vortex

Released under BSD3-Clause License.