funkin.editors.charter.Charter - Codename Engine API

Static variables

`static__song:String`

View on GitHub

`staticautoSaveTimer:Float = 0`

View on GitHub

`staticclipboard:Array<CharterCopyboardObject> = []`

`staticread onlyinstance:Charter`

`staticplaytestInfo:PlaytestInfo`

`staticselection:Selection`

View on GitHub

`staticstartHere:Bool = false`

View on GitHub

`staticstartTime:Float = 0`

`staticundos:UndoList<CharterChange>`

`staticwaveformHandler:CharterWaveformHandler`

Static methods

View on GitHub

`staticsaveAs(data:Dynamic, ?replacer:(key:Dynamic, value:Dynamic) ‑> Dynamic, ?space:String, ?options:Null<SaveSubstateData>, ?saveOptions:Map<String, Bool>, shouldBuild:Bool = true):Void`

View on GitHub

`staticsaveTo(path:String, separateEvents:Bool = false, shouldBuild:Bool = true):Void`

Constructor

View on GitHub

`new(song:String, diff:String, reload:Bool = true)`

Variables

`__bookmarkObjects:Array<Dynamic> = []`

`__endStep:Float = 0`

`__scrollbarBookmarks:Array<Dynamic> = []`

`autoSaveNotif:CharterAutoSaveUI`

`charterBG:FunkinSprite`

`charterCamera:FlxCamera`

`dragStartPos:FlxPoint = new FlxPoint()`

`globalAddEventSpr:CharterEventAdd`

`gridActionType:CharterGridActionType = NONE`

NOTE AND CHARTER GRID LOGIC HERE

`gridBackdropDummy:CameraHoverDummy`

`gridBackdrops:CharterBackdropGroup`

`hitsound:FlxSound`

`isSelecting:Bool = false`

`leftEventRowText:UIText`

`leftEventsBackdrop:EventBackdrop`

`leftEventsGroup:CharterEventGroup = new CharterEventGroup()`

`localAddEventSpr:CharterEventAdd`

`metronome:FlxSound`

`mousePos:FlxPoint = new FlxPoint()`

`noteDeleteAnims:CharterDeleteAnim`

`noteHoverer:CharterNoteHoverer`

`noteType:Int = 0`

`noteTypeText:UIText`

`noteTypes:Array<String> = []`

`notesGroup:CharterNoteGroup = new CharterNoteGroup()`

`playBackSlider:UISlider`

`quant:Int = 16`

`quantButtons:Array<CharterQuantButton> = []`

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

`rightEventRowText:UIText`

`rightEventsBackdrop:EventBackdrop`

`rightEventsGroup:CharterEventGroup = new CharterEventGroup()`

`scrollBar:UIScrollBar`

`selectionBox:UISliceSprite`

`selectionDragging:Bool = false`

`shouldScroll:Bool = true`

`songPosInfo:UIText`

`strumLines:CharterStrumLineGroup = new CharterStrumLineGroup()`

`strumlineAddButton:CharterStrumlineButton`

`strumlineInfoBG:FlxSprite`

`strumlineLockButton:CharterStrumlineButton`

`topMenu:Array<UIContextMenuOption>`

`topMenuSpr:UITopMenu`

`uiCamera:FlxCamera`

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

`vocals:FlxSound`

Methods

View on GitHub

`inline__fixSelection(selection:Selection):Selection`

View on GitHub

`buildChart():Void`

View on GitHub

`buildEvents():Void`

View on GitHub

`inlinebuildNote(note:CharterNote):ChartNote`

View on GitHub

`inlinechangeNoteType(?newID:Int, checkSelection:Bool = true):Void`

View on GitHub

`inlinecheckSelectionForBPMUpdates():Void`

View on GitHub

`createSelection(selection:Selection, addToUndo:Bool = true):Array<Dynamic>`

View on GitHub

`createStrumWithUI():Void`

View on GitHub

`createStrumline(strumLineID:Int, strL:ChartStrumLine, addToUndo:Bool = true, __createNotes:Bool = true):Void`

View on GitHub

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

View on GitHub

`deleteSingleSelection(selected:ICharterSelectable, addToUndo:Bool = true):Null<ICharterSelectable>`

View on GitHub

`deleteStrumline(strumLineID:Int, addToUndo:Bool = true):Void`

View on GitHub

`inlinedeleteStrumlineFromData(strL:ChartStrumLine):Void`

View on GitHub

`inlineeditStrumline(strL:ChartStrumLine):Void`

View on GitHub

`getBookmarkList():Array<ChartBookmark>`

View on GitHub

`getHoveredEvent(y:Float, group:CharterEventGroup):CharterEvent`

View on GitHub

`getStrumlineID(strL:ChartStrumLine):Int`

View on GitHub

`getWavesToGenerate():Array<{sound:FlxSound, name:String}>`

View on GitHub

`inlinehitsoundsEnabled(id:Int):Bool`

View on GitHub

`loadSong():Void`

View on GitHub

`playtestChart(time:Float = 0, opponentMode:Bool = false, here:Bool = false):Void`

View on GitHub

`quantStep(step:Float):Float`

NOTE DRAG HANDLING

View on GitHub

`quantStepRounded(step:Float, roundRatio:Float = 0.5):Float`

View on GitHub

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

View on GitHub

`refreshBPMSensitive():Void`

View on GitHub

`inlineremoveStrumlineFromSelection(strumLineID:Int):Void`

View on GitHub

`updateAutoSaving(elapsed:Float):Void`

View on GitHub

`updateBPMEvents():Void`

View on GitHub

`updateBookmarks():Void`

View on GitHub

`updateEventsGroups(selection:Selection):CharterChange`

View on GitHub

`updateNoteLogic(elapsed:Float):Void`

View on GitHub

`updateSelectionLogic():Void`

View on GitHub

`updateWaveforms():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 Charter

package funkin.editors.charter

extends UIState › MusicBeatState

Static variables

static__song:String

staticautoSaveTimer:Float = 0

staticclipboard:Array<CharterCopyboardObject> = []

staticread onlyinstance:Charter

staticplaytestInfo:PlaytestInfo

staticselection:Selection

staticstartHere:Bool = false

staticstartTime:Float = 0

staticundos:UndoList<CharterChange>

staticwaveformHandler:CharterWaveformHandler

Static methods

staticsaveAs(data:Dynamic, ?replacer:(key:Dynamic, value:Dynamic) ‑> Dynamic, ?space:String, ?options:Null<SaveSubstateData>, ?saveOptions:Map<String, Bool>, shouldBuild:Bool = true):Void

staticsaveChart(shouldBuild:Bool = true, withEvents:Bool = true):Void

staticsaveChartAs(shouldBuild:Bool = true, withEvents:Bool = true):Void

staticsaveEvents(shouldBuild:Bool = true):Void

staticsaveEventsAs(shouldBuild:Bool = true):Void

staticsaveEverything(shouldBuild:Bool = true):Void

staticsaveLegacyChartAs(shouldBuild:Bool = true):Void

staticsaveMeta(shouldBuild:Bool = true):Void

staticsaveMetaAs(shouldBuild:Bool = true):Void

staticsavePsychChartAs(shouldBuild:Bool = true):Void

staticsaveTo(path:String, separateEvents:Bool = false, shouldBuild:Bool = true):Void

Constructor

new(song:String, diff:String, reload:Bool = true)

Variables

__bookmarkObjects:Array<Dynamic> = []

__endStep:Float = 0

__scrollbarBookmarks:Array<Dynamic> = []

autoSaveNotif:CharterAutoSaveUI

charterBG:FunkinSprite

charterCamera:FlxCamera

dragStartPos:FlxPoint = new FlxPoint()

globalAddEventSpr:CharterEventAdd

gridActionType:CharterGridActionType = NONE

gridBackdropDummy:CameraHoverDummy

gridBackdrops:CharterBackdropGroup

hitsound:FlxSound

isSelecting:Bool = false

leftEventRowText:UIText

leftEventsBackdrop:EventBackdrop

leftEventsGroup:CharterEventGroup = new CharterEventGroup()

localAddEventSpr:CharterEventAdd

metronome:FlxSound

mousePos:FlxPoint = new FlxPoint()

noteDeleteAnims:CharterDeleteAnim

noteHoverer:CharterNoteHoverer

noteType:Int = 0

noteTypeText:UIText

noteTypes:Array<String> = []

notesGroup:CharterNoteGroup = new CharterNoteGroup()

playBackSlider:UISlider

quant:Int = 16

quantButtons:Array<CharterQuantButton> = []

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

rightEventRowText:UIText

rightEventsBackdrop:EventBackdrop

rightEventsGroup:CharterEventGroup = new CharterEventGroup()

scrollBar:UIScrollBar

selectionBox:UISliceSprite

selectionDragging:Bool = false

shouldScroll:Bool = true

songPosInfo:UIText

strumLines:CharterStrumLineGroup = new CharterStrumLineGroup()

strumlineAddButton:CharterStrumlineButton

strumlineInfoBG:FlxSprite

strumlineLockButton:CharterStrumlineButton

topMenu:Array<UIContextMenuOption>

topMenuSpr:UITopMenu

uiCamera:FlxCamera

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

vocals:FlxSound

Methods

inline__fixSelection(selection:Selection):Selection

buildChart():Void

buildEvents():Void

inlinebuildNote(note:CharterNote):ChartNote

`static__song:String`

`staticautoSaveTimer:Float = 0`

`staticclipboard:Array<CharterCopyboardObject> = []`

`staticread onlyinstance:Charter`

`staticplaytestInfo:PlaytestInfo`

`staticselection:Selection`

`staticstartHere:Bool = false`

`staticstartTime:Float = 0`

`staticundos:UndoList<CharterChange>`

`staticwaveformHandler:CharterWaveformHandler`

`staticsaveAs(data:Dynamic, ?replacer:(key:Dynamic, value:Dynamic) ‑> Dynamic, ?space:String, ?options:Null<SaveSubstateData>, ?saveOptions:Map<String, Bool>, shouldBuild:Bool = true):Void`

`staticsaveChart(shouldBuild:Bool = true, withEvents:Bool = true):Void`

`staticsaveChartAs(shouldBuild:Bool = true, withEvents:Bool = true):Void`

`staticsaveEvents(shouldBuild:Bool = true):Void`

`staticsaveEventsAs(shouldBuild:Bool = true):Void`

`staticsaveEverything(shouldBuild:Bool = true):Void`

`staticsaveLegacyChartAs(shouldBuild:Bool = true):Void`

`staticsaveMeta(shouldBuild:Bool = true):Void`

`staticsaveMetaAs(shouldBuild:Bool = true):Void`

`staticsavePsychChartAs(shouldBuild:Bool = true):Void`

`staticsaveTo(path:String, separateEvents:Bool = false, shouldBuild:Bool = true):Void`

`new(song:String, diff:String, reload:Bool = true)`

`__bookmarkObjects:Array<Dynamic> = []`

`__endStep:Float = 0`

`__scrollbarBookmarks:Array<Dynamic> = []`

`autoSaveNotif:CharterAutoSaveUI`

`charterBG:FunkinSprite`

`charterCamera:FlxCamera`

`dragStartPos:FlxPoint = new FlxPoint()`

`globalAddEventSpr:CharterEventAdd`

`gridActionType:CharterGridActionType = NONE`

`gridBackdropDummy:CameraHoverDummy`

`gridBackdrops:CharterBackdropGroup`

`hitsound:FlxSound`

`isSelecting:Bool = false`

`leftEventRowText:UIText`

`leftEventsBackdrop:EventBackdrop`

`leftEventsGroup:CharterEventGroup = new CharterEventGroup()`

`localAddEventSpr:CharterEventAdd`

`metronome:FlxSound`

`mousePos:FlxPoint = new FlxPoint()`

`noteDeleteAnims:CharterDeleteAnim`

`noteHoverer:CharterNoteHoverer`

`noteType:Int = 0`

`noteTypeText:UIText`

`noteTypes:Array<String> = []`

`notesGroup:CharterNoteGroup = new CharterNoteGroup()`

`playBackSlider:UISlider`

`quant:Int = 16`

`quantButtons:Array<CharterQuantButton> = []`

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

`rightEventRowText:UIText`

`rightEventsBackdrop:EventBackdrop`

`rightEventsGroup:CharterEventGroup = new CharterEventGroup()`

`scrollBar:UIScrollBar`

`selectionBox:UISliceSprite`

`selectionDragging:Bool = false`

`shouldScroll:Bool = true`

`songPosInfo:UIText`

`strumLines:CharterStrumLineGroup = new CharterStrumLineGroup()`

`strumlineAddButton:CharterStrumlineButton`

`strumlineInfoBG:FlxSprite`

`strumlineLockButton:CharterStrumlineButton`

`topMenu:Array<UIContextMenuOption>`

`topMenuSpr:UITopMenu`

`uiCamera:FlxCamera`

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

`vocals:FlxSound`

`inline__fixSelection(selection:Selection):Selection`

`buildChart():Void`

`buildEvents():Void`

`inlinebuildNote(note:CharterNote):ChartNote`

`inlinechangeNoteType(?newID:Int, checkSelection:Bool = true):Void`

`inlinecheckSelectionForBPMUpdates():Void`

`createSelection(selection:Selection, addToUndo:Bool = true):Array<Dynamic>`

`createStrumWithUI():Void`

`createStrumline(strumLineID:Int, strL:ChartStrumLine, addToUndo:Bool = true, __createNotes:Bool = true):Void`

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

`deleteSingleSelection(selected:ICharterSelectable, addToUndo:Bool = true):Null<ICharterSelectable>`

`deleteStrumline(strumLineID:Int, addToUndo:Bool = true):Void`