Background Transition Effects

When changing background appearance with @back action, you can additionally specify which transition effect to use. For example, following action will transition to "River" background using "DropFade" transition effect:

@back River.DropFade

When no transition effect is specified a cross-fade is used by default.

You can also specify duration of the transition (in seconds) with the time parameter:

@back River.DropFade time:1.5

The above statement will transition to "River" background using "DropFade" transition over 1.5 seconds. Default time for all transitions is 0.35 seconds.

In case you wish to skip to the next action immediately after executing the transition (and not wait for the duration of the effect), you can set wait parameter to false. E.g.:

@back River.Ripple time:1.5 wait:false
@bgm PianoTheme

— "PianoTheme" background music will start playing right away and won't be delayed for 1.5 seconds, while the transition is in progress.

Some of the transition effects also support additional parameters, which you can control with params parameter:

@back River.Ripple params:10,5,0.02

— will set frequency of the ripple effect to 10, speed to 5 and amplitude to 0.02. When no params is specified, default parameters will be used.

If you wish to modify selected parameters, you can skip others and they'll have their default values:

@back River.Ripple params:,,0.02

You can find available transition effects with their parameters and default values in the docs below.

Parameters are listed in the following format: params:ParamName(DefaultValue) Where ParamName is the name of the parameter and DefaultValue is the default value of the parameter.

BandedSwirl

params:twistAmount(5),frequency(10)

Blinds

params:count(6)

CircleReveal

params:fuzzyAmount(0.25)

CircleStretch

params:none

CloudReveal

params:none

Crossfade

params:none

Crumble

params:none

Disolve

params:step(99999)

DropFade

params:none

LineReveal

params:fuzzyAmount(0.25),lineNormalX(0.5),lineNormalY(0.5)

Pixelate

params:none

RadialBlur

params:none

RadialWiggle

params:none

RandomCircleReveal

params:none

Ripple

params:frequency(20),speed(10),amplitude(0.5)

RotateCrumble

params:none

Saturate

params:none

Shrink

params:speed(200)

SlideIn

params:slideAmount(1)

SwirlGrid

params:twistAmount(15),cellCount(10)

Swirl

params:twistAmount(15)

Water

params:none

Waterfall

params:none

Wave

params:magnitude(0.1),phase(14),frequency(20)