BattleBackground

┗> Object > Class


The battle background object. By default, this is a purple grid.

This gets automatically spawned during battles; if you'd like to disable or customize it, override Encounter:createBackground.


Constructor






Methods






BattleBackground:fadeOut()

Request the battle background to fade out. The background will automatically be removed once it has fully faded out.



BattleBackground:isFading()

Returns whether the battle background is currently fading out or not.

Returns:

1: boolean





Fields


BattleBackground.fading_out: boolean

Whether the background is currently fading out or not.


BattleBackground.move_speed: number

The speed at which the background scrolls.


BattleBackground.position: number

An offset used to scroll the background.


BattleBackground.position2: number

Another offset used to scroll the background.



Undocumented