funkin.backend.scripting.ModSubState

Static variables

View in GitHub

`staticlastData:Dynamic = null`

Last Optional extra data.

View in GitHub

`staticlastName:String = null`

Name of HScript file in assets/data/states.

Constructor

View in GitHub

`new(_stateName:String, ?_data:Dynamic)`

ModSubState Constructor. Inherits from MusicBeatSubstate and allows the execution of an HScript from assets/data/states passed via parameters.

Parameters:

`_stateName`	Name or path to a HScript file from assets/data/states.
`_data`	Optional extra Dynamic data passed from a previous state (JSON suggested).

Variables

`data:Dynamic = null`

Optional extra data.

Inherited Variables

Defined by MusicBeatSubstate

`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)

`parent:FlxState`

`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/PauseMenuSubstate.hx")

Inherited Methods

`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 in GitHub

`onSubstateOpen():Void`

View in GitHub

`openSubState(subState:FlxSubState):Void`

SCRIPTING STUFF