funkin.editors.stage.StageEditor - Codename Engine API

`staticdotCheckSize:Float = 53`

`staticread onlyinstance:StageEditor`

Static methods

View on GitHub

`staticcalcSpriteBounds(sprite:FunkinSprite):Array<FlxPoint>`

View on GitHub

`staticinlineexID(id:String):String`

Constructor

View on GitHub

`new(stage:String)`

Variables

`angleOffset:Float = 0`

`axisGizmo:AxisGizmo`

`charMap:Map<String, Character> = []`

`chars:Array<Character> = []`

`clickPoint:FlxPoint = new FlxPoint()`

`gizmosCamera:FlxCamera`

`mouseMode:StageEditorMouseMode = NONE`

`mousePoint:FlxPoint = new FlxPoint()`

`selection:Selection = new Selection()`

`showCharacters:Bool = true`

`stage:Stage`

`stageCamera:FlxCamera`

`stageSpritesWindow:StageSpritesWindow`

`storedAngle:Float = 0`

`storedPos:FlxPoint = new FlxPoint()`

`storedScale:FlxPoint = new FlxPoint()`

`storedSkew:FlxPoint = new FlxPoint()`

`topMenu:Array<UIContextMenuOption>`

`topMenuSpr:UITopMenu`

`uiCamera:FlxCamera`

`uiGroup:FlxTypedGroup<FlxSprite> = new FlxTypedGroup<FlxSprite>()`

`undos:UndoList<StageChange> = new UndoList<StageChange>()`

`xmlMap:Map<FlxObject, Access> = new Map<FlxObject,Access>()`

Methods

View on GitHub

`selectSprite(_sprite:FunkinSprite):Void`

Inherited Variables

Defined by UIState

`buttonHandler:() ‑> Void = null`

`curContextMenu:UIContextMenu = null`

`currentCursor:CodeCursor = ARROW`

`currentFocus:IUIFocusable = null`

`hoveredSprite:UISprite = null`

`uiCameras:Array<FlxCamera> = []`

Defined by MusicBeatState

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

Inherited Methods

Defined by UIState

View on GitHub

`closeCurrentContextMenu():Void`

View on GitHub

`displayNotification(notification:UIBaseNotification):Void`

View on GitHub

`isOverlapping(spr:UISprite, rect:FlxRect):Bool`

View on GitHub

`openContextMenu(options:Array<UIContextMenuOption>, ?callback:Null<UIContextMenuCallback>, ?x:Float, ?y:Float, ?w:Int):UIContextMenu`

View on GitHub

`updateButtonHandler(spr:UISprite, buttonHandler:() ‑> Void):Void`

View on GitHub

`updateRectButtonHandler(spr:UISprite, rect:FlxRect, buttonHandler:() ‑> Void):Void`

Defined by MusicBeatState

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 StageEditor

package funkin.editors.stage

extends UIState › MusicBeatState

Static variables

staticinlineread onlySPRITE_WINDOW_BUTTON_HEIGHT:Int = 64

staticinlineread onlySPRITE_WINDOW_WIDTH:Int = 400

staticdotCheckSize:Float = 53

staticread onlyinstance:StageEditor

Static methods

staticcalcSpriteBounds(sprite:FunkinSprite):Array<FlxPoint>

staticinlineexID(id:String):String

Constructor

new(stage:String)

Variables

angleOffset:Float = 0

axisGizmo:AxisGizmo

charMap:Map<String, Character> = []

chars:Array<Character> = []

clickPoint:FlxPoint = new FlxPoint()

gizmosCamera:FlxCamera

mouseMode:StageEditorMouseMode = NONE

mousePoint:FlxPoint = new FlxPoint()

selection:Selection = new Selection()

showCharacters:Bool = true

stage:Stage

stageCamera:FlxCamera

stageSpritesWindow:StageSpritesWindow

storedAngle:Float = 0

storedPos:FlxPoint = new FlxPoint()

storedScale:FlxPoint = new FlxPoint()

storedSkew:FlxPoint = new FlxPoint()

topMenu:Array<UIContextMenuOption>

topMenuSpr:UITopMenu

uiCamera:FlxCamera

uiGroup:FlxTypedGroup<FlxSprite> = new FlxTypedGroup<FlxSprite>()

undos:UndoList<StageChange> = new UndoList<StageChange>()

xmlMap:Map<FlxObject, Access> = new Map<FlxObject,Access>()

Methods

selectSprite(_sprite:FunkinSprite):Void

Inherited Variables

Defined by UIState

buttonHandler:() ‑> Void = null

curContextMenu:UIContextMenu = null

currentCursor:CodeCursor = ARROW

currentFocus:IUIFocusable = null

hoveredSprite:UISprite = null

uiCameras:Array<FlxCamera> = []

Defined by MusicBeatState

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

Inherited Methods

Defined by UIState

closeCurrentContextMenu():Void

displayNotification(notification:UIBaseNotification):Void

isOverlapping(spr:UISprite, rect:FlxRect):Bool

openContextMenu(options:Array<UIContextMenuOption>, ?callback:Null<UIContextMenuCallback>, ?x:Float, ?y:Float, ?w:Int):UIContextMenu

updateButtonHandler(spr:UISprite, buttonHandler:() ‑> Void):Void

updateRectButtonHandler(spr:UISprite, rect:FlxRect, buttonHandler:() ‑> Void):Void

Defined by MusicBeatState

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

`staticinlineread onlySPRITE_WINDOW_BUTTON_HEIGHT:Int = 64`

`staticinlineread onlySPRITE_WINDOW_WIDTH:Int = 400`

`staticdotCheckSize:Float = 53`

`staticread onlyinstance:StageEditor`

`staticcalcSpriteBounds(sprite:FunkinSprite):Array<FlxPoint>`

`staticinlineexID(id:String):String`

`new(stage:String)`

`angleOffset:Float = 0`

`axisGizmo:AxisGizmo`

`charMap:Map<String, Character> = []`

`chars:Array<Character> = []`

`clickPoint:FlxPoint = new FlxPoint()`

`gizmosCamera:FlxCamera`

`mouseMode:StageEditorMouseMode = NONE`

`mousePoint:FlxPoint = new FlxPoint()`

`selection:Selection = new Selection()`

`showCharacters:Bool = true`

`stage:Stage`

`stageCamera:FlxCamera`

`stageSpritesWindow:StageSpritesWindow`

`storedAngle:Float = 0`

`storedPos:FlxPoint = new FlxPoint()`

`storedScale:FlxPoint = new FlxPoint()`

`storedSkew:FlxPoint = new FlxPoint()`

`topMenu:Array<UIContextMenuOption>`

`topMenuSpr:UITopMenu`

`uiCamera:FlxCamera`

`uiGroup:FlxTypedGroup<FlxSprite> = new FlxTypedGroup<FlxSprite>()`

`undos:UndoList<StageChange> = new UndoList<StageChange>()`

`xmlMap:Map<FlxObject, Access> = new Map<FlxObject,Access>()`

`selectSprite(_sprite:FunkinSprite):Void`

`buttonHandler:() ‑> Void = null`

`curContextMenu:UIContextMenu = null`

`currentCursor:CodeCursor = ARROW`

`currentFocus:IUIFocusable = null`

`hoveredSprite:UISprite = null`

`uiCameras:Array<FlxCamera> = []`

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

`closeCurrentContextMenu():Void`

`displayNotification(notification:UIBaseNotification):Void`

`isOverlapping(spr:UISprite, rect:FlxRect):Bool`

`openContextMenu(options:Array<UIContextMenuOption>, ?callback:Null<UIContextMenuCallback>, ?x:Float, ?y:Float, ?w:Int):UIContextMenu`

`updateButtonHandler(spr:UISprite, buttonHandler:() ‑> Void):Void`

`updateRectButtonHandler(spr:UISprite, rect:FlxRect, buttonHandler:() ‑> Void):Void`

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