Scripting Documentation - LilbrosGits/Funkin-Sockit-Engine GitHub Wiki
States
Calling Classes
you can call classes like this flixel.FlxG
or lime.utils.Assets
with funkin stuff it would be like funkin.objects.Note
or funkin.states.PlayState
but only for certain classes you can just refer to the class names
this is the list of classes that u can call the names for commonly:
FlxG
FlxMath
FlxBasic
FlxObject
FlxSprite
FlxTypedGroup
HAS ISSUESFlxGroup
ISNT TESTEDReflect
Path
the games core asset finding systemInit
the games initializer
Calling Functions
these are all functions that are connected to running the game
new()
initialize variables here normallyonCreate()
before anything is created (may cause issues with calling certain things!)onCreatePost()
after everything is createdonUpdate(elapsed:Float)
before the game updatesonUpdatePost(elapsed:Float)
after the game updatesonBeat()
every beat (if music is playing)onStep()
every step (if music is playing)
Modcharting (ONLY IN PLAYSTATE)
these are the extra functions and variables that are only accessed in playstate
Functions
onPause()
when the game is pausedonResume()
when the game is resumedonNoteHit(note:Note)
when a note is hitonOpponentNoteHit(note:Note)
when the opponent hits a noteonNoteMiss(note:Note)
when a note is missedonSongStart()
when the song starts
Variables
stage
the stagenotes
the note hud (useful)hud
the playstate hudplayers
the playersthis
the state (PlayState) use to get variables that arent documented yet