funkin.editors.charter.Charter - Codename Engine API

Static variables

`static__song:String`

View in GitHub

`@:value(0)staticautoSaveTimer:Float = 0`

View in GitHub

`@:value([])staticclipboard:Array<CharterCopyboardObject> = []`

`staticread onlyinstance:Charter`

`staticplaytestInfo:PlaytestInfo`

`staticselection:Selection`

View in GitHub

`@:value(false)staticstartHere:Bool = false`

View in GitHub

`@:value(0)staticstartTime:Float = 0`

`staticundos:UndoList<CharterChange>`

`staticwaveformHandler:CharterWaveformHandler`

Constructor

View in GitHub

`@:value({ reload : true })new(song:String, diff:String, reload:Bool = true)`

Variables

`@:value(0)__endStep:Float = 0`

`addEventSpr:CharterEventAdd`

`autoSaveNotif:CharterAutoSaveUI`

`charterBG:FunkinSprite`

`charterCamera:FlxCamera`

`@:value(new FlxPoint())dragStartPos:FlxPoint = new FlxPoint()`

`eventsBackdrop:EventBackdrop`

`@:value(new CharterEventGroup())eventsGroup:CharterEventGroup = new CharterEventGroup()`

`@:value(NONE)gridActionType:CharterGridActionType = NONE`

NOTE AND CHARTER GRID LOGIC HERE

`gridBackdropDummy:CharterBackdropDummy`

`gridBackdrops:CharterBackdropGroup`

`hitsound:FlxSound`

`metronome:FlxSound`

`@:value(new FlxPoint())mousePos:FlxPoint = new FlxPoint()`

`noteDeleteAnims:CharterDeleteAnim`

`noteHoverer:CharterNoteHoverer`

`@:value(0)noteType:Int = 0`

`noteTypeText:UIText`

`@:value([])noteTypes:Array<String> = []`

`@:value(new CharterNoteGroup())notesGroup:CharterNoteGroup = new CharterNoteGroup()`

`playBackSlider:UISlider`

`@:value(16)quant:Int = 16`

`@:value([])quantButtons:Array<CharterQuantButton> = []`

`@:value([4, 8, 12, 16, 20, 24, 32, 48, 64, 192])quants:Array<Int> = [4, 8, 12, 16, 20, 24, 32, 48, 64, 192]`

`scrollBar:UIScrollBar`

`selectionBox:UISliceSprite`

`@:value(false)selectionDragging:Bool = false`

`songPosInfo:UIText`

`@:value(new CharterStrumLineGroup())strumLines:CharterStrumLineGroup = new CharterStrumLineGroup()`

`strumlineAddButton:CharterStrumlineButton`

`strumlineInfoBG:FlxSprite`

`strumlineLockButton:CharterStrumlineButton`

`topMenu:Array<UIContextMenuOption>`

`topMenuSpr:UITopMenu`

`uiCamera:FlxCamera`

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

`vocals:FlxSound`

`@:value({ checkSelection : true })inlinechangeNoteType(?newID:Int, checkSelection:Bool = true):Void`

View in GitHub

`@:value({ addToUndo : true })createSelection(selection:Selection, addToUndo:Bool = true):Array<Unknown>`

View in GitHub

`createStrumWithUI():Void`

View in GitHub

`@:value({ createNotes : true, addToUndo : true })createStrumline(strumLineID:Int, strL:ChartStrumLine, addToUndo:Bool = true, createNotes:Bool = true):Void`

View in GitHub

`@:value({ addToUndo : true })deleteSelection(selection:Selection, addToUndo:Bool = true):Array<ICharterSelectable>`

View in GitHub

`@:value({ addToUndo : true })deleteSingleSelection(selected:ICharterSelectable, addToUndo:Bool = true):Null<ICharterSelectable>`

View in GitHub

`@:value({ addToUndo : true })deleteStrumline(strumLineID:Int, addToUndo:Bool = true):Void`

View in GitHub

`inlinedeleteStrumlineFromData(strL:ChartStrumLine):Void`

View in GitHub

`inlineeditStrumline(strL:ChartStrumLine):Void`

View in GitHub

`getHoveredEvent(y:Float):CharterEvent`

View in GitHub

`getStrumlineID(strL:ChartStrumLine):Int`

View in GitHub

`inlinehitsoundsEnabled(id:Int):Bool`

View in GitHub

`loadSong():Void`

View in GitHub

`@:value({ here : false, opponentMode : false, time : 0 })playtestChart(time:Float = 0, opponentMode:Bool = false, here:Bool = false):Void`

View in GitHub

`quantStep(step:Float):Float`

View in GitHub

`@:value({ roundRatio : 0.5 })quantStepRounded(step:Float, roundRatio:Float = 0.5):Float`

View in GitHub

`ratioRound(val:Float, ratio:Float):Int`

View in GitHub

`refreshBPMSensitive():Void`

View in GitHub

`inlineremoveStrumlineFromSelection(strumLineID:Int):Void`

View in GitHub

`updateAutoSaving(elapsed:Float):Void`

View in GitHub

`updateBPMEvents():Void`

View in GitHub

`updateNoteLogic(elapsed:Float):Void`

View in GitHub

`updateSelectionLogic():Void`

View in GitHub

`updateWaveforms():Void`

Inherited Variables

Defined by UIState

`@:value(null)buttonHandler:() ‑> Void = null`

`@:value(null)curContextMenu:UIContextMenu = null`

`@:value(ARROW)currentCursor:MouseCursor = ARROW`

`@:value(null)currentFocus:IUIFocusable = null`

`@:value(null)hoveredSprite:UISprite = null`

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

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

`closeCurrentContextMenu():Void`

View in GitHub

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

View in GitHub

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

View in GitHub

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

View in GitHub

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

View in GitHub

`inlineupdateSpriteRect(spr:UISprite):Void`

Defined by MusicBeatState

View in GitHub

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

View in GitHub

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

View in GitHub

`@: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.

View in GitHub

`openSubState(subState:FlxSubState):Void`

SCRIPTING STUFF

class Charter

package funkin.editors.charter

extends UIState › MusicBeatState

Static variables

static__song:String

@:value(0)staticautoSaveTimer:Float = 0

@:value([])staticclipboard:Array<CharterCopyboardObject> = []

staticread onlyinstance:Charter

staticplaytestInfo:PlaytestInfo

staticselection:Selection

@:value(false)staticstartHere:Bool = false

@:value(0)staticstartTime:Float = 0

staticundos:UndoList<CharterChange>

staticwaveformHandler:CharterWaveformHandler

Constructor

@:value({ reload : true })new(song:String, diff:String, reload:Bool = true)

Variables

@:value(0)__endStep:Float = 0

addEventSpr:CharterEventAdd

autoSaveNotif:CharterAutoSaveUI

charterBG:FunkinSprite

charterCamera:FlxCamera

@:value(new FlxPoint())dragStartPos:FlxPoint = new FlxPoint()

eventsBackdrop:EventBackdrop

@:value(new CharterEventGroup())eventsGroup:CharterEventGroup = new CharterEventGroup()

@:value(NONE)gridActionType:CharterGridActionType = NONE

gridBackdropDummy:CharterBackdropDummy

gridBackdrops:CharterBackdropGroup

hitsound:FlxSound

metronome:FlxSound

@:value(new FlxPoint())mousePos:FlxPoint = new FlxPoint()

noteDeleteAnims:CharterDeleteAnim

noteHoverer:CharterNoteHoverer

@:value(0)noteType:Int = 0

noteTypeText:UIText

@:value([])noteTypes:Array<String> = []

@:value(new CharterNoteGroup())notesGroup:CharterNoteGroup = new CharterNoteGroup()

playBackSlider:UISlider

@:value(16)quant:Int = 16

@:value([])quantButtons:Array<CharterQuantButton> = []

@:value([4, 8, 12, 16, 20, 24, 32, 48, 64, 192])quants:Array<Int> = [4, 8, 12, 16, 20, 24, 32, 48, 64, 192]

scrollBar:UIScrollBar

selectionBox:UISliceSprite

@:value(false)selectionDragging:Bool = false

songPosInfo:UIText

@:value(new CharterStrumLineGroup())strumLines:CharterStrumLineGroup = new CharterStrumLineGroup()

strumlineAddButton:CharterStrumlineButton

strumlineInfoBG:FlxSprite

strumlineLockButton:CharterStrumlineButton

topMenu:Array<UIContextMenuOption>

topMenuSpr:UITopMenu

uiCamera:FlxCamera

@:value(new FlxTypedGroup&lt;FlxSprite&gt;())uiGroup:FlxTypedGroup<FlxSprite> = new FlxTypedGroup<FlxSprite>()

vocals:FlxSound

Methods

inline__fixSelection(selection:Selection):Selection

buildChart():Void

buildEvents():Void

inlinebuildNote(note:CharterNote):ChartNote

@:value({ checkSelection : true })inlinechangeNoteType(?newID:Int, checkSelection:Bool = true):Void

@:value({ addToUndo : true })createSelection(selection:Selection, addToUndo:Bool = true):Array<Unknown>

createStrumWithUI():Void

@:value({ __createNotes : true, addToUndo : true })createStrumline(strumLineID:Int, strL:ChartStrumLine, addToUndo:Bool = true, __createNotes:Bool = true):Void

@:value({ addToUndo : true })deleteSelection(selection:Selection, addToUndo:Bool = true):Array<ICharterSelectable>

@:value({ addToUndo : true })deleteSingleSelection(selected:ICharterSelectable, addToUndo:Bool = true):Null<ICharterSelectable>

@:value({ addToUndo : true })deleteStrumline(strumLineID:Int, addToUndo:Bool = true):Void

inlinedeleteStrumlineFromData(strL:ChartStrumLine):Void

inlineeditStrumline(strL:ChartStrumLine):Void

getHoveredEvent(y:Float):CharterEvent

getStrumlineID(strL:ChartStrumLine):Int

inlinehitsoundsEnabled(id:Int):Bool

loadSong():Void

@:value({ here : false, opponentMode : false, time : 0 })playtestChart(time:Float = 0, opponentMode:Bool = false, here:Bool = false):Void

quantStep(step:Float):Float

@:value({ roundRatio : 0.5 })quantStepRounded(step:Float, roundRatio:Float = 0.5):Float

ratioRound(val:Float, ratio:Float):Int

refreshBPMSensitive():Void

inlineremoveStrumlineFromSelection(strumLineID:Int):Void

updateAutoSaving(elapsed:Float):Void

updateBPMEvents():Void

`static__song:String`

`@:value(0)staticautoSaveTimer:Float = 0`

`@:value([])staticclipboard:Array<CharterCopyboardObject> = []`

`staticread onlyinstance:Charter`

`staticplaytestInfo:PlaytestInfo`

`staticselection:Selection`

`@:value(false)staticstartHere:Bool = false`

`@:value(0)staticstartTime:Float = 0`

`staticundos:UndoList<CharterChange>`

`staticwaveformHandler:CharterWaveformHandler`

`@:value({ reload : true })new(song:String, diff:String, reload:Bool = true)`

`@:value(0)__endStep:Float = 0`

`addEventSpr:CharterEventAdd`

`autoSaveNotif:CharterAutoSaveUI`

`charterBG:FunkinSprite`

`charterCamera:FlxCamera`

`@:value(new FlxPoint())dragStartPos:FlxPoint = new FlxPoint()`

`eventsBackdrop:EventBackdrop`

`@:value(new CharterEventGroup())eventsGroup:CharterEventGroup = new CharterEventGroup()`

`@:value(NONE)gridActionType:CharterGridActionType = NONE`

`gridBackdropDummy:CharterBackdropDummy`

`gridBackdrops:CharterBackdropGroup`

`hitsound:FlxSound`

`metronome:FlxSound`

`@:value(new FlxPoint())mousePos:FlxPoint = new FlxPoint()`

`noteDeleteAnims:CharterDeleteAnim`

`noteHoverer:CharterNoteHoverer`

`@:value(0)noteType:Int = 0`

`noteTypeText:UIText`

`@:value([])noteTypes:Array<String> = []`

`@:value(new CharterNoteGroup())notesGroup:CharterNoteGroup = new CharterNoteGroup()`

`playBackSlider:UISlider`

`@:value(16)quant:Int = 16`

`@:value([])quantButtons:Array<CharterQuantButton> = []`

`@:value([4, 8, 12, 16, 20, 24, 32, 48, 64, 192])quants:Array<Int> = [4, 8, 12, 16, 20, 24, 32, 48, 64, 192]`

`scrollBar:UIScrollBar`

`selectionBox:UISliceSprite`

`@:value(false)selectionDragging:Bool = false`

`songPosInfo:UIText`

`@:value(new CharterStrumLineGroup())strumLines:CharterStrumLineGroup = new CharterStrumLineGroup()`

`strumlineAddButton:CharterStrumlineButton`

`strumlineInfoBG:FlxSprite`

`strumlineLockButton:CharterStrumlineButton`

`topMenu:Array<UIContextMenuOption>`

`topMenuSpr:UITopMenu`

`uiCamera:FlxCamera`

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

`vocals:FlxSound`

`inline__fixSelection(selection:Selection):Selection`

`buildChart():Void`

`buildEvents():Void`

`inlinebuildNote(note:CharterNote):ChartNote`

`@:value({ checkSelection : true })inlinechangeNoteType(?newID:Int, checkSelection:Bool = true):Void`

`@:value({ addToUndo : true })createSelection(selection:Selection, addToUndo:Bool = true):Array<Unknown>`

`createStrumWithUI():Void`

`@:value({ createNotes : true, addToUndo : true })createStrumline(strumLineID:Int, strL:ChartStrumLine, addToUndo:Bool = true, createNotes:Bool = true):Void`

`@:value({ addToUndo : true })deleteSelection(selection:Selection, addToUndo:Bool = true):Array<ICharterSelectable>`

`@:value({ addToUndo : true })deleteSingleSelection(selected:ICharterSelectable, addToUndo:Bool = true):Null<ICharterSelectable>`

`@:value({ addToUndo : true })deleteStrumline(strumLineID:Int, addToUndo:Bool = true):Void`

`inlinedeleteStrumlineFromData(strL:ChartStrumLine):Void`

`inlineeditStrumline(strL:ChartStrumLine):Void`

`getHoveredEvent(y:Float):CharterEvent`

`getStrumlineID(strL:ChartStrumLine):Int`

`inlinehitsoundsEnabled(id:Int):Bool`

`loadSong():Void`

`@:value({ here : false, opponentMode : false, time : 0 })playtestChart(time:Float = 0, opponentMode:Bool = false, here:Bool = false):Void`

`quantStep(step:Float):Float`

`@:value({ roundRatio : 0.5 })quantStepRounded(step:Float, roundRatio:Float = 0.5):Float`

`ratioRound(val:Float, ratio:Float):Int`

`refreshBPMSensitive():Void`

`inlineremoveStrumlineFromSelection(strumLineID:Int):Void`

`updateAutoSaving(elapsed:Float):Void`

`updateBPMEvents():Void`

`updateNoteLogic(elapsed:Float):Void`

`updateSelectionLogic():Void`

`updateWaveforms():Void`

`@:value(null)buttonHandler:() ‑> Void = null`

`@:value(null)curContextMenu:UIContextMenu = null`

`@:value(ARROW)currentCursor:MouseCursor = ARROW`

`@:value(null)currentFocus:IUIFocusable = null`