interface PlayStateScript

package scripting

@:hxGen

Contains all callbacks you can add in modcharts and stage scripts.

NOTE: In case you're scripting a stage, all sprites of that stage are directly accessible via their name. Ex: If you added a superCoolBG element in your stage XML, you'll be able to access it via scripts by using superCoolBG.

Methods

beatHit(curBeat:Int):Void

Triggered every beat.

Parameters:

curBeat

Current beat.

create():Void

Triggered after the characters has been created, during PlayState's creation.

createPost():Void

Triggered at the very end of PlayState's creation

inputUpdate(note:InputSystemEvent):Void

Triggered whenever the input system updates.

Parameters:

note

Event object with the pressed notes, which allows you to alter which notes are being pressed during this frame, or simply cancel the input update.

inputUpdatePost(note:InputSystemEvent):Void

Triggered after the input system updates.

Parameters:

note

Event object with the pressed, justPressed and justReleased notes.

onDadHit(note:NoteHitEvent):Void

Triggered whenever the opponent hits a note.

Parameters:

note

Event object with the note being pressed, the character who pressed it, and functions to alter or cancel the default behaviour.

onPlayerHit(note:NoteHitEvent):Void

Triggered whenever the player hits a note.

Parameters:

note

Event object with the note being pressed, the character who pressed it, and functions to alter or cancel the default behaviour.

stepHit(curStep:Int):Void

Triggered every step

Parameters:

curStep

Current step.

update(elapsed:Float):Void

Triggered every frame.

Parameters:

elapsed

Time elapsed since last frame.

updatePost(elapsed:Float):Void

Triggered at the end of every frame.

Parameters:

elapsed

Time elapsed since last frame.