Skip to main content

Screen

Events for controlling screen-level settings such as VDP configuration, HBlank/VBlank scripts, and fade effects.

Actions​

Fade Palette In​

Fade the selected palette from blank.
Fade Palette In
Palette Slot
PAL0
Duration
0.5
Wait until finished
  • Palette Slot: The palette slot you want to use.
  • Duration: The length of time needed to perform the fade in seconds or frames.
  • Wait until finished: Set if script should pause until fade has finished.

Fade Palette Out​

Fade the selected palette to blank.
Fade Palette Out
Palette Slot
PAL0
Duration
0.5
Wait until finished
  • Palette Slot: The palette slot you want to use.
  • Duration: The length of time needed to perform the fade in seconds or frames.
  • Wait until finished: Set if script should pause until fade has finished.

Fade To Palette​

Fade the screen colours towards the selected palettes, for example an all-white palette.
Fade To Palette
Palettes
0: Palette 0                                                                             
1: Palette 1                                                                             
2: Palette 2                                                                             
3: Palette 3                                                                             
Duration
0.5
Wait until finished

Fade To Color​

Fade the whole screen towards a single colour, for example white.
Fade To Color
Duration
0.5
R
255
G
255
B
255
Unknown Type preview
Wait until finished

VDP Tiles Setup​

OnStart/OnEnd: Change how the VDP Tiles are distributed.
VDP Tiles Setup
VPD Tile Setup
  • VPD Tile Setup: How the VDP tiles are distributed between Background/Foreground, Sprites and Fonts.

VDP Tiles Restore​

OnStart/OnEnd: Restore how the VDP Tiles are distributed to the project default settings.
VDP Tiles Restore
OnStart/OnEnd: Restore how the VDP Tiles are distributed to the project default settings.

Blanks​

Blank: If Scanline Is​

Conditionally run part of the script if the current scanline number match the given value.
Blank: If Scanline Is
Scanline Counter
0
True
Add Event
  • Scanline Counter: Number of scanlines between script calls.

Blank: Palette Set Color​

Change the selected color from the selected palette to the values given. This event is only usable for HBlank scripts.
Blank: Palette Set Color
Palette Slot
PAL0
Color Index
0
Color
R
255
G
255
B
255
Unknown Type preview
Line tolerance
0
  • Palette Slot: The palette slot you want to use.
  • Color Index: The color index to use inside the palette.
  • Color

Blank: Palette Set Color From Palette​

Change the selected color from the selected palette to the selected one.
Blank: Palette Set Color From Palette
Palette Slot
PAL0
Color Index
0
Palette to copy the color from:
Palette
0: Palette 0                                                                             
Color Index
0
Line tolerance
0
  • Palette Slot: The palette slot you want to use.
  • Color Index: The color index to use inside the palette.
  • Palette: The new palette to use.
  • Color Index: The color index to use inside the palette.

Blank: Scroll Set Value​

Set the plane scroll to a new value.
Blank: Scroll Set Value
Plane
Background
Direction
Horizontal
Value
0
This event only sets the plane scroll mode, tile and line modes can't be updated during HBlank.
Preview
Unknown Type preview
  • Plane: The plane we want to use
  • Direction: The scroll direction to set.
  • Value: The value you want to set.

Blank: Window Plane Disable​

Disable Window Plane.
Blank: Window Plane Disable
Disable the Window Plane

Blank: Window Plane Enable​

Enable Window Plane with the given parameters.
Blank: Window Plane Enable
Stick X
Left
Width
40
Stick Y
Bottom
Height
8
  • Stick X: The side of the screen to stick on the X axis.
  • Width: The width to draw the window.
  • Stick Y: The side of the screen to stick on the Y axis.
  • Height: The height to draw the window.

OnStart: Set Horizontal Blank Script​

Run the specified script after during a tiny pause in drawing each line, useful for simple palette or scroll tricks. Only events that are labeled with 'Blank:' or 'VBlank:' can be used.
OnStart: Set Horizonal Blank Script
Run the specified script after during a tiny pause in drawing each line, useful for simple palette or scroll tricks. Only events that are labeled with 'Blank:' or 'VBlank:' can be used.
Scanline Counter
0
On Horizontal Blank
On Horizontal Blank
Add Event
  • Scanline Counter: Number of scanlines between script calls.
  • On Horizontal Blank: The script to run when during the Horizontal Blank.

OnStart: Set Vertical Blank Script​

Run the specified script after during a tiny pause in drawing the screen, useful to restore palette and scroll changes. Only events that are labeled with 'Blank:' or 'HBlank:' can be used.
OnStart: Set Vertical Blank Script
Run the specified script after during a tiny pause in drawing the screen, useful to restore palette and scroll changes. Only events that are labeled with 'Blank:' or 'HBlank:' can be used.
On Vertical Blank
On Vertical Blank
Add Event
  • On Vertical Blank: The script to run when during the Vertical Blank.

Scene Disable Blank Scripts​

Disable the Verital & Horizonal Blank scripts.
Scene Disable Blank Scripts
Disable the Verital & Horizonal Blank scripts.

Scene Enable Blank Scripts​

Enable the Verital & Horizonal Blank scripts.
Scene Enable Blank Scripts
Enable the Verital & Horizonal Blank scripts.

Set HBlank Scanline Counter​

Set the number of scanlines between HBlank script calls.
Set HBlank Scanline Counter
Scanline Counter
0
  • Scanline Counter: Number of scanlines between script calls.

VBlank: Scroll Restore​

Restore the original camera scroll on the given plane.
VBlank: Scroll Restore
Plane
Background
Direction
Horizontal
This event will be needed to avoid strange artifacts when modifying the scroll during HBlank.
  • Plane: The plane we want to use
  • Direction: The scroll direction to set.

Raster Effects​

Raster Gradient: Set​

Blends one palette color from a top color to a bottom color, scanline by scanline, between two scanlines. Outside those scanlines the color keeps its palette value. Color 0 of the first background palette is the backdrop, which makes a sky gradient. A new gradient replaces the previous one.
Raster Gradient: Set
Palette Slot
PAL0
Color Index
0
Top color
R
0
G
0
B
64
Bottom color
R
128
G
192
B
255
First scanline
0
Last scanline
223
Preview
Unknown Type preview

Raster Gradient: Clear​

Removes the raster gradient and the other per-scanline color effects.
Raster Gradient: Clear
Removes the raster gradient and the other per-scanline color effects.

Line Wave: Start​

Offsets each scanline of a plane by a sine wave between two scanlines, for water, heat haze or dream effects. The wave moves by the speed in scanlines every frame and adds to the plane's scroll.
Line Wave: Start
Plane
Background
Axis
Horizontal
Amplitude
4
Wavelength
32
Speed
1
First scanline
0
Last scanline
223
Wave preview
Unknown Type preview

Line Wave: Stop​

Removes the line wave from a plane and restores its plain scroll.
Line Wave: Stop
Plane
Background

Planes​

Plane Clear​

Clear the entire content drawn on the selected plane. Optionally reset its scroll values.
Plane Clear
Plane
Background
Reset Scroll
  • Plane: The plane we want to use
  • Reset Scroll: Also reset the scroll values and parallax state for this plane.

Window Plane Enable​

Enable Window Plane with the given parameters.
Window Plane Enable
Stick X
Left
Width
40
Stick Y
Bottom
Height
8
  • Stick X: The side of the screen to stick on the X axis.
  • Width: The width to draw the window.
  • Stick Y: The side of the screen to stick on the Y axis.
  • Height: The height to draw the window.

Window Plane Disable​

Disable Window Plane.
Window Plane Disable
Disable the Window Plane

Properties​

Hilight / Shadow Enable​

Enable Hilight / Shadow effect.
Hilight / Shadow Enable
Enable Hilight / Shadow effect

Hilight / Shadow Disable​

Disable Hilight / Shadow effect.
Hilight / Shadow Disable
Disable Hilight / Shadow effect