OS Engine HScript API: Functions - notweuz/FNF-OSEngine GitHub Wiki

HScript functions

You can use HScripts almost like Lua scripts. There are several features here to help you:

update(elapsed:Float)

HScript API will fire it with (elapsed).

create()

HScript API will fire it on creating state.

beatHit(beat:Int)

HScript API will fire it on beat hit.

noteMissPress(key)

HScript API will fire it on pressing key w/o notes (ghosttapping must be disabled

onKeyPress(key:Int)

HScript API will fire it when pressing controls.

noteMiss(id, noteData, noteType, isSustainNote)

HScript API will fire it when player is missed note.

goodNoteHit(id, noteData, noteType, isSustainNote)

HScript API will fire it when player is pressing note.

opponentNoteHit(id, noteData, noteType, isSustainNote)

HScript API will fire it when player is pressing note.