Codename LogoCodename Logo

funkin.game.Stage

APIWikiTools

A class that handles loading a stage and putting the sprites into the state.

Static variables

View on GitHub

staticDEFAULT_ATTRIBUTES:Array<String> = ["name", "startCamPosX", "startCamPosY", "zoom", "folder"]

Static methods

View on GitHub

staticgetList(mods:Bool = false, xmlOnly:Bool = false):Array<String>

Gets a list of stages that are available to be used.

Parameters:

mods

Whenever only the mods folder should be checked

Constructor

View on GitHub

new(stage:String, ?state:FlxState, autoLoad:Bool = true)

Variables

characterPoses:Map<String, StageCharPos> = []

defaultZoom:Float = 1.05

extra:Map<String, Dynamic> = []

stageFile:String

stageName:String

stagePath:String

stageSprites:Map<String, FlxSprite> = []

stageXML:Access

startCam:FlxPoint = new FlxPoint()

state:FlxState

onAddSprite:FlxObject ‑> Void = null

onNodeFinished:(Access, Dynamic) ‑> Void = null

onNodeLoaded:(Access, Dynamic) ‑> Dynamic = null

onXMLLoaded:(Access, Array<Access>) ‑> Array<Access> = null

onXMLPostLoaded:(Access, Array<Access>) ‑> Array<Access> = null

Methods

View on GitHub

addCharPos(name:String, node:Access, ?nonXMLInfo:Null<StageCharPosInfo>):StageCharPos

Adds a character position to the stage.

Parameters:

name

The name of the character

node

The XML node

nonXMLInfo

(Optional) Non-XML information

View on GitHub

applyCharStuff(char:Character, posName:String, id:Float = 0):Void

Applies the character stuff to the character. Adds the character to the stage, or inserts it into the stage.

Parameters:

char

The character

posName

The name of the character position

id

The ID of the character

View on GitHub

beatHit(curBeat:Int):Void

View on GitHub

inlinegetSprite(name:String):Null<FlxSprite>

View on GitHub

inlineisCharFlipped(posName:String, def:Bool = false):Bool

Checks if a character is flipped or not.

Parameters:

posName

The name of the character position

def

The default value

View on GitHub

loadXml(xml:Access, forceLoadAll:Bool = false):Void

View on GitHub

measureHit(curMeasure:Int):Void

View on GitHub

setStagesSprites(script:Script):Void

Sets the sprites in the script, so you can access them by the name.

View on GitHub

stepHit(curStep:Int):Void