funkin.options.OptionsMenu - Codename Engine API

Static variables

View in GitHub

staticmainOptions:Array<OptionCategory> = [{ name : "Controls", desc : "Change Controls for Player 1 and Player 2!", state : null, substate : funkin.options.keybinds.KeybindsOptions }, { name : "Gameplay >", desc : "Change Gameplay options such as Downscroll, Scroll Speed, Naughtyness...", state : GameplayOptions }, { name : "Appearance >", desc : "Change Appearance options such as Flashing menus...", state : AppearanceOptions }, { name : "Miscellaneous >", desc : "Use this menu to reset save data or engine settings.", state : MiscOptions }]

Constructor

View in GitHub

`new()`

Methods

View in GitHub

`parseOptionsFromXML(xml:Access):Array<OptionType>`

XML STUFF

Inherited Variables

Defined by TreeMenu

`main:OptionsScreen`

`optionsTree:OptionsTree`

`pathBG:FlxSprite`

`pathDesc:FunkinText`

`pathLabel:FunkinText`

Defined by UIState

`buttonHandler:() ‑> Void = null`

`curContextMenu:UIContextMenu = null`

`currentCursor:MouseCursor = ARROW`

`currentFocus:IUIFocusable = null`

`hoveredSprite:UISprite = null`

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

`updateDesc(moreTxt:String = ""):Void`

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

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

package funkin.options

extends TreeMenu › UIState › MusicBeatState

Static variables

Constructor

new()

Methods

parseOptionsFromXML(xml:Access):Array<OptionType>

Inherited Variables

Defined by TreeMenu

main:OptionsScreen

optionsTree:OptionsTree

pathBG:FlxSprite

pathDesc:FunkinText

pathLabel:FunkinText

Defined by UIState

buttonHandler:() ‑> Void = null

curContextMenu:UIContextMenu = null

currentCursor:MouseCursor = ARROW

currentFocus:IUIFocusable = null

hoveredSprite:UISprite = null

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 TreeMenu

onMenuChange():Void

onMenuClose(m:OptionsScreen):Void

updateDesc(moreTxt:String = ""):Void

Defined by UIState

closeCurrentContextMenu():Void

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

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

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

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

inlineupdateSpriteRect(spr:UISprite):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

`new()`

`parseOptionsFromXML(xml:Access):Array<OptionType>`

`main:OptionsScreen`

`optionsTree:OptionsTree`

`pathBG:FlxSprite`

`pathDesc:FunkinText`

`pathLabel:FunkinText`

`buttonHandler:() ‑> Void = null`

`curContextMenu:UIContextMenu = null`

`currentCursor:MouseCursor = ARROW`

`currentFocus:IUIFocusable = null`

`hoveredSprite:UISprite = null`

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

`onMenuChange():Void`

`onMenuClose(m:OptionsScreen):Void`

`updateDesc(moreTxt:String = ""):Void`

`closeCurrentContextMenu():Void`

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

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

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

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

`inlineupdateSpriteRect(spr:UISprite):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`