funkin.backend.MusicBeatState

Base class for all the states. Handles the scripts, the transitions, and the beat and step events.

`staticskipTransOut:Bool = false`

Constructor

View on GitHub

`new(scriptsAllowed:Bool = true, ?scriptName:String)`

Variables

`cancelConductorUpdate:Bool = false`

Whenever the Conductor auto update should be enabled or not.

`read onlycontrols:Controls`

Game Controls. (All players / Solo)

`read onlycontrolsP1:Controls`

Game Controls (Player 1 only)

`read onlycontrolsP2:Controls`

Game Controls (Player 2 only)

`read onlycurBeat:Int`

Current beat

`read onlycurBeatFloat:Float`

Current beat, as a Float (ex: 1.24, instead of 1)

`read onlycurMeasure:Int`

Current beat

`read onlycurMeasureFloat:Float`

Current beat, as a Float (ex: 1.24, instead of 1)

`read onlycurStep:Int`

Current step

`read onlycurStepFloat:Float`

Current step, as a Float (ex: 4.94, instead of 4)

`graphicCache:GraphicCacheSprite = new GraphicCacheSprite()`

Dummy sprite used to cache graphics to GPU.

`scriptName:String = null`

`scriptsAllowed:Bool = true`

`read onlysongPos:Float`

Current song position (in milliseconds).

`stateScripts:ScriptPack`

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: data/states/FreeplayState)

Methods

View on GitHub

`call(name:String, ?args:Array<Dynamic>, ?defaultVal:Dynamic):Dynamic`

View on GitHub

`event<T>(name:String, event:T):T`

View on GitHub

`lerp(v1:Float, v2:Float, ratio:Float, fpsSensitive:Bool = false):Float`

Shortcut to FlxMath.lerp or CoolUtil.lerp, depending on fpsSensitive

Parameters:

`v1`	Value 1
`v2`	Value 2
`ratio`	Ratio
`fpsSensitive`	Whenever the ratio should not be adjusted to run at the same speed independent of framerate.

View on GitHub

`openSubState(subState:FlxSubState):Void`

SCRIPTING STUFF

View on GitHub

class MusicBeatState

package funkin.backend

extends FlxState

implements IBeatReceiver

extended by ModState, UIState, PlayState, FreeplayState, GitarooPause, MainMenuState, StoryMenuState, TitleState, WarningState

Static variables

`staticALLOW_DEV_RELOAD:Bool = true`

`staticlastScriptName:String = null`

`staticlastStateName:String = null`

`staticskipTransIn:Bool = false`

`staticskipTransOut:Bool = false`

Constructor

`new(scriptsAllowed:Bool = true, ?scriptName:String)`

Variables

`cancelConductorUpdate:Bool = false`

`read onlycontrols:Controls`

`read onlycontrolsP1:Controls`

`read onlycontrolsP2:Controls`

`read onlycurBeat:Int`

`read onlycurBeatFloat:Float`

`read onlycurMeasure:Int`

`read onlycurMeasureFloat:Float`

`read onlycurStep:Int`

`read onlycurStepFloat:Float`

`graphicCache:GraphicCacheSprite = new GraphicCacheSprite()`

`scriptName:String = null`

`scriptsAllowed:Bool = true`

`read onlysongPos:Float`

`stateScripts:ScriptPack`

Methods

`call(name:String, ?args:Array<Dynamic>, ?defaultVal:Dynamic):Dynamic`

`event<T>(name:String, event:T):T`

`lerp(v1:Float, v2:Float, ratio:Float, fpsSensitive:Bool = false):Float`

`openSubState(subState:FlxSubState):Void`

`startTransition(?newState:FlxState, skipSubStates:Bool = false):Bool`