funkin.editors.ModConfigWarning - Codename Engine API

Static variables

View on GitHub

staticinlineread onlydefaultModConfigText:String = "[Common] # This section applies the 'MOD_' prefix to the flags so you don't have to.\r\nNAME=\"YOUR MOD NAME HERE\"\r\nDESCRIPTION=\"YOUR MOD DESCRIPTION HERE\"\r\nAUTHOR=\"YOU/YOUR TEAM HERE\"\r\nVERSION=\"YOUR MOD'S VERSION HERE\"\r\n\r\n# DO NOT EDIT!! this is used to check for version compatibility!\r\nAPI_VERSION=1\r\n\r\nDOWNLOAD_LINK=\"YOUR MOD PAGE LINK HERE\"\r\n\r\n# Not supported yet\r\n;MOD_ICON64=\"path/to/icon64.png\"\r\n;MOD_ICON32=\"path/to/icon32.png\"\r\n;MOD_ICON16=\"path/to/icon16.png\"\r\nICON=\"path/to/icon.png\"\r\n\r\n[Flags] # This section doesn't apply any prefix.\r\nDISABLE_WARNING_SCREEN=true\r\n# Set this to false if you want to bring back the warning state (prior to 1.0.0)\r\n# NOTE: Beta warning state has been renamed from BetaWarningState.hx to WarningState.hx\r\nDISABLE_LANGUAGES=true\r\n# Some people might not translate their mods, but if you do then you may set this to false\r\n\r\n[Discord] # This section applies the 'MOD_DISCORD_' prefix to the flags so you don't have to.\r\nCLIENT_ID=\"\"\r\nLOGO_KEY=\"\"\r\nLOGO_TEXT=\"\"\r\n\r\n[StateRedirects] # This section is used for state redirecting, see examples below.\r\n;StoryMenuState=\"funkin.menus.FreeplayState\"\r\n;FreeplayState=\"scriptedFreeplayState\"\r\n\r\n[StateRedirects.force] # Use this if you want to override redirects set by subsequent addons/mods\r\n"

View on GitHub

`statichadPopup:Bool = false`

Constructor

View on GitHub

`new(library:ModsFolderLibrary, ?goToState:Class<FlxState>)`

Methods

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

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

package funkin.editors

extends UIState › MusicBeatState

Static variables

statichadPopup:Bool = false

Constructor

new(library:ModsFolderLibrary, ?goToState:Class<FlxState>)

Methods

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

`statichadPopup:Bool = false`

`new(library:ModsFolderLibrary, ?goToState:Class<FlxState>)`

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