Stage Script

Empty Script

Example stage scripts can be found here.

function create() {}
function update(elapsed:Float) {}
function sectionHit(section:Int) {}
function beatHit(beat:Int) {}
function stepHit(step:Int) {}

How to use

Make a stage script at stages/<stagenamehere>/init.hxs. You can put your assets in the same folder.

Unlike other script types, Paths searches for local paths like the assets folder instead of at the top layer. This means Paths.image("bg") will look for stages/<stagenamehere>/images/bg.png. If you'd prefer the standard method of searching, make the first line in your create callback Paths.useFullDir = false;.

Make your sprites and add them via the add function.

Variables

• stage: The current stage class (an extended FlxTypedGroup). Used to edit your stage.
• stage.publicSprites: A Map for public sprite variables. Add sprites here if you want to mess with them outside of the stage script.
• stage.foreground: A FlxTypedGroup that gets added after the rest of the sprites.
• stage.infrontOfGf: A FlxTypedGroup that gets added in front of girlfriend. (i hate limo so much)
• Paths: A custom paths instance that only reads for files inside the <stagenamehere> directory.
• _Paths: The global paths instance.

PlayState variables

• PlayState.defaultCamZoom: A float value for how zoomed in the camera is on your stage. (default: 1.05)
• PlayState.curUi: A string value for which ui type (strums, notes and combo) should be used. (Game comes with support for "normal" and "pixel")
• PlayState.startOn: A dynamic value that allows you to set where the camera begins at on your stage, this can be either "bf", "gf", "dad" or an array with 2 floats.
• PlayState.moveCam(val:Dynamic): Same as above, but it's a function you can call mid-game.

Callbacks

Required

• create(): This is where you actually create all your stage variables.

Optional

• createPost(): A function called after the stage, bf (PlayState.bf), gf (PlayState.gf) and dad (PlayState.dad) are created, recommended use of this callback would be repositioning characters.
• event(event:String, value1:String, value2:String): Called every time an event is invoked from the PlayState.
• stepHit(step:Int): Called every time a step is hit from the PlayState. Good for making background characters bop.
• beatHit(beat:Int): Called every time a beat is hit from the PlayState.
• sectionHit(section:Int): Called every time a section is hit from the PlayState.
• update(elapsed:Float): Called every frame.