class StoryMenuState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.ClassExtendMacro.build())

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

blackBar:FlxSprite

@:value(true)canSelect:Bool = true

@:value([])charFrames:Map<String, FlxFramesCollection> = []

characterSprites:FlxTypedGroup<MenuCharacterSprite>

@:value([])characters:Map<String, MenuCharacter> = []

@:value(0)curDifficulty:Int = 0

@:value(0)curWeek:Int = 0

@:value([])difficultySprites:Map<String, FlxSprite> = []

@:value(0)intendedScore:Int = 0

leftArrow:FlxSprite

@:value(0)lerpScore:Float = 0

rightArrow:FlxSprite

scoreText:FlxText

tracklist:FlxText

weekBG:FlxSprite

weekSprites:FlxTypedGroup<MenuItem>

weekTitle:FlxText

@:value([])weeks:Array<WeekData> = []

Methods

addCharacter(charName:String):Void

@:value({ force : false })changeDifficulty(change:Int, force:Bool = false):Void

@:value({ force : false })changeWeek(change:Int, force:Bool = false):Void

getWeeksFromSource(weeks:Array<String>, source:AssetSource):Bool

goBack():Void

loadXMLs():Void

selectWeek():Void

Inherited Variables

Defined by MusicBeatState

@:value(false)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)

@:value(new GraphicCacheSprite())graphicCache:GraphicCacheSprite = new GraphicCacheSprite()

Dummy sprite used to cache graphics to GPU.

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

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

Inherited Methods

Defined by MusicBeatState

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

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

@:value({ fpsSensitive : false })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.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF