diff --git a/docs/404.html b/docs/404.html index d14baff..3a40048 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1 +1 @@ -File not found

404 Page not found

Page not found, sorry.

\ No newline at end of file +File not found

404 Page not found

Page not found, sorry.

\ No newline at end of file diff --git a/docs/funkin/backend/FlxAnimate.html b/docs/funkin/backend/FlxAnimate.html index b240821..771e95c 100644 --- a/docs/funkin/backend/FlxAnimate.html +++ b/docs/funkin/backend/FlxAnimate.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?X:Float, ?Y:Float, ?Path:String, ?Settings:Null<Settings>)

\ No newline at end of file +

Constructor

new(?X:Float, ?Y:Float, ?Path:String, ?Settings:Null<Settings>)

\ No newline at end of file diff --git a/docs/funkin/backend/FunkinSprite.html b/docs/funkin/backend/FunkinSprite.html index 48c5872..ab1525b 100644 --- a/docs/funkin/backend/FunkinSprite.html +++ b/docs/funkin/backend/FunkinSprite.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

Constructor

@:value({ Y : 0, X : 0 })new(X:Float = 0, Y:Float = 0, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

@:value([])animDatas:Map<String, AnimData> = []

@:value(new Map<String,FlxPoint>())animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

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

@:value(false)debugMode:Bool = false

@:value(1)initialZoom:Float = 1

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

name:String

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Methods

@:value({ y : 0, x : 0 })addOffset(name:String, x:Float = 0, y:Float = 0):Void

beatHit(curBeat:Int):Void

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnimation(AnimName:String):Bool

inlineisAnimFinished():Bool

@:value({ Key : null, Unique : false })loadSprite(path:String, Unique:Bool = false, ?Key:String):Void

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

@:value({ Frame : 0, Reversed : false, Context : NONE, Force : false })playAnim(AnimName:String, Force:Bool = false, Context:PlayAnimContext = NONE, Reversed:Bool = false, Frame:Int = 0):Void

inlineremoveAnimation(name:String):Void

stepHit(curBeat:Int):Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

\ No newline at end of file +

Static methods

Constructor

@:value({ Y : 0, X : 0 })new(X:Float = 0, Y:Float = 0, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

@:value([])animDatas:Map<String, AnimData> = []

@:value(new Map<String,FlxPoint>())animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

@:value([])beatAnims:Array<BeatAnim> = []

@:value(1)beatInterval:Int = 1

@:value(0)beatOffset:Int = 0

@:value(false)debugMode:Bool = false

@:value(1)initialZoom:Float = 1

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

name:String

@:value(false)skipNegativeBeats:Bool = false

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Methods

@:value({ y : 0, x : 0 })addOffset(name:String, x:Float = 0, y:Float = 0):Void

beatHit(curBeat:Int):Void

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnimation(AnimName:String):Bool

inlineisAnimFinished():Bool

@:value({ Key : null, Unique : false })loadSprite(path:String, Unique:Bool = false, ?Key:String):Void

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

@:value({ Frame : 0, Reversed : false, Context : NONE, Force : false })playAnim(AnimName:String, Force:Bool = false, Context:PlayAnimContext = NONE, Reversed:Bool = false, Frame:Int = 0):Void

inlineremoveAnimation(name:String):Void

stepHit(curBeat:Int):Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

\ No newline at end of file diff --git a/docs/funkin/backend/FunkinText.html b/docs/funkin/backend/FunkinText.html index cc54cd5..acea92c 100644 --- a/docs/funkin/backend/FunkinText.html +++ b/docs/funkin/backend/FunkinText.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ Border : true, Size : 16, FieldWidth : 0, Y : 0, X : 0 })new(X:Float = 0, Y:Float = 0, FieldWidth:Float = 0, ?Text:String, Size:Int = 16, Border:Bool = true)

\ No newline at end of file +

Constructor

@:value({ Border : true, Size : 16, FieldWidth : 0, Y : 0, X : 0 })new(X:Float = 0, Y:Float = 0, FieldWidth:Float = 0, ?Text:String, Size:Int = 16, Border:Bool = true)

\ No newline at end of file diff --git a/docs/funkin/backend/MusicBeatGroup.html b/docs/funkin/backend/MusicBeatGroup.html index 010436d..3e16e65 100644 --- a/docs/funkin/backend/MusicBeatGroup.html +++ b/docs/funkin/backend/MusicBeatGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?X:Float, ?Y:Float, ?MaxSize:Int)

Methods

beatHit(curBeat:Int):Void

measureHit(curMeasure:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file +

Constructor

new(?X:Float, ?Y:Float, ?MaxSize:Int)

Methods

beatHit(curBeat:Int):Void

measureHit(curMeasure:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file diff --git a/docs/funkin/backend/MusicBeatState.html b/docs/funkin/backend/MusicBeatState.html index ec62cd0..1d60221 100644 --- a/docs/funkin/backend/MusicBeatState.html +++ b/docs/funkin/backend/MusicBeatState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(false)staticskipTransIn:Bool = false

@:value(false)staticskipTransOut:Bool = false

Constructor

@:value({ scriptsAllowed : true })new(scriptsAllowed:Bool = true, ?scriptName:String)

Variables

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

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: data/states/FreeplayState)

Methods

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

@:value(false)staticskipTransIn:Bool = false

@:value(false)staticskipTransOut:Bool = false

Constructor

@:value({ scriptsAllowed : true })new(scriptsAllowed:Bool = true, ?scriptName:String)

Variables

@: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)

Methods

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/backend/MusicBeatSubstate.html b/docs/funkin/backend/MusicBeatSubstate.html index 73fb771..0a72feb 100644 --- a/docs/funkin/backend/MusicBeatSubstate.html +++ b/docs/funkin/backend/MusicBeatSubstate.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ scriptsAllowed : true })new(scriptsAllowed:Bool = true, ?scriptName:String)

Variables

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Methods

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

@:value({ scriptsAllowed : true })new(scriptsAllowed:Bool = true, ?scriptName:String)

Variables

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Methods

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/backend/MusicBeatTransition.html b/docs/funkin/backend/MusicBeatTransition.html index f07a050..6698f4b 100644 --- a/docs/funkin/backend/MusicBeatTransition.html +++ b/docs/funkin/backend/MusicBeatTransition.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?newState:FlxState)

Variables

newState:FlxState

@:value(null)transitionTween:FlxTween = null

Methods

finish():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?newState:FlxState)

Variables

blackSpr:FlxSprite

newState:FlxState

@:value(null)transitionTween:FlxTween = null

Methods

finish():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/backend/XMLAnimType.html b/docs/funkin/backend/XMLAnimType.html index ad88ddf..7690757 100644 --- a/docs/funkin/backend/XMLAnimType.html +++ b/docs/funkin/backend/XMLAnimType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

@:value({ def : NONE })staticfromString(str:String, def:XMLAnimType = NONE):XMLAnimType

Variables

@:value(cast 1)@:impl@:enuminlineread onlyBEAT:XMLAnimType = 1

@:value(cast 2)@:impl@:enuminlineread onlyLOOP:XMLAnimType = 2

@:value(cast 0)@:impl@:enuminlineread onlyNONE:XMLAnimType = 0

\ No newline at end of file +

Static methods

@:value({ def : NONE })staticfromString(str:String, def:XMLAnimType = NONE):XMLAnimType

Variables

@:value(cast 1)@:impl@:enuminlineread onlyBEAT:XMLAnimType = 1

@:value(cast 2)@:impl@:enuminlineread onlyLOOP:XMLAnimType = 2

@:value(cast 0)@:impl@:enuminlineread onlyNONE:XMLAnimType = 0

\ No newline at end of file diff --git a/docs/funkin/backend/assets/AssetSource.html b/docs/funkin/backend/assets/AssetSource.html index 610ea51..cd59ea5 100644 --- a/docs/funkin/backend/assets/AssetSource.html +++ b/docs/funkin/backend/assets/AssetSource.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast null)@:impl@:enuminlineread onlyBOTH:AssetSource = null

@:value(cast false)@:impl@:enuminlineread onlyMODS:AssetSource = false

@:value(cast true)@:impl@:enuminlineread onlySOURCE:AssetSource = true

\ No newline at end of file +

Variables

@:value(cast null)@:impl@:enuminlineread onlyBOTH:AssetSource = null

@:value(cast false)@:impl@:enuminlineread onlyMODS:AssetSource = false

@:value(cast true)@:impl@:enuminlineread onlySOURCE:AssetSource = true

\ No newline at end of file diff --git a/docs/funkin/backend/assets/AssetsLibraryList.html b/docs/funkin/backend/assets/AssetsLibraryList.html index fdfd968..f049378 100644 --- a/docs/funkin/backend/assets/AssetsLibraryList.html +++ b/docs/funkin/backend/assets/AssetsLibraryList.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?base:AssetLibrary)

Variables

base:AssetLibrary

@:value([])libraries:Array<AssetLibrary> = []

Methods

addLibrary(lib:AssetLibrary):AssetLibrary

@:value({ source : BOTH })existsSpecific(id:String, type:String, source:AssetSource = BOTH):Bool

@:value({ source : BOTH })getFiles(folder:String, source:AssetSource = BOTH):Array<String>

@:value({ source : BOTH })getFolders(folder:String, source:AssetSource = BOTH):Array<String>

@:value({ source : BOTH })getSpecificAsset(id:String, type:String, source:AssetSource = BOTH):Dynamic

@:value({ source : BOTH })getSpecificPath(id:String, source:AssetSource = BOTH):String

removeLibrary(lib:AssetLibrary):AssetLibrary

reset():Void

\ No newline at end of file +

Constructor

new(?base:AssetLibrary)

Variables

base:AssetLibrary

@:value([])libraries:Array<AssetLibrary> = []

Methods

addLibrary(lib:AssetLibrary):AssetLibrary

@:value({ source : BOTH })existsSpecific(id:String, type:String, source:AssetSource = BOTH):Bool

@:value({ source : BOTH })getFiles(folder:String, source:AssetSource = BOTH):Array<String>

@:value({ source : BOTH })getFolders(folder:String, source:AssetSource = BOTH):Array<String>

@:value({ source : BOTH })getSpecificAsset(id:String, type:String, source:AssetSource = BOTH):Dynamic

@:value({ source : BOTH })getSpecificPath(id:String, source:AssetSource = BOTH):String

removeLibrary(lib:AssetLibrary):AssetLibrary

reset():Void

\ No newline at end of file diff --git a/docs/funkin/backend/assets/IModsAssetLibrary.html b/docs/funkin/backend/assets/IModsAssetLibrary.html index 7f963e7..a5dd37c 100644 --- a/docs/funkin/backend/assets/IModsAssetLibrary.html +++ b/docs/funkin/backend/assets/IModsAssetLibrary.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

libName:String

prefix:String

Methods

getFiles(folder:String):Array<String>

getFolders(folder:String):Array<String>

\ No newline at end of file +

Variables

libName:String

modName:String

prefix:String

Methods

getFiles(folder:String):Array<String>

getFolders(folder:String):Array<String>

\ No newline at end of file diff --git a/docs/funkin/backend/assets/LimeLibrarySymbol.html b/docs/funkin/backend/assets/LimeLibrarySymbol.html index e1e784d..517b96c 100644 --- a/docs/funkin/backend/assets/LimeLibrarySymbol.html +++ b/docs/funkin/backend/assets/LimeLibrarySymbol.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

COPIED DIRECTLY FROM LIME SOURCE CAUSE LIME IS SO FUCKING DUMB!!

Constructor

inlinenew(id:String)

Variables

library:AssetLibrary

symbolName:String

Methods

inlineexists(?type:String):Bool

inlineisLocal(?type:String):Bool

\ No newline at end of file +

COPIED DIRECTLY FROM LIME SOURCE CAUSE LIME IS SO FUCKING DUMB!!

Constructor

inlinenew(id:String)

Variables

library:AssetLibrary

symbolName:String

Methods

inlineexists(?type:String):Bool

inlineisLocal(?type:String):Bool

\ No newline at end of file diff --git a/docs/funkin/backend/assets/ModdableAssetsFolder.html b/docs/funkin/backend/assets/ModdableAssetsFolder.html index 69317e6..46caa93 100644 --- a/docs/funkin/backend/assets/ModdableAssetsFolder.html +++ b/docs/funkin/backend/assets/ModdableAssetsFolder.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Used to prevent crashes

Constructor

new(folder:String, libName:String, oldLib:AssetLibrary)

Variables

oldLibrary:AssetLibrary

Methods

Inherited Variables

Defined by ModsFolderLibrary

@:value(null)_parsedAsset:String = null

folderPath:String

libName:String

@:value("assets/")prefix:String = "assets/"

@:value(true)useImageCache:Bool = true

Inherited Methods

Defined by ModsFolderLibrary

@:value({ folders : false })__getFiles(folder:String, folders:Bool = false):Array<String>

getEditedTime(asset:String):Null<Float>

inlinegetFiles(folder:String):Array<String>

inlinegetFolders(folder:String):Array<String>

\ No newline at end of file +

Used to prevent crashes

Constructor

new(folder:String, libName:String, oldLib:AssetLibrary)

Variables

oldLibrary:AssetLibrary

Methods

Inherited Variables

Defined by ModsFolderLibrary

@:value(null)_parsedAsset:String = null

folderPath:String

libName:String

modName:String

@:value("assets/")prefix:String = "assets/"

@:value(true)useImageCache:Bool = true

Inherited Methods

Defined by ModsFolderLibrary

@:value({ folders : false })__getFiles(folder:String, folders:Bool = false):Array<String>

getEditedTime(asset:String):Null<Float>

inlinegetFiles(folder:String):Array<String>

inlinegetFolders(folder:String):Array<String>

\ No newline at end of file diff --git a/docs/funkin/backend/assets/ModsFolder.html b/docs/funkin/backend/assets/ModsFolder.html index 2852b9f..048fc03 100644 --- a/docs/funkin/backend/assets/ModsFolder.html +++ b/docs/funkin/backend/assets/ModsFolder.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value("./addons/")staticaddonsPath:String = "./addons/"

Path to the addons folder.

@:value(null)staticcurrentModFolder:String = null

Current mod folder. Will affect Paths.

@:value("./mods/")staticmodsPath:String = "./mods/"

Path to the mods folder.

Static methods

staticinit():Void

Initialises mods folder by adding callbacks and such.

@:value({ force : false })staticloadLibraryFromFolder(libName:String, folder:String, force:Bool = false):AssetLibrary

@:value({ force : false })staticloadLibraryFromZip(libName:String, zipPath:String, force:Bool = false):AssetLibrary

@:value({ force : false })staticloadModLib(path:String, force:Bool = false):AssetLibrary

Loads a mod library from the specified path. Supports folders and zips.

Parameters:

modName

Name of the mod

force

Whenever the mod should be reloaded if it has already been loaded

@:value({ force : false })staticprepareLibrary(libName:String, force:Bool = false):AssetLibrary

@:value({ force : false })staticprepareModLibrary(libName:String, lib:IModsAssetLibrary, force:Bool = false):AssetLibrary

staticregisterFont(font:Font):Font

staticreloadMods():Void

staticswitchMod(mod:String):Void

Switches mod - unloads all the other mods, then load this one.

Parameters:

null

libName

\ No newline at end of file +

Static variables

@:value("./addons/")staticaddonsPath:String = "./addons/"

Path to the addons folder.

@:value(null)staticcurrentModFolder:String = null

Current mod folder. Will affect Paths.

@:value("./mods/")staticmodsPath:String = "./mods/"

Path to the mods folder.

@:value(true)staticuseLibFile:Bool = true

If accessing a file as assets/data/global/LIB_mymod.hx should redirect to mymod:assets/data/global.hx

Static methods

staticgetLoadedMods():Array<String>

staticinit():Void

Initialises mods folder by adding callbacks and such.

@:value({ force : false })staticloadLibraryFromFolder(libName:String, folder:String, force:Bool = false, ?modName:String):AssetLibrary

@:value({ force : false })staticloadLibraryFromZip(libName:String, zipPath:String, force:Bool = false, ?modName:String):AssetLibrary

@:value({ force : false })staticloadModLib(path:String, force:Bool = false, ?modName:String):AssetLibrary

Loads a mod library from the specified path. Supports folders and zips.

Parameters:

modName

Name of the mod

force

Whenever the mod should be reloaded if it has already been loaded

@:value({ force : false })staticprepareLibrary(libName:String, force:Bool = false):AssetLibrary

@:value({ force : false })staticprepareModLibrary(libName:String, lib:IModsAssetLibrary, force:Bool = false):AssetLibrary

staticregisterFont(font:Font):Font

staticreloadMods():Void

staticswitchMod(mod:String):Void

Switches mod - unloads all the other mods, then load this one.

Parameters:

null

libName

\ No newline at end of file diff --git a/docs/funkin/backend/assets/ModsFolderLibrary.html b/docs/funkin/backend/assets/ModsFolderLibrary.html index 2bbd12f..71603c3 100644 --- a/docs/funkin/backend/assets/ModsFolderLibrary.html +++ b/docs/funkin/backend/assets/ModsFolderLibrary.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(folderPath:String, libName:String)

Variables

@:value(null)_parsedAsset:String = null

folderPath:String

libName:String

@:value("assets/")prefix:String = "assets/"

@:value(true)useImageCache:Bool = true

Methods

@:value({ folders : false })__getFiles(folder:String, folders:Bool = false):Array<String>

getEditedTime(asset:String):Null<Float>

inlinegetFiles(folder:String):Array<String>

inlinegetFolders(folder:String):Array<String>

\ No newline at end of file +

Constructor

new(folderPath:String, libName:String, ?modName:String)

Variables

@:value(null)_parsedAsset:String = null

folderPath:String

libName:String

modName:String

@:value("assets/")prefix:String = "assets/"

@:value(true)useImageCache:Bool = true

Methods

@:value({ folders : false })__getFiles(folder:String, folders:Bool = false):Array<String>

getEditedTime(asset:String):Null<Float>

inlinegetFiles(folder:String):Array<String>

inlinegetFolders(folder:String):Array<String>

\ No newline at end of file diff --git a/docs/funkin/backend/assets/MultiFramesCollection.html b/docs/funkin/backend/assets/MultiFramesCollection.html new file mode 100644 index 0000000..b607a0a --- /dev/null +++ b/docs/funkin/backend/assets/MultiFramesCollection.html @@ -0,0 +1,11 @@ + + + +funkin.backend.assets.MultiFramesCollection

Base class for all frame collections.

Static methods

staticfindFrame(graphic:FlxGraphic, ?border:FlxPoint):MultiFramesCollection

Returns the FlxAtlasFrame of the specified FlxGraphic object.

Parameters:

graphic

FlxGraphic object to find the FlxAtlasFrames collection for.

Returns:

FlxAtlasFrames collection for the specified FlxGraphic object +Could be null if FlxGraphic doesn't have it yet.

Constructor

new(parent:FlxGraphic, ?border:FlxPoint)

Variables

@:value([])parentedFrames:Array<FlxFramesCollection> = []

Methods

addFrames(collection:FlxFramesCollection):Void

\ No newline at end of file diff --git a/docs/funkin/backend/assets/Paths.html b/docs/funkin/backend/assets/Paths.html index a96ee6f..16a2e38 100644 --- a/docs/funkin/backend/assets/Paths.html +++ b/docs/funkin/backend/assets/Paths.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

Static variables

@:value("ogg")staticfinalinlineread onlySOUND_EXT:String = "ogg"

Preferred sound extension for the game's audio files. -Currently is set to mp3 for web targets, and ogg for other targets.

@:value([])statictempFramesCache:Map<String, FlxFramesCollection> = []

Static methods

staticinlineawd(key:String):String

staticcharacter(character:String):String

@:value({ difficulty : "normal" })staticchart(song:String, difficulty:String = "normal"):String

staticinlinedae(key:String):String

staticinlinefile(file:String, ?library:String):String

staticinlinefont(key:String):String

staticinlinefragShader(key:String, ?library:String):String

staticinlinegetAssetsRoot():String

@:value({ source : BOTH, addPath : false })staticgetFolderContent(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>

@:value({ source : BOTH, addPath : false })staticgetFolderDirectories(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>

@:value({ assetsPath : false })staticgetFrames(key:String, assetsPath:Bool = false, ?library:String):Null<FlxFramesCollection>

Gets frames at specified path.

Parameters:

key

Path to the frames

library

(Additional) library to load the frames from.

staticinlinegetPackerAtlas(key:String, ?library:String):FlxAtlasFrames

staticinlinegetPackerAtlasAlt(key:String):FlxAtlasFrames

staticinlinegetPath(file:String, ?library:String):String

staticinlinegetSparrowAtlas(key:String, ?library:String):FlxAtlasFrames

staticinlinegetSparrowAtlasAlt(key:String):FlxAtlasFrames

@:value({ checkForAtlas : false })staticimage(key:String, ?library:String, checkForAtlas:Bool = false):String

staticinlineini(key:String, ?library:String):String

staticinit():Void

@:value({ difficulty : "normal" })staticinlineinst(song:String, difficulty:String = "normal"):String

staticinlinejson(key:String, ?library:String):String

staticinlinemd2(key:String):String

staticinlinemd5(key:String):String

staticinlinemusic(key:String, ?library:String):String

staticinlinendll(key:String):String

staticinlineobj(key:String):String

staticinlineps1(key:String, ?library:String):String

@:value({ isAssetsPath : false })staticinlinescript(key:String, ?library:String, isAssetsPath:Bool = false):String

staticsound(key:String, ?library:String):String

staticinlinesoundRandom(key:String, min:Int, max:Int, ?library:String):String

staticinlinetxt(key:String, ?library:String):String

staticinlinevertShader(key:String, ?library:String):String

staticinlinevideo(key:String):String

@:value({ difficulty : "normal" })staticinlinevoices(song:String, difficulty:String = "normal"):String

staticinlinexml(key:String, ?library:String):String

\ No newline at end of file +Currently is set to mp3 for web targets, and ogg for other targets.

staticassetsTree:AssetsLibraryList

@:value([])statictempFramesCache:Map<String, FlxFramesCollection> = []

Static methods

staticinlineawd(key:String):String

staticcharacter(character:String):String

@:value({ difficulty : "normal" })staticchart(song:String, difficulty:String = "normal"):String

staticinlinedae(key:String):String

staticinlinefile(file:String, ?library:String):String

staticinlinefont(key:String):String

staticinlinefragShader(key:String, ?library:String):String

staticinlinegetAsepriteAtlas(key:String, ?library:String):FlxAtlasFrames

staticinlinegetAsepriteAtlasAlt(key:String):FlxAtlasFrames

staticinlinegetAssetsRoot():String

@:value({ source : BOTH, addPath : false })staticgetFolderContent(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>

@:value({ source : BOTH, addPath : false })staticgetFolderDirectories(key:String, addPath:Bool = false, source:AssetSource = BOTH):Array<String>

@:value({ assetsPath : false })staticgetFrames(key:String, assetsPath:Bool = false, ?library:String):Null<FlxFramesCollection>

Gets frames at specified path.

Parameters:

key

Path to the frames

library

(Additional) library to load the frames from.

staticinlinegetPackerAtlas(key:String, ?library:String):FlxAtlasFrames

staticinlinegetPackerAtlasAlt(key:String):FlxAtlasFrames

staticinlinegetPath(file:String, ?library:String):String

staticinlinegetSparrowAtlas(key:String, ?library:String):FlxAtlasFrames

staticinlinegetSparrowAtlasAlt(key:String):FlxAtlasFrames

@:value({ ext : "png", checkForAtlas : false })staticimage(key:String, ?library:String, checkForAtlas:Bool = false, ext:String = "png"):String

staticinlineini(key:String, ?library:String):String

staticinit():Void

@:value({ prefix : "", difficulty : "normal" })staticinlineinst(song:String, difficulty:String = "normal", prefix:String = ""):String

staticinlinejson(key:String, ?library:String):String

staticinlinemd2(key:String):String

staticinlinemd5(key:String):String

staticinlinemusic(key:String, ?library:String):String

staticinlinendll(key:String):String

staticinlineobj(key:String):String

staticinlinepack(key:String, ?library:String):String

staticinlineps1(key:String, ?library:String):String

@:value({ isAssetsPath : false })staticinlinescript(key:String, ?library:String, isAssetsPath:Bool = false):String

staticsound(key:String, ?library:String):String

staticinlinesoundRandom(key:String, min:Int, max:Int, ?library:String):String

staticinlinetxt(key:String, ?library:String):String

staticinlinevertShader(key:String, ?library:String):String

@:value({ ext : "mp4" })staticinlinevideo(key:String, ext:String = "mp4"):String

@:value({ prefix : "", difficulty : "normal" })staticinlinevoices(song:String, difficulty:String = "normal", prefix:String = ""):String

staticinlinexml(key:String, ?library:String):String

\ No newline at end of file diff --git a/docs/funkin/backend/assets/ScriptPathInfo.html b/docs/funkin/backend/assets/ScriptPathInfo.html index f85401b..12726a0 100644 --- a/docs/funkin/backend/assets/ScriptPathInfo.html +++ b/docs/funkin/backend/assets/ScriptPathInfo.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(file:String, library:AssetLibrary)

Variables

file:String

library:AssetLibrary

\ No newline at end of file +

Constructor

new(file:String, library:AssetLibrary)

Variables

file:String

library:AssetLibrary

\ No newline at end of file diff --git a/docs/funkin/backend/assets/ScriptedAssetLibrary.html b/docs/funkin/backend/assets/ScriptedAssetLibrary.html index 8079409..4f4a4d9 100644 --- a/docs/funkin/backend/assets/ScriptedAssetLibrary.html +++ b/docs/funkin/backend/assets/ScriptedAssetLibrary.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ libName : "assets", folderPath : "./assets/", args : null })new(scriptName:String, ?args:Array<Dynamic>, folderPath:String = "./assets/", libName:String = "assets")

Variables

Methods

Inherited Variables

Defined by ModsFolderLibrary

@:value(null)_parsedAsset:String = null

folderPath:String

libName:String

@:value("assets/")prefix:String = "assets/"

@:value(true)useImageCache:Bool = true

Inherited Methods

Defined by ModsFolderLibrary

inlinegetFiles(folder:String):Array<String>

inlinegetFolders(folder:String):Array<String>

\ No newline at end of file +

Constructor

@:value({ libName : "assets", folderPath : "./assets/", args : null })new(scriptName:String, ?args:Array<Dynamic>, folderPath:String = "./assets/", libName:String = "assets", ?modName:String)

Variables

Methods

Inherited Variables

Defined by ModsFolderLibrary

@:value(null)_parsedAsset:String = null

folderPath:String

libName:String

modName:String

@:value("assets/")prefix:String = "assets/"

@:value(true)useImageCache:Bool = true

Inherited Methods

Defined by ModsFolderLibrary

inlinegetFiles(folder:String):Array<String>

inlinegetFolders(folder:String):Array<String>

\ No newline at end of file diff --git a/docs/funkin/backend/assets/ZipFolderLibrary.html b/docs/funkin/backend/assets/ZipFolderLibrary.html index 5691ca7..0cda8bf 100644 --- a/docs/funkin/backend/assets/ZipFolderLibrary.html +++ b/docs/funkin/backend/assets/ZipFolderLibrary.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(zipPath:String, libName:String)

Variables

@:value([])assets:Map<String, SysZipEntry> = []

libName:String

@:value("assets/")prefix:String = "assets/"

@:value(false)useImageCache:Bool = false

zipPath:String

Methods

@:value({ isLocal : false })__isCacheValid(cache:Map<String, Dynamic>, asset:String, isLocal:Bool = false):Bool

__parseAsset(asset:String):Bool

getFiles(folder:String):Array<String>

getFolders(folder:String):Array<String>

inlineunzip(f:SysZipEntry):Null<Bytes>

\ No newline at end of file +

Constructor

new(zipPath:String, libName:String, ?modName:String)

Variables

@:value([])assets:Map<String, SysZipEntry> = []

libName:String

modName:String

@:value("assets/")prefix:String = "assets/"

@:value(false)useImageCache:Bool = false

zipPath:String

Methods

@:value({ isLocal : false })__isCacheValid(cache:Map<String, Dynamic>, asset:String, isLocal:Bool = false):Bool

__parseAsset(asset:String):Bool

getFiles(folder:String):Array<String>

getFolders(folder:String):Array<String>

inlineunzip(f:SysZipEntry):Null<Bytes>

\ No newline at end of file diff --git a/docs/funkin/backend/assets/index.html b/docs/funkin/backend/assets/index.html index f47a23c..ea7be22 100644 --- a/docs/funkin/backend/assets/index.html +++ b/docs/funkin/backend/assets/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +

funkin.backend.assets

..
AssetSource

AssetsLibraryList

IModsAssetLibrary

LimeLibrarySymbol

COPIED DIRECTLY FROM LIME SOURCE CAUSE LIME IS SO FUCKING DUMB!!

ModdableAssetsFolder

Used to prevent crashes

ModsFolder

ModsFolderLibrary

MultiFramesCollection

Base class for all frame collections.

Paths

ScriptPathInfo

ScriptedAssetLibrary

ZipFolderLibrary

\ No newline at end of file diff --git a/docs/funkin/backend/chart/BaseGameParser.html b/docs/funkin/backend/chart/BaseGameParser.html index 5ea4c6f..221ff8e 100644 --- a/docs/funkin/backend/chart/BaseGameParser.html +++ b/docs/funkin/backend/chart/BaseGameParser.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticparse(data:Dynamic, result:ChartData):Void

\ No newline at end of file +

Static methods

staticparse(data:Dynamic, result:ChartData):Void

\ No newline at end of file diff --git a/docs/funkin/backend/chart/Chart.html b/docs/funkin/backend/chart/Chart.html index c4ae8fb..9ede4e5 100644 --- a/docs/funkin/backend/chart/Chart.html +++ b/docs/funkin/backend/chart/Chart.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(0xFF9271FD)staticinlineread onlydefaultColor:FlxColor = 0xFF9271FD

Default background colors for songs without bg color

Static methods

staticaddNoteType(chart:ChartData, noteTypeName:String):Int

staticfilterChartForSaving(chart:ChartData, ?saveMetaInChart:Bool):ChartData

@:value({ fromMods : true, difficulty : "normal" })staticloadChartMeta(songName:String, difficulty:String = "normal", fromMods:Bool = true):ChartMetaData

@:value({ difficulty : "normal" })staticparse(songName:String, difficulty:String = "normal"):ChartData

@:value({ difficulty : "normal" })staticsave(songFolderPath:String, chart:ChartData, difficulty:String = "normal", ?saveSettings:ChartSaveSettings):ChartData

Saves the chart to the specific song folder path.

Parameters:

songFolderPath

Path to the song folder (ex: mods/your mod/songs/song/)

chart

Chart to save

difficulty

Name of the difficulty

saveSettings

Returns:

Filtered chart used for saving.

\ No newline at end of file +

Static variables

@:value(0xFF9271FD)staticinlineread onlydefaultColor:FlxColor = 0xFF9271FD

Default background colors for songs without bg color

Static methods

staticaddNoteType(chart:ChartData, noteTypeName:String):Int

staticfilterChartForSaving(chart:ChartData, ?saveMetaInChart:Bool, ?saveEventsInChart:Bool):ChartData

@:value({ fromMods : true, difficulty : "normal" })staticloadChartMeta(songName:String, difficulty:String = "normal", fromMods:Bool = true):ChartMetaData

staticloadEventsJson(songName:String):Array<ChartEvent>

@:value({ difficulty : "normal" })staticparse(songName:String, difficulty:String = "normal"):ChartData

@:value({ difficulty : "normal" })staticsave(songFolderPath:String, chart:ChartData, difficulty:String = "normal", ?saveSettings:ChartSaveSettings):ChartData

Saves the chart to the specific song folder path.

Parameters:

songFolderPath

Path to the song folder (ex: mods/your mod/songs/song/)

chart

Chart to save

difficulty

Name of the difficulty

saveSettings

Returns:

Filtered chart used for saving.

\ No newline at end of file diff --git a/docs/funkin/backend/chart/ChartData.html b/docs/funkin/backend/chart/ChartData.html index ecc4fba..df52f86 100644 --- a/docs/funkin/backend/chart/ChartData.html +++ b/docs/funkin/backend/chart/ChartData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

stage:String

noteTypes:Array<String>

@:optionaloptionalfromMods:Null<Bool>

\ No newline at end of file +

Fields

stage:String

noteTypes:Array<String>

@:optionaloptionalfromMods:Null<Bool>

\ No newline at end of file diff --git a/docs/funkin/backend/chart/ChartEvent.html b/docs/funkin/backend/chart/ChartEvent.html index 92c7e21..2266fe0 100644 --- a/docs/funkin/backend/chart/ChartEvent.html +++ b/docs/funkin/backend/chart/ChartEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

time:Float

params:Array<Dynamic>

name:String

\ No newline at end of file +

Fields

time:Float

params:Array<Dynamic>

name:String

\ No newline at end of file diff --git a/docs/funkin/backend/chart/ChartMetaData.html b/docs/funkin/backend/chart/ChartMetaData.html index 2bfe09e..a2cbcff 100644 --- a/docs/funkin/backend/chart/ChartMetaData.html +++ b/docs/funkin/backend/chart/ChartMetaData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionalstepsPerBeat:Null<Float>

@:optionaloptionalparsedColor:Null<FlxColor>

@:optionaloptionalopponentModeAllowed:Null<Bool>

@:optionaloptionalneedsVoices:Null<Bool>

name:String

@:optionaloptionalicon:Null<String>

@:optionaloptionaldisplayName:Null<String>

@:optionaloptionaldifficulties:Null<Array<String>>

@:optionaloptionalcoopAllowed:Null<Bool>

@:optionaloptionalcolor:Null<Dynamic>

@:optionaloptionalbpm:Null<Float>

@:optionaloptionalbeatsPerMesure:Null<Float>

\ No newline at end of file +

Fields

@:optionaloptionalstepsPerBeat:Null<Float>

@:optionaloptionalparsedColor:Null<FlxColor>

@:optionaloptionalopponentModeAllowed:Null<Bool>

@:optionaloptionalneedsVoices:Null<Bool>

name:String

@:optionaloptionalicon:Null<String>

@:optionaloptionaldisplayName:Null<String>

@:optionaloptionaldifficulties:Null<Array<String>>

@:optionaloptionalcustomValues:Null<Dynamic>

@:optionaloptionalcoopAllowed:Null<Bool>

@:optionaloptionalcolor:Null<Dynamic>

@:optionaloptionalbpm:Null<Float>

@:optionaloptionalbeatsPerMeasure:Null<Float>

\ No newline at end of file diff --git a/docs/funkin/backend/chart/ChartNote.html b/docs/funkin/backend/chart/ChartNote.html index 547b98e..f825977 100644 --- a/docs/funkin/backend/chart/ChartNote.html +++ b/docs/funkin/backend/chart/ChartNote.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

type:Int

time:Float

sLen:Float

id:Int

\ No newline at end of file +

Fields

type:Int

time:Float

sLen:Float

id:Int

\ No newline at end of file diff --git a/docs/funkin/backend/chart/ChartSaveSettings.html b/docs/funkin/backend/chart/ChartSaveSettings.html index f47643d..16a1a0c 100644 --- a/docs/funkin/backend/chart/ChartSaveSettings.html +++ b/docs/funkin/backend/chart/ChartSaveSettings.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionalsaveMetaInChart:Null<Bool>

@:optionaloptionalprettyPrint:Null<Bool>

@:optionaloptionaloverrideExistingMeta:Null<Bool>

\ No newline at end of file +

Fields

@:optionaloptionalsaveMetaInChart:Null<Bool>

@:optionaloptionalsaveEventsInChart:Null<Bool>

@:optionaloptionalprettyPrint:Null<Bool>

@:optionaloptionaloverrideExistingMeta:Null<Bool>

\ No newline at end of file diff --git a/docs/funkin/backend/chart/ChartStrumLine.html b/docs/funkin/backend/chart/ChartStrumLine.html index 9878a0a..81b206c 100644 --- a/docs/funkin/backend/chart/ChartStrumLine.html +++ b/docs/funkin/backend/chart/ChartStrumLine.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionalvisible:Null<Bool>

@:optionaloptionalstrumScale:Null<Float>

@:optionaloptionalstrumPos:Null<Array<Float>>

@:optionaloptionalstrumLinePos:Null<Float>

@:optionaloptionalscrollSpeed:Null<Float>

position:String

characters:Array<String>

\ No newline at end of file +

Fields

@:optionaloptionalvocalsSuffix:Null<String>

@:optionaloptionalvisible:Null<Bool>

@:optionaloptionalstrumScale:Null<Float>

@:optionaloptionalstrumPos:Null<Array<Float>>

@:optionaloptionalstrumLinePos:Null<Float>

@:optionaloptionalscrollSpeed:Null<Float>

position:String

characters:Array<String>

\ No newline at end of file diff --git a/docs/funkin/backend/chart/ChartStrumLineType.html b/docs/funkin/backend/chart/ChartStrumLineType.html index a4520fb..6d73b80 100644 --- a/docs/funkin/backend/chart/ChartStrumLineType.html +++ b/docs/funkin/backend/chart/ChartStrumLineType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast 2)@:impl@:enuminlineread onlyADDITIONAL:ChartStrumLineType = 2

STRUMLINE IS MARKED AS ADDITIONAL - WILL BE PLAYED AS CPU EVEN IF OPPONENT MODE IS ENABLED

@:value(cast 0)@:impl@:enuminlineread onlyOPPONENT:ChartStrumLineType = 0

STRUMLINE IS MARKED AS OPPONENT - WILL BE PLAYED BY CPU, OR PLAYED BY PLAYER IF OPPONENT MODE IS ON

@:value(cast 1)@:impl@:enuminlineread onlyPLAYER:ChartStrumLineType = 1

STRUMLINE IS MARKED AS PLAYER - WILL BE PLAYED AS PLAYER, OR PLAYED AS CPU IF OPPONENT MODE IS ON

\ No newline at end of file +

Variables

@:value(cast 2)@:impl@:enuminlineread onlyADDITIONAL:ChartStrumLineType = 2

STRUMLINE IS MARKED AS ADDITIONAL - WILL BE PLAYED AS CPU EVEN IF OPPONENT MODE IS ENABLED

@:value(cast 0)@:impl@:enuminlineread onlyOPPONENT:ChartStrumLineType = 0

STRUMLINE IS MARKED AS OPPONENT - WILL BE PLAYED BY CPU, OR PLAYED BY PLAYER IF OPPONENT MODE IS ON

@:value(cast 1)@:impl@:enuminlineread onlyPLAYER:ChartStrumLineType = 1

STRUMLINE IS MARKED AS PLAYER - WILL BE PLAYED AS PLAYER, OR PLAYED AS CPU IF OPPONENT MODE IS ON

\ No newline at end of file diff --git a/docs/funkin/backend/chart/EventInfo.html b/docs/funkin/backend/chart/EventInfo.html index b8cecea..329a942 100644 --- a/docs/funkin/backend/chart/EventInfo.html +++ b/docs/funkin/backend/chart/EventInfo.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

paramValues:Array<Dynamic>

\ No newline at end of file +

Fields

paramValues:Array<Dynamic>

\ No newline at end of file diff --git a/docs/funkin/backend/chart/EventParamInfo.html b/docs/funkin/backend/chart/EventParamInfo.html index a311bc4..36340ea 100644 --- a/docs/funkin/backend/chart/EventParamInfo.html +++ b/docs/funkin/backend/chart/EventParamInfo.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

\ No newline at end of file +

Fields

\ No newline at end of file diff --git a/docs/funkin/backend/chart/EventParamType.html b/docs/funkin/backend/chart/EventParamType.html index d0b961f..8e4a964 100644 --- a/docs/funkin/backend/chart/EventParamType.html +++ b/docs/funkin/backend/chart/EventParamType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Values

TInt(min:Int, max:Int, step:Float)

TFloat(min:Int, max:Int, step:Float, precision:Int)

TDropDown(options:Array<String>)

\ No newline at end of file +

Values

TInt(min:Int, max:Int, step:Float)

TFloat(min:Float, max:Float, step:Float, precision:Int)

TDropDown(options:Array<String>)

\ No newline at end of file diff --git a/docs/funkin/backend/chart/EventsData.html b/docs/funkin/backend/chart/EventsData.html index 1fda92d..cea7fd9 100644 --- a/docs/funkin/backend/chart/EventsData.html +++ b/docs/funkin/backend/chart/EventsData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(["HScript Call", "Camera Movement", "BPM Change", "Alt Animation Toggle"])staticdefaultEventsList:Array<String> = ["HScript Call", "Camera Movement", "BPM Change", "Alt Animation Toggle"]

@:value(["HScript Call" => [{ name : "Function Name", type : TString, defValue : "myFunc" }, { name : "Function Parameters (String split with commas)", type : TString, defValue : "" }], "Camera Movement" => [{ name : "Camera Target", type : TStrumLine, defValue : 0 }], "BPM Change" => [{ name : "Target BPM", type : TFloat(1), defValue : 100 }], "Alt Animation Toggle" => [{ name : "Strumline", type : TStrumLine, defValue : 0 }, { name : "Enable", type : TBool, defValue : true }]])staticdefaultEventsParams:Map<String, Array<EventParamInfo>> = ["HScript Call" => [{ name : "Function Name", type : TString, defValue : "myFunc" }, { name : "Function Parameters (String split with commas)", type : TString, defValue : "" }], "Camera Movement" => [{ name : "Camera Target", type : TStrumLine, defValue : 0 }], "BPM Change" => [{ name : "Target BPM", type : TFloat(1), defValue : 100 }], "Alt Animation Toggle" => [{ name : "Strumline", type : TStrumLine, defValue : 0 }, { name : "Enable", type : TBool, defValue : true }]]

@:value(defaultEventsList.copy())staticeventsList:Array<String> = defaultEventsList.copy()

@:value(defaultEventsParams.copy())staticeventsParams:Map<String, Array<EventParamInfo>> = defaultEventsParams.copy()

Static methods

staticgetEventParams(name:String):Array<EventParamInfo>

staticreloadEvents():Void

\ No newline at end of file +

Static variables

@:value(["HScript Call", "Camera Movement", "Add Camera Zoom", "Camera Modulo Change", "Camera Flash", "BPM Change", "Scroll Speed Change", "Alt Animation Toggle", "Play Animation"])staticdefaultEventsList:Array<String> = ["HScript Call", "Camera Movement", "Add Camera Zoom", "Camera Modulo Change", "Camera Flash", "BPM Change", "Scroll Speed Change", "Alt Animation Toggle", "Play Animation"]

@:value(["HScript Call" => [{ name : "Function Name", type : TString, defValue : "myFunc" }, { name : "Function Parameters (String split with commas)", type : TString, defValue : "" }], "Camera Movement" => [{ name : "Camera Target", type : TStrumLine, defValue : 0 }], "Add Camera Zoom" => [{ name : "Amount", type : TFloat(-10, 10, 0.01, 2), defValue : 0.05 }, { name : "Camera", type : TDropDown(["camGame", "camHUD"]), defValue : "camGame" }], "Camera Modulo Change" => [{ name : "Modulo Interval (Beats)", type : TInt(1, 9999999, 1), defValue : 4 }, { name : "Bump Strength", type : TFloat(0.1, 10, 0.01, 2), defValue : 1 }], "Camera Flash" => [{ name : "Reversed?", type : TBool, defValue : false }, { name : "Color", type : TColorWheel, defValue : "#FFFFFF" }, { name : "Time (Steps)", type : TFloat(0.25, 9999, 0.25, 2), defValue : 4 }, { name : "Camera", type : TDropDown(["camGame", "camHUD"]), defValue : "camHUD" }], "BPM Change" => [{ name : "Target BPM", type : TFloat(1), defValue : 100 }], "Scroll Speed Change" => [{ name : "Tween Speed?", type : TBool, defValue : true }, { name : "New Speed", type : TFloat(0.01, 99, 0.01, 2), defValue : 1. }, { name : "Tween Time (Steps)", type : TFloat(0.25, 9999, 0.25, 2), defValue : 4 }, { name : "Tween Ease (ex: circ, quad, cube)", type : TDropDown(["linear", "back", "bounce", "circ", "cube", "elastic", "expo", "quad", "quart", "quint", "sine", "smoothStep", "smootherStep"]), defValue : "linear" }, { name : "Tween Type (ex: InOut)", type : TDropDown(["In", "Out", "InOut"]), defValue : "In" }], "Alt Animation Toggle" => [{ name : "Enable On Sing Poses", type : TBool, defValue : true }, { name : "Enable On Idle", type : TBool, defValue : true }, { name : "Strumline", type : TStrumLine, defValue : 0 }], "Play Animation" => [{ name : "Character", type : TStrumLine, defValue : 0 }, { name : "Animation", type : TString, defValue : "animation" }]])staticdefaultEventsParams:Map<String, Array<EventParamInfo>> = ["HScript Call" => [{ name : "Function Name", type : TString, defValue : "myFunc" }, { name : "Function Parameters (String split with commas)", type : TString, defValue : "" }], "Camera Movement" => [{ name : "Camera Target", type : TStrumLine, defValue : 0 }], "Add Camera Zoom" => [{ name : "Amount", type : TFloat(-10, 10, 0.01, 2), defValue : 0.05 }, { name : "Camera", type : TDropDown(["camGame", "camHUD"]), defValue : "camGame" }], "Camera Modulo Change" => [{ name : "Modulo Interval (Beats)", type : TInt(1, 9999999, 1), defValue : 4 }, { name : "Bump Strength", type : TFloat(0.1, 10, 0.01, 2), defValue : 1 }], "Camera Flash" => [{ name : "Reversed?", type : TBool, defValue : false }, { name : "Color", type : TColorWheel, defValue : "#FFFFFF" }, { name : "Time (Steps)", type : TFloat(0.25, 9999, 0.25, 2), defValue : 4 }, { name : "Camera", type : TDropDown(["camGame", "camHUD"]), defValue : "camHUD" }], "BPM Change" => [{ name : "Target BPM", type : TFloat(1), defValue : 100 }], "Scroll Speed Change" => [{ name : "Tween Speed?", type : TBool, defValue : true }, { name : "New Speed", type : TFloat(0.01, 99, 0.01, 2), defValue : 1. }, { name : "Tween Time (Steps)", type : TFloat(0.25, 9999, 0.25, 2), defValue : 4 }, { name : "Tween Ease (ex: circ, quad, cube)", type : TDropDown(["linear", "back", "bounce", "circ", "cube", "elastic", "expo", "quad", "quart", "quint", "sine", "smoothStep", "smootherStep"]), defValue : "linear" }, { name : "Tween Type (ex: InOut)", type : TDropDown(["In", "Out", "InOut"]), defValue : "In" }], "Alt Animation Toggle" => [{ name : "Enable On Sing Poses", type : TBool, defValue : true }, { name : "Enable On Idle", type : TBool, defValue : true }, { name : "Strumline", type : TStrumLine, defValue : 0 }], "Play Animation" => [{ name : "Character", type : TStrumLine, defValue : 0 }, { name : "Animation", type : TString, defValue : "animation" }]]

@:value(defaultEventsList.copy())staticeventsList:Array<String> = defaultEventsList.copy()

@:value(defaultEventsParams.copy())staticeventsParams:Map<String, Array<EventParamInfo>> = defaultEventsParams.copy()

Static methods

staticgetEventParams(name:String):Array<EventParamInfo>

staticreloadEvents():Void

\ No newline at end of file diff --git a/docs/funkin/backend/chart/SwagSection.html b/docs/funkin/backend/chart/SwagSection.html index e114378..329af83 100644 --- a/docs/funkin/backend/chart/SwagSection.html +++ b/docs/funkin/backend/chart/SwagSection.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

sectionNotes:Array<Dynamic>

@:optionaloptionalcamTarget:Null<Float>

bpm:Float

altAnim:Bool

\ No newline at end of file +

Fields

sectionNotes:Array<Dynamic>

@:optionaloptionalcamTarget:Null<Float>

bpm:Float

altAnim:Null<Bool>

\ No newline at end of file diff --git a/docs/funkin/backend/chart/SwagSong.html b/docs/funkin/backend/chart/SwagSong.html index 15436d2..af3d61c 100644 --- a/docs/funkin/backend/chart/SwagSong.html +++ b/docs/funkin/backend/chart/SwagSong.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionalstepsPerBeat:Null<Float>

stage:String

speed:Float

song:String

player2:String

player1:String

noteTypes:Array<String>

@:optionaloptionalmaxHealth:Null<Float>

gfVersion:String

gf:String

bpm:Float

@:optionaloptionalbeatsPerMesure:Null<Float>

\ No newline at end of file +

Fields

@:optionaloptionalstepsPerBeat:Null<Float>

stage:String

speed:Float

song:String

player2:String

player1:String

noteTypes:Array<String>

@:optionaloptionalmaxHealth:Null<Float>

gfVersion:String

gf:String

bpm:Float

@:optionaloptionalbeatsPerMeasure:Null<Float>

\ No newline at end of file diff --git a/docs/funkin/backend/chart/index.html b/docs/funkin/backend/chart/index.html index a9a718b..7ec0983 100644 --- a/docs/funkin/backend/chart/index.html +++ b/docs/funkin/backend/chart/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/backend/index.html b/docs/funkin/backend/index.html index c97f97f..7c0f26d 100644 --- a/docs/funkin/backend/index.html +++ b/docs/funkin/backend/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/backend/scripting/DummyScript.html b/docs/funkin/backend/scripting/DummyScript.html index af73baa..458dbc2 100644 --- a/docs/funkin/backend/scripting/DummyScript.html +++ b/docs/funkin/backend/scripting/DummyScript.html @@ -7,5 +7,5 @@ float: none; text-shadow: 0 0 0 transparent; } -

Simple class for empty scripts or scripts whose language isn't imported yet.

Constructor

new(path:String)

Variables

@:value([])variables:Map<String, Dynamic> = []

Methods

Inherited Variables

Defined by Script

fileName:String

Script name (with extension)

@:value(null)path:String = null

Path to the script.

Inherited Methods

Defined by Script

call(func:String, ?parameters:Array<Dynamic>):Dynamic

Calls the function func defined in the script.

Parameters:

func

Name of the function

parameters

(Optional) Parameters of the function.

Returns:

Result (if void, then null)

error(text:String, ?additionalInfo:Dynamic):Void

Shows an error from this script.

Parameters:

text

Text of the error (ex: Null Object Reference).

additionalInfo

Additional information you could provide.

load():Void

Loads the script

onCreate(path:String):Void

onDestroy():Void

onLoad():Void

reload():Void

Hot-reloads the script, if possible

setParent(variable:Dynamic):Void

Sets a script's parent object so that its properties can be accessed easily. Ex: Passing PlayState.instance will allow boyfriend to be typed instead of PlayState.instance.boyfriend.

Parameters:

variable

Parent variable.

setPublicMap(map:Map<String, Dynamic>):Void

HSCRIPT ONLY FOR NOW -Sets the "public" variables map for ScriptPack

trace(v:Dynamic):Void

Traces something as this script.

\ No newline at end of file +

Simple class for empty scripts or scripts whose language isn't imported yet.

Constructor

new(path:String)

Variables

@:value([])variables:Map<String, Dynamic> = []

Methods

Inherited Variables

Defined by Script

extension:String

Script Extension

fileName:String

Script name (with extension)

@:value(null)path:String = null

Path to the script.

@:value([])remappedNames:Map<String, String> = []

Inherited Methods

Defined by Script

call(func:String, ?parameters:Array<Dynamic>):Dynamic

Calls the function func defined in the script.

Parameters:

func

Name of the function

parameters

(Optional) Parameters of the function.

Returns:

Result (if void, then null)

error(text:String, ?additionalInfo:Dynamic):Void

Shows an error from this script.

Parameters:

text

Text of the error (ex: Null Object Reference).

additionalInfo

Additional information you could provide.

load():Void

Loads the script

loadFromString(code:String):Script

Loads the code from a string, doesnt really work after the script has been loaded

Parameters:

code

The code.

onCreate(path:String):Void

onLoad():Void

reload():Void

Hot-reloads the script, if possible

setParent(variable:Dynamic):Void

Sets a script's parent object so that its properties can be accessed easily. Ex: Passing PlayState.instance will allow boyfriend to be typed instead of PlayState.instance.boyfriend.

Parameters:

variable

Parent variable.

setPublicMap(map:Map<String, Dynamic>):Void

HSCRIPT ONLY FOR NOW +Sets the "public" variables map for ScriptPack

trace(v:Dynamic):Void

Traces something as this script.

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/EventManager.html b/docs/funkin/backend/scripting/EventManager.html index fceca32..518e6e7 100644 --- a/docs/funkin/backend/scripting/EventManager.html +++ b/docs/funkin/backend/scripting/EventManager.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value([])staticeventKeys:Array<Class<CancellableEvent>> = []

@:value([])staticeventValues:Array<CancellableEvent> = []

Static methods

staticget<T>(cl:Class<T>):T

staticinit():Void

staticreset():Void

\ No newline at end of file +

Static variables

@:value([])staticeventKeys:Array<Class<CancellableEvent>> = []

@:value([])staticeventValues:Array<CancellableEvent> = []

Static methods

staticget<T>(cl:Class<T>):T

staticinit():Void

staticreset():Void

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/GlobalScript.html b/docs/funkin/backend/scripting/GlobalScript.html index 5e3f9e3..043bb66 100644 --- a/docs/funkin/backend/scripting/GlobalScript.html +++ b/docs/funkin/backend/scripting/GlobalScript.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Class for THE Global Script, aka script that runs in the background at all times.

Static variables

Static methods

staticbeatHit(curBeat:Int):Void

staticcall(name:String, ?args:Array<Dynamic>):Void

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

staticinit():Void

staticonModSwitch(newMod:String):Void

staticstepHit(curStep:Int):Void

\ No newline at end of file +

Class for THE Global Script, aka script that runs in the background at all times.

Static variables

Static methods

staticbeatHit(curBeat:Int):Void

staticcall(name:String, ?args:Array<Dynamic>):Void

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

staticinit():Void

staticonModSwitch(newMod:String):Void

staticstepHit(curStep:Int):Void

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/HScript.html b/docs/funkin/backend/scripting/HScript.html index 2cc183a..f02f84a 100644 --- a/docs/funkin/backend/scripting/HScript.html +++ b/docs/funkin/backend/scripting/HScript.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticinitParser():Parser

Constructor

new(path:String)

Variables

code:String

@:value(null)decls:Array<ModuleDecl> = null

expr:Expr

interp:Interp

parser:Parser

Methods

Inherited Variables

Defined by Script

fileName:String

Script name (with extension)

@:value(null)path:String = null

Path to the script.

Inherited Methods

Defined by Script

call(func:String, ?parameters:Array<Dynamic>):Dynamic

Calls the function func defined in the script.

Parameters:

func

Name of the function

parameters

(Optional) Parameters of the function.

Returns:

Result (if void, then null)

error(text:String, ?additionalInfo:Dynamic):Void

Shows an error from this script.

Parameters:

text

Text of the error (ex: Null Object Reference).

additionalInfo

Additional information you could provide.

load():Void

Loads the script

\ No newline at end of file +

Static methods

staticinitParser():Parser

Constructor

new(path:String)

Variables

@:value(null)code:String = null

expr:Expr

interp:Interp

parser:Parser

Methods

Inherited Variables

Defined by Script

extension:String

Script Extension

fileName:String

Script name (with extension)

@:value(null)path:String = null

Path to the script.

@:value([])remappedNames:Map<String, String> = []

Inherited Methods

Defined by Script

call(func:String, ?parameters:Array<Dynamic>):Dynamic

Calls the function func defined in the script.

Parameters:

func

Name of the function

parameters

(Optional) Parameters of the function.

Returns:

Result (if void, then null)

error(text:String, ?additionalInfo:Dynamic):Void

Shows an error from this script.

Parameters:

text

Text of the error (ex: Null Object Reference).

additionalInfo

Additional information you could provide.

load():Void

Loads the script

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/ModState.html b/docs/funkin/backend/scripting/ModState.html index 8e176bb..a77bb1f 100644 --- a/docs/funkin/backend/scripting/ModState.html +++ b/docs/funkin/backend/scripting/ModState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(null)staticlastName:String = null

Constructor

new(stateName:String)

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

@:value(null)staticlastName:String = null

Constructor

new(stateName:String)

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/ModSubState.html b/docs/funkin/backend/scripting/ModSubState.html index 514c6ee..469b8b6 100644 --- a/docs/funkin/backend/scripting/ModSubState.html +++ b/docs/funkin/backend/scripting/ModSubState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(null)staticlastName:String = null

Constructor

new(stateName:String)

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

@:value(null)staticlastName:String = null

Constructor

new(stateName:String)

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/MultiThreadedScript.html b/docs/funkin/backend/scripting/MultiThreadedScript.html index 5e984b8..4eaf4ca 100644 --- a/docs/funkin/backend/scripting/MultiThreadedScript.html +++ b/docs/funkin/backend/scripting/MultiThreadedScript.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(path:String, ?parentScript:Script)

Variables

@:value(true)callEnded:Bool = true

Whenever the current call has ended.

@:value(null)returnValue:Dynamic = null

Return value of the last call.

script:Script

Script being ran.

Methods

call(func:String, args:Array<Dynamic>):Void

destroy():Void

hget(name:String):Dynamic

hset(name:String, val:Dynamic):Dynamic

\ No newline at end of file +

Constructor

new(path:String, ?parentScript:Script)

Variables

@:value(true)callEnded:Bool = true

Whenever the current call has ended.

@:value(null)returnValue:Dynamic = null

Return value of the last call.

script:Script

Script being ran.

Methods

call(func:String, args:Array<Dynamic>):Void

destroy():Void

hget(name:String):Dynamic

hset(name:String, val:Dynamic):Dynamic

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/Script.html b/docs/funkin/backend/scripting/Script.html index 64ab605..88a3446 100644 --- a/docs/funkin/backend/scripting/Script.html +++ b/docs/funkin/backend/scripting/Script.html @@ -7,6 +7,6 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(null)staticcurScript:Script = null

Currently executing script.

@:value(["hx", "hscript", "hsc", "hxs", "lua"])staticscriptExtensions:Array<String> = ["hx", "hscript", "hsc", "hxs", "lua"]

All available script extensions

@:value([])staticstaticVariables:Map<String, Dynamic> = []

Use "static var thing = true;" in hscript to use those!! -are reset every mod switch so once you're done with them make sure to make them null!!

Static methods

staticcreate(path:String):Script

Creates a script from the specified asset path. The language is automatically determined.

Parameters:

path

Path in assets

staticgetDefaultPreprocessors():Map<String, Dynamic>

staticgetDefaultVariables(?script:Script):Map<String, Dynamic>

Constructor

new(path:String)

Creates a new instance of the script class.

Parameters:

null

path

Variables

fileName:String

Script name (with extension)

@:value(null)path:String = null

Path to the script.

Methods

call(func:String, ?parameters:Array<Dynamic>):Dynamic

Calls the function func defined in the script.

Parameters:

func

Name of the function

parameters

(Optional) Parameters of the function.

Returns:

Result (if void, then null)

error(text:String, ?additionalInfo:Dynamic):Void

Shows an error from this script.

Parameters:

text

Text of the error (ex: Null Object Reference).

additionalInfo

Additional information you could provide.

get(variable:String):Dynamic

Gets the variable variable from the script's variables.

Parameters:

variable

Name of the variable.

Returns:

Variable (or null if it doesn't exists)

load():Void

Loads the script

onCreate(path:String):Void

onDestroy():Void

onLoad():Void

reload():Void

Hot-reloads the script, if possible

set(variable:String, value:Dynamic):Void

Gets the variable variable from the script's variables.

Parameters:

variable

Name of the variable.

Returns:

Variable (or null if it doesn't exists)

setParent(variable:Dynamic):Void

Sets a script's parent object so that its properties can be accessed easily. Ex: Passing PlayState.instance will allow boyfriend to be typed instead of PlayState.instance.boyfriend.

Parameters:

variable

Parent variable.

setPublicMap(map:Map<String, Dynamic>):Void

HSCRIPT ONLY FOR NOW -Sets the "public" variables map for ScriptPack

trace(v:Dynamic):Void

Traces something as this script.

\ No newline at end of file +

Static variables

@:value(null)staticcurScript:Script = null

Currently executing script.

@:value(["hx", "hscript", "hsc", "hxs", "pack", "lua"])staticscriptExtensions:Array<String> = ["hx", "hscript", "hsc", "hxs", "pack", "lua"]

All available script extensions

@:value([])staticstaticVariables:Map<String, Dynamic> = []

Use "static var thing = true;" in hscript to use those!! +are reset every mod switch so once you're done with them make sure to make them null!!

Static methods

staticcreate(path:String):Script

Creates a script from the specified asset path. The language is automatically determined.

Parameters:

path

Path in assets

staticfromString(code:String, path:String):Script

Creates a script from the string. The language is determined based on the path.

Parameters:

code

code

path

filename

staticgetDefaultPreprocessors():Map<String, Dynamic>

staticgetDefaultVariables(?script:Script):Map<String, Dynamic>

Constructor

new(path:String)

Creates a new instance of the script class.

Parameters:

null

path

Variables

extension:String

Script Extension

fileName:String

Script name (with extension)

@:value(null)path:String = null

Path to the script.

@:value([])remappedNames:Map<String, String> = []

Methods

call(func:String, ?parameters:Array<Dynamic>):Dynamic

Calls the function func defined in the script.

Parameters:

func

Name of the function

parameters

(Optional) Parameters of the function.

Returns:

Result (if void, then null)

error(text:String, ?additionalInfo:Dynamic):Void

Shows an error from this script.

Parameters:

text

Text of the error (ex: Null Object Reference).

additionalInfo

Additional information you could provide.

get(variable:String):Dynamic

Gets the variable variable from the script's variables.

Parameters:

variable

Name of the variable.

Returns:

Variable (or null if it doesn't exists)

load():Void

Loads the script

loadFromString(code:String):Script

Loads the code from a string, doesnt really work after the script has been loaded

Parameters:

code

The code.

onCreate(path:String):Void

onLoad():Void

reload():Void

Hot-reloads the script, if possible

set(variable:String, value:Dynamic):Void

Gets the variable variable from the script's variables.

Parameters:

variable

Name of the variable.

Returns:

Variable (or null if it doesn't exists)

setParent(variable:Dynamic):Void

Sets a script's parent object so that its properties can be accessed easily. Ex: Passing PlayState.instance will allow boyfriend to be typed instead of PlayState.instance.boyfriend.

Parameters:

variable

Parent variable.

setPublicMap(map:Map<String, Dynamic>):Void

HSCRIPT ONLY FOR NOW +Sets the "public" variables map for ScriptPack

trace(v:Dynamic):Void

Traces something as this script.

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/ScriptPack.html b/docs/funkin/backend/scripting/ScriptPack.html index 1a66b66..c823d17 100644 --- a/docs/funkin/backend/scripting/ScriptPack.html +++ b/docs/funkin/backend/scripting/ScriptPack.html @@ -7,5 +7,5 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(name:String)

Variables

@:value([])additionalDefaultVariables:Map<String, Dynamic> = []

@:value(null)parent:Dynamic = null

@:value([])publicVariables:Map<String, Dynamic> = []

@:value([])scripts:Array<Script> = []

Methods

add(script:Script):Void

contains(path:String):Bool

inlineevent<T>(func:String, event:T):T

Sends an event to every single script, and returns the event.

Parameters:

func

Function to call

event

Event (will be the first parameter of the function)

Returns:

(modified by scripts)

getByName(name:String):Script

getByPath(name:String):Script

importScript(path:String):Script

insert(pos:Int, script:Script):Void

remove(script:Script):Void

Inherited Variables

Defined by Script

fileName:String

Script name (with extension)

@:value(null)path:String = null

Path to the script.

Inherited Methods

Defined by Script

error(text:String, ?additionalInfo:Dynamic):Void

Shows an error from this script.

Parameters:

text

Text of the error (ex: Null Object Reference).

additionalInfo

Additional information you could provide.

onLoad():Void

setPublicMap(map:Map<String, Dynamic>):Void

HSCRIPT ONLY FOR NOW -Sets the "public" variables map for ScriptPack

trace(v:Dynamic):Void

Traces something as this script.

\ No newline at end of file +

Constructor

new(name:String)

Variables

@:value([])additionalDefaultVariables:Map<String, Dynamic> = []

@:value(null)parent:Dynamic = null

@:value([])publicVariables:Map<String, Dynamic> = []

@:value([])scripts:Array<Script> = []

Methods

add(script:Script):Void

contains(path:String):Bool

inlineevent<T>(func:String, event:T):T

Sends an event to every single script, and returns the event.

Parameters:

func

Function to call

event

Event (will be the first parameter of the function)

Returns:

(modified by scripts)

getByName(name:String):Script

getByPath(name:String):Script

importScript(path:String):Script

insert(pos:Int, script:Script):Void

remove(script:Script):Void

Inherited Variables

Defined by Script

extension:String

Script Extension

fileName:String

Script name (with extension)

@:value(null)path:String = null

Path to the script.

@:value([])remappedNames:Map<String, String> = []

Inherited Methods

Defined by Script

error(text:String, ?additionalInfo:Dynamic):Void

Shows an error from this script.

Parameters:

text

Text of the error (ex: Null Object Reference).

additionalInfo

Additional information you could provide.

loadFromString(code:String):Script

Loads the code from a string, doesnt really work after the script has been loaded

Parameters:

code

The code.

onLoad():Void

setPublicMap(map:Map<String, Dynamic>):Void

HSCRIPT ONLY FOR NOW +Sets the "public" variables map for ScriptPack

trace(v:Dynamic):Void

Traces something as this script.

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/AmountEvent.html b/docs/funkin/backend/scripting/events/AmountEvent.html index fdd435e..da1f838 100644 --- a/docs/funkin/backend/scripting/events/AmountEvent.html +++ b/docs/funkin/backend/scripting/events/AmountEvent.html @@ -7,6 +7,6 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

amount:Int

Amount

Methods

recycle(amount:Int):AmountEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +

Constructor

new()

Variables

amount:Int

Amount

@:value(true)psychUsersComplained:Bool = true

Shows whether or not psych users complained about this class

Methods

@:value({ psychUsersComplained : true })recycle(amount:Int, psychUsersComplained:Bool = true):AmountEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/CamMoveEvent.html b/docs/funkin/backend/scripting/events/CamMoveEvent.html index 5ae0ead..edfda23 100644 --- a/docs/funkin/backend/scripting/events/CamMoveEvent.html +++ b/docs/funkin/backend/scripting/events/CamMoveEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

focusedCharacters:Int

Number of focused characters

position:FlxPoint

Final camera position.

strumLine:StrumLine

Currently focused strumline.

Methods

recycle(position:FlxPoint, strumLine:StrumLine, focusedCharacters:Int):CamMoveEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/CancellableEvent.html b/docs/funkin/backend/scripting/events/CancellableEvent.html index d905676..5a0bdcf 100644 --- a/docs/funkin/backend/scripting/events/CancellableEvent.html +++ b/docs/funkin/backend/scripting/events/CancellableEvent.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Creates a new cancellable event. +

Constructor

new()

Creates a new cancellable event. This allows scripts to call cancel() to cancel the event.

Variables

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Methods

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/CountdownEvent.html b/docs/funkin/backend/scripting/events/CountdownEvent.html index 1937468..1bca7b8 100644 --- a/docs/funkin/backend/scripting/events/CountdownEvent.html +++ b/docs/funkin/backend/scripting/events/CountdownEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

antialiasing:Bool

Whenever antialiasing is enabled or not.

scale:Float

Scale of the sprite.

sound:FlxSound

Created sound, only available in onPostCountdown

soundPath:String

Path of the intro sound that'll be played.

sprite:FlxSprite

Created sprite, only available in onPostCountdown

spritePath:String

Path to the sprite path that'll be shown.

spriteTween:FlxTween

Created tween for the sprite, only available in onPostCountdown

swagCounter:Int

At which count the countdown is. Normally goes 0-1-2-3-4 unless PlayState.instance.introLength is changed.

volume:Float

Volume at which the intro countdown sound will play.

Methods

recycle(swagCounter:Int, volume:Float, soundPath:String, spritePath:String, scale:Float, antialiasing:Bool, sprite:FlxSprite, spriteTween:FlxTween, sound:FlxSound):CountdownEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/DanceEvent.html b/docs/funkin/backend/scripting/events/DanceEvent.html index 40a66d3..d031ed3 100644 --- a/docs/funkin/backend/scripting/events/DanceEvent.html +++ b/docs/funkin/backend/scripting/events/DanceEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

danced:Bool

Methods

recycle(danced:Bool):DanceEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/DirectionAnimEvent.html b/docs/funkin/backend/scripting/events/DirectionAnimEvent.html index 9a6a098..8e67509 100644 --- a/docs/funkin/backend/scripting/events/DirectionAnimEvent.html +++ b/docs/funkin/backend/scripting/events/DirectionAnimEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

animName:String

Default animation that will be played

context:PlayAnimContext

Context of the animation. Is either equal to SING or MISS.

direction:Int

In which direction the animation will be played

@:value(true)force:Bool = true

Whenever the animation will play reversed or not.

frame:Int

At what frame the animation will start playing

reversed:Bool

Whenever the animation will play reversed or not.

suffix:String

The suffix of the animation (ex: "-alt") - Defaults to ""

Methods

@:value({ force : true })recycle(animName:String, direction:Int, suffix:String, context:PlayAnimContext, reversed:Bool, frame:Int, force:Bool = true):DirectionAnimEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/DiscordPresenceUpdateEvent.html b/docs/funkin/backend/scripting/events/DiscordPresenceUpdateEvent.html index 0d858f7..322e815 100644 --- a/docs/funkin/backend/scripting/events/DiscordPresenceUpdateEvent.html +++ b/docs/funkin/backend/scripting/events/DiscordPresenceUpdateEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

presenceData:DiscordPresenceOptions

Object containing all of the data for the presence. Can be altered.

Methods

recycle(presenceData:DiscordPresenceOptions):DiscordPresenceUpdateEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/DrawEvent.html b/docs/funkin/backend/scripting/events/DrawEvent.html index e36174f..62e13e6 100644 --- a/docs/funkin/backend/scripting/events/DrawEvent.html +++ b/docs/funkin/backend/scripting/events/DrawEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Methods

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/DynamicEvent.html b/docs/funkin/backend/scripting/events/DynamicEvent.html new file mode 100644 index 0000000..64bbf19 --- /dev/null +++ b/docs/funkin/backend/scripting/events/DynamicEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.DynamicEvent

Event with random dynamic values useful for making your own custom events

Constructor

new()

Variables

@:value(null)value1:Dynamic = null

@:value(null)value2:Dynamic = null

@:value(null)value3:Dynamic = null

@:value(null)value4:Dynamic = null

@:value(null)value5:Dynamic = null

Methods

@:value({ value5 : null, value4 : null, value3 : null, value2 : null, value1 : null })recycle(?value1:Dynamic, ?value2:Dynamic, ?value3:Dynamic, ?value4:Dynamic, ?value5:Dynamic):DynamicEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/EventGameEvent.html b/docs/funkin/backend/scripting/events/EventGameEvent.html index 8fffb11..349f369 100644 --- a/docs/funkin/backend/scripting/events/EventGameEvent.html +++ b/docs/funkin/backend/scripting/events/EventGameEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

Methods

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/FreeplayAlphaUpdateEvent.html b/docs/funkin/backend/scripting/events/FreeplayAlphaUpdateEvent.html index 28ffffd..b55d14b 100644 --- a/docs/funkin/backend/scripting/events/FreeplayAlphaUpdateEvent.html +++ b/docs/funkin/backend/scripting/events/FreeplayAlphaUpdateEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

idleAlpha:Float

The alpha when nothing is playing and isnt selected

idlePlayingAlpha:Float

The alpha when something is playing and isnt selected

lerp:Float

The lerp of the alpha

selectedAlpha:Float

The alpha when nothing is playing and selected

selectedPlayingAlpha:Float

The alpha when something is playing and selected

Methods

recycle(idleAlpha:Float, idlePlayingAlpha:Float, selectedAlpha:Float, selectedPlayingAlpha:Float, lerp:Float):FreeplayAlphaUpdateEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/FreeplaySongSelectEvent.html b/docs/funkin/backend/scripting/events/FreeplaySongSelectEvent.html index c5bdfad..cab36cb 100644 --- a/docs/funkin/backend/scripting/events/FreeplaySongSelectEvent.html +++ b/docs/funkin/backend/scripting/events/FreeplaySongSelectEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

coopMode:Bool

Whenever coop mode is enabled.

difficulty:String

Difficulty name

opponentMode:Bool

Whenever opponent mode is enabled or not.

song:String

Song name that is about to be played

Methods

recycle(song:String, difficulty:String, opponentMode:Bool, coopMode:Bool):FreeplaySongSelectEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/GameOverCreationEvent.html b/docs/funkin/backend/scripting/events/GameOverCreationEvent.html new file mode 100644 index 0000000..1d2dbc8 --- /dev/null +++ b/docs/funkin/backend/scripting/events/GameOverCreationEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.GameOverCreationEvent

CANCEL this event to prevent default behaviour!

Constructor

new()

Variables

bpm:Float

character:String

lossSFX:String

player:Bool

retrySFX:String

x:Float

y:Float

Methods

recycle(x:Float, y:Float, character:String, player:Bool, gameOverSong:String, bpm:Float, lossSFX:String, retrySFX:String):GameOverCreationEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/GameOverEvent.html b/docs/funkin/backend/scripting/events/GameOverEvent.html new file mode 100644 index 0000000..9a4241e --- /dev/null +++ b/docs/funkin/backend/scripting/events/GameOverEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.GameOverEvent

Constructor

new()

Variables

character:Character

Character which died. Default to boyfriend.

deathCharID:String

Character ID (name) for game over. Default to whatever is specified in the character's XML.

gameOverSong:String

Song for the game over screen. Default to this.gameOverSong (gameOver)

isPlayer:Bool

If the character has isPlayer

lossSFX:String

SFX at the beginning of the game over (Mic drop). Default to this.lossSFX (gameOverSFX)

retrySFX:String

SFX played whenever the player retries. Defaults to retrySFX (gameOverEnd)

x:Float

The X pos of where the gameover character will be.

y:Float

The Y pos of where the gameover character will be.

Methods

recycle(x:Float, y:Float, character:Character, deathCharID:String, isPlayer:Bool, gameOverSong:String, lossSFX:String, retrySFX:String):GameOverEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/InputSystemEvent.html b/docs/funkin/backend/scripting/events/InputSystemEvent.html index baf08d2..cd37d01 100644 --- a/docs/funkin/backend/scripting/events/InputSystemEvent.html +++ b/docs/funkin/backend/scripting/events/InputSystemEvent.html @@ -12,4 +12,4 @@ For example, justReleased[0] will return whenever the left strum was just released.

pressed:Array<Bool>

Array containing whenever a specific control is pressed or not. For example, pressed[0] will return whenever the left strum was pressed.

strumLine:StrumLine

Strumline which input is being processed.

strumLineID:Int

ID of the Strumline.

Methods

recycle(pressed:Array<Bool>, justPressed:Array<Bool>, justReleased:Array<Bool>, strumLine:StrumLine, strumLineID:Int):InputSystemEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/MenuChangeEvent.html b/docs/funkin/backend/scripting/events/MenuChangeEvent.html index e75db42..f942243 100644 --- a/docs/funkin/backend/scripting/events/MenuChangeEvent.html +++ b/docs/funkin/backend/scripting/events/MenuChangeEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

change:Int

Amount of change

oldValue:Int

Value before the change

@:value(true)playMenuSFX:Bool = true

Whenever the menu SFX should be played.

value:Int

Value after the change

Methods

@:value({ playMenuSFX : true })recycle(oldValue:Int, value:Int, change:Int, playMenuSFX:Bool = true):MenuChangeEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/NameEvent.html b/docs/funkin/backend/scripting/events/NameEvent.html index 90b577f..7a9a6ca 100644 --- a/docs/funkin/backend/scripting/events/NameEvent.html +++ b/docs/funkin/backend/scripting/events/NameEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

name:String

Name

Methods

recycle(name:String):NameEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/NoteCreationEvent.html b/docs/funkin/backend/scripting/events/NoteCreationEvent.html index 36d01f5..e090f59 100644 --- a/docs/funkin/backend/scripting/events/NoteCreationEvent.html +++ b/docs/funkin/backend/scripting/events/NoteCreationEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

animSuffix:String

Sing animation suffix. "-alt" for alt anim or "" for normal notes.

mustHit:Bool

Whenever the note will need to be hit by the player

note:Note

Note that is being created

noteScale:Float

Note scale, if you only want to replace the scale.

noteSprite:String

Note sprite, if you only want to replace the sprite.

noteType:String

Note Type (ex: "My Super Cool Note", or "Mine")

noteTypeID:Int

ID of the note type.

strumID:Int

ID of the strum (from 0 to 3)

strumLineID:Int

ID of the player.

Methods

recycle(note:Note, strumID:Int, noteType:String, noteTypeID:Int, strumLineID:Int, mustHit:Bool, noteSprite:String, noteScale:Float, animSuffix:String):NoteCreationEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/NoteHitEvent.html b/docs/funkin/backend/scripting/events/NoteHitEvent.html index dc02f91..63f8819 100644 --- a/docs/funkin/backend/scripting/events/NoteHitEvent.html +++ b/docs/funkin/backend/scripting/events/NoteHitEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

accuracy:Null<Float>

Accuracy gained from pressing this note. From 0 to 1. null means no accuracy is gained.

animSuffix:String

Suffix of the animation. "-alt" for alt notes, "" for normal ones.

character:Character

Character that pressed the note.

characters:Array<Character>

Characters that pressed the note.

@:value(true)countAsCombo:Bool = true

Whether this hit increases combo.

@:value(true)countScore:Bool = true

Whether this hit increases the score

direction:Int

Direction of the press (0 = Left, 1 = Down, 2 = Up, 3 = Right)

@:value(true)forceAnim:Bool = true

Whenever the animation should be forced to play.

healthGain:Float

The amount of health that'll be gained from pressing that note. If called from onPlayerMiss, the value will be negative.

@:value(true)misses:Bool = true

Whenever a miss should be added.

note:Note

Note that has been pressed

noteType:String

Note Type name (null if default note)

@:value(true)numAntialiasing:Bool = true

Whenever antialiasing should be enabled on combo number.

@:value(0.5)numScale:Float = 0.5

Scale of combo numbers.

player:Bool

Whenever the Character is a player

@:value("sick")rating:String = "sick"

Rating name. Defaults to "sick", "good", "bad" and "shit". Customisable.

@:value(true)ratingAntialiasing:Bool = true

Whenever antialiasing should be enabled on ratings.

ratingPrefix:String

Prefix of the rating sprite path. Defaults to "game/score/"

@:value(0.7)ratingScale:Float = 0.7

Scale of ratings.

ratingSuffix:String

Suffix of the rating sprite path.

score:Int

Score gained after note press.

@:value(null)showRating:Null<Bool> = null

Whenever ratings should be shown or not.

@:value(false)showSplash:Bool = false

Whenever a splash should be shown when the note is hit.

Methods

preventAnim():Void

Prevents the default sing animation from being played.

preventCamZooming():Void

Prevents the camera zoom every 4 beats from enabling.

preventDeletion():Void

Prevents the note from being deleted.

preventLastSustainHit():Void

Prevents the sustain tail (the last one) from being automatically hit when the sustain before it is hit.

preventStrumGlow():Void

Prevents the strum from glowing after this note has been pressed.

preventVocalsMute():Void

Prevents the vocals volume from being muted in case its a parameter of onPlayerMiss

preventVocalsUnmute():Void

Prevents the vocals volume from being set to 1 after pressing the note.

@:value({ forceAnim : true, ratingAntialiasing : true, ratingScale : 0.7, numAntialiasing : true, numScale : 0.5, showSplash : false, rating : "sick", showRating : null, countScore : true, countAsCombo : true, misses : true })recycle(misses:Bool = true, countAsCombo:Bool = true, countScore:Bool = true, ?showRating:Bool, note:Note, characters:Array<Character>, player:Bool, noteType:String, animSuffix:String, ratingPrefix:String, ratingSuffix:String, direction:Int, score:Int, accuracy:Null<Float>, healthGain:Float, rating:String = "sick", showSplash:Bool = false, numScale:Float = 0.5, numAntialiasing:Bool = true, ratingScale:Float = 0.7, ratingAntialiasing:Bool = true, forceAnim:Bool = true):NoteHitEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/NoteMissEvent.html b/docs/funkin/backend/scripting/events/NoteMissEvent.html index 647d4c8..5e5a339 100644 --- a/docs/funkin/backend/scripting/events/NoteMissEvent.html +++ b/docs/funkin/backend/scripting/events/NoteMissEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

accuracy:Null<Float>

Accuracy gained from pressing this note. From 0 to 1. null means no accuracy is gained.

animSuffix:String

Suffix of the animation. "miss" for miss notes, "-alt" for alt notes, "" for normal ones.

character:Character

Character that pressed the note.

characters:Array<Character>

Characters that pressed the note.

direction:Int

Direction of the press (0 = Left, 1 = Down, 2 = Up, 3 = Right)

forceAnim:Bool

Whenever the animation should be forced to play.

gfSad:Bool

gfSadAnim:String

healthGain:Float

The amount of health that'll be gained from missing that note. If called from onPlayerMiss, the value will be negative.

missSound:String

misses:Int

note:Note

Note that has been missed

noteType:String

Note Type name (null if default note)

playerID:Int

Whenever the Character is a player

score:Int

Methods

preventAnim():Void

Prevents the default sing animation from being played.

preventDeletion():Void

Prevents the note from being deleted.

preventMissSound():Void

Prevents the miss sound from played.

preventResetCombo():Void

Prevents the combo from being reset.

preventStunned():Void

Prevents the default sing animation from being played.

preventVocalsMute():Void

Prevents the vocals volume from being muted in case its a parameter of onPlayerMiss

preventVocalsUnmute():Void

Prevents the vocals volume from being set to 1 after pressing the note.

recycle(note:Note, score:Int, misses:Int, muteVocals:Bool, healthGain:Float, missSound:String, missVolume:Float, ghostMiss:Bool, gfSad:Bool, gfSadAnim:String, forceGfAnim:Bool, forceAnim:Bool, animSuffix:String, characters:Array<Character>, playerID:Int, noteType:String, direction:Int, accuracy:Null<Float>):NoteMissEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/NoteUpdateEvent.html b/docs/funkin/backend/scripting/events/NoteUpdateEvent.html index 23a4fdc..f486a54 100644 --- a/docs/funkin/backend/scripting/events/NoteUpdateEvent.html +++ b/docs/funkin/backend/scripting/events/NoteUpdateEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

elapsed:Null<Float>

Time elapsed since last frame

note:Note

Note that is being updated

strum:Strum

Note's strum (can be changed)

Methods

cancelAutoCPUHit():Void

Cancels the automatic CPU hit.

cancelPositionUpdate():Void

Cancels the note position update (note will freeze).

cancelWindowUpdate():Void

Cancels the hit window update.

recycle(note:Note, elapsed:Null<Float>, strum:Strum):NoteUpdateEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/PauseCreationEvent.html b/docs/funkin/backend/scripting/events/PauseCreationEvent.html index ffbea0c..56cb6fe 100644 --- a/docs/funkin/backend/scripting/events/PauseCreationEvent.html +++ b/docs/funkin/backend/scripting/events/PauseCreationEvent.html @@ -9,4 +9,4 @@ }

CANCEL this event to prevent default behaviour!

Constructor

new()

Variables

music:String

Music that is going to be played

options:Array<String>

All option names

Methods

recycle(music:String, options:Array<String>):PauseCreationEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/PlayAnimContext.html b/docs/funkin/backend/scripting/events/PlayAnimContext.html index 312b87b..f92ec9b 100644 --- a/docs/funkin/backend/scripting/events/PlayAnimContext.html +++ b/docs/funkin/backend/scripting/events/PlayAnimContext.html @@ -12,4 +12,4 @@ Prevents the character from dancing, even if the animation ended.

@:value(cast "MISS")@:impl@:enuminlineread onlyMISS:PlayAnimContext = "MISS"

Whenever a note is missed and a miss animation will be played. Only for scripting, since it has the same effects as SING.

@:value(cast null)@:impl@:enuminlineread onlyNONE:PlayAnimContext = null

No context was given for the animation. The character won't dance until the animation is finished

@:value(cast "SING")@:impl@:enuminlineread onlySING:PlayAnimContext = "SING"

Whenever a note is hit and a sing animation will be played. -The character will only dance after their holdTime is reached.

\ No newline at end of file +The character will only dance after their holdTime is reached.

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/PlayAnimEvent.html b/docs/funkin/backend/scripting/events/PlayAnimEvent.html index eb0aa83..ddbc3ff 100644 --- a/docs/funkin/backend/scripting/events/PlayAnimEvent.html +++ b/docs/funkin/backend/scripting/events/PlayAnimEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

animName:String

Name of the animation that's going to be played.

context:PlayAnimContext

Context of the animation

force:Bool

Whenever the animation will be forced or not.

reverse:Bool

Whenever the animation will play in reverse or not

@:value(0)startingFrame:Int = 0

The frame at which the animation will start playing

Methods

@:value({ startingFrame : 0 })recycle(animName:String, force:Bool, reverse:Bool, startingFrame:Int = 0, context:PlayAnimContext):PlayAnimEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/PointEvent.html b/docs/funkin/backend/scripting/events/PointEvent.html index ae7543c..1d8e80d 100644 --- a/docs/funkin/backend/scripting/events/PointEvent.html +++ b/docs/funkin/backend/scripting/events/PointEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

x:Float

X position

y:Float

Y position

Methods

recycle(x:Float, y:Float):PointEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/RatingUpdateEvent.html b/docs/funkin/backend/scripting/events/RatingUpdateEvent.html index e0e2854..dc6861d 100644 --- a/docs/funkin/backend/scripting/events/RatingUpdateEvent.html +++ b/docs/funkin/backend/scripting/events/RatingUpdateEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

oldRating:ComboRating

Old combo (may be null)

Methods

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/ResizeEvent.html b/docs/funkin/backend/scripting/events/ResizeEvent.html index 6bb3e5f..0a5bd4c 100644 --- a/docs/funkin/backend/scripting/events/ResizeEvent.html +++ b/docs/funkin/backend/scripting/events/ResizeEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

height:Int

New height

oldHeight:Null<Int>

Old height (may be null)

oldWidth:Null<Int>

Old width (may be null)

width:Int

New width

Methods

recycle(width:Int, height:Int, oldWidth:Null<Int>, oldHeight:Null<Int>):ResizeEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/SimpleNoteEvent.html b/docs/funkin/backend/scripting/events/SimpleNoteEvent.html index 3d30a71..723371e 100644 --- a/docs/funkin/backend/scripting/events/SimpleNoteEvent.html +++ b/docs/funkin/backend/scripting/events/SimpleNoteEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

note:Note

Note that is affected.

Methods

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/StageNodeEvent.html b/docs/funkin/backend/scripting/events/StageNodeEvent.html index ffb4063..cd68110 100644 --- a/docs/funkin/backend/scripting/events/StageNodeEvent.html +++ b/docs/funkin/backend/scripting/events/StageNodeEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

name:String

The name of the node, quicker access than e.node.name

node:Access

The node which is currently being parsed

sprite:Dynamic

The sprite which was parsed

stage:Stage

The stage instance

Methods

recycle(stage:Stage, node:Access, sprite:Dynamic, name:String):StageNodeEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/StageXMLEvent.html b/docs/funkin/backend/scripting/events/StageXMLEvent.html index dd8833c..bb55797 100644 --- a/docs/funkin/backend/scripting/events/StageXMLEvent.html +++ b/docs/funkin/backend/scripting/events/StageXMLEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

elems:Array<Access>

The object which was parsed

stage:Stage

The stage instance

xml:Access

The xml

Methods

recycle(stage:Stage, xml:Access, elems:Array<Access>):StageXMLEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/StateEvent.html b/docs/funkin/backend/scripting/events/StateEvent.html index f155ead..5c164a8 100644 --- a/docs/funkin/backend/scripting/events/StateEvent.html +++ b/docs/funkin/backend/scripting/events/StateEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

substate:FlxState

Substate that is about to be opened/closed

Methods

recycle(substate:FlxState):StateEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/StrumCreationEvent.html b/docs/funkin/backend/scripting/events/StrumCreationEvent.html index b96af8a..e233431 100644 --- a/docs/funkin/backend/scripting/events/StrumCreationEvent.html +++ b/docs/funkin/backend/scripting/events/StrumCreationEvent.html @@ -10,4 +10,4 @@

Constructor

new()

Variables

animPrefix:String

Animation prefix (left = arrowLEFT, left press, left confirm).

player:Int

s Player ID

@:value("game/notes/default")sprite:String = "game/notes/default"

Sprite path, in case you only want to change the sprite.

strum:Strum

The strum that is being created

strumID:Int

Strum ID, for the sprite.

Methods

cancelAnimation():Void

Cancels the animation that makes the strum "land" in the strumline.

@:value({ sprite : "game/notes/default" })recycle(strum:Strum, player:Int, strumID:Int, animPrefix:String, sprite:String = "game/notes/default"):StrumCreationEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/WeekSelectEvent.html b/docs/funkin/backend/scripting/events/WeekSelectEvent.html index fb9b4b9..20e7843 100644 --- a/docs/funkin/backend/scripting/events/WeekSelectEvent.html +++ b/docs/funkin/backend/scripting/events/WeekSelectEvent.html @@ -9,4 +9,4 @@ }

Constructor

new()

Variables

difficulty:String

The difficulty that has been selected

difficultyID:Int

At which emplacement the difficulty is. Goes from 0 to the number of weeks - 1.

week:WeekData

Week that is going to be selected

weekID:Int

At which emplacement the week is. Goes from 0 to the number of weeks - 1.

Methods

recycle(week:WeekData, difficulty:String, weekID:Int, difficultyID:Int):WeekSelectEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] -[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/DialogueBoxCharPopupEvent.html b/docs/funkin/backend/scripting/events/dialogue/DialogueBoxCharPopupEvent.html new file mode 100644 index 0000000..acff519 --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/DialogueBoxCharPopupEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.dialogue.DialogueBoxCharPopupEvent

Constructor

new()

Variables

Methods

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/DialogueBoxPlayBubbleEvent.html b/docs/funkin/backend/scripting/events/dialogue/DialogueBoxPlayBubbleEvent.html new file mode 100644 index 0000000..00d6379 --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/DialogueBoxPlayBubbleEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.dialogue.DialogueBoxPlayBubbleEvent

Constructor

new()

Variables

bubble:String

customSFX:FlxSound

customTypeSFX:Array<FlxSound>

speed:Float

suffix:String

text:String

Methods

recycle(bubble:String, suffix:String, text:String, format:Array<TextFormat>, speed:Float, customSFX:FlxSound, customTypeSFX:Array<FlxSound>, setTextAfter:Bool, allowDefault:Bool):DialogueBoxPlayBubbleEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/DialogueBoxSetTextEvent.html b/docs/funkin/backend/scripting/events/dialogue/DialogueBoxSetTextEvent.html new file mode 100644 index 0000000..f502c1c --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/DialogueBoxSetTextEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.dialogue.DialogueBoxSetTextEvent

Constructor

new()

Variables

customTypeSFX:Array<FlxSound>

speed:Null<Float>

text:String

Methods

recycle(text:String, format:Array<TextFormat>, speed:Null<Float>, customTypeSFX:Array<FlxSound>):DialogueBoxSetTextEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/DialogueBoxStructureEvent.html b/docs/funkin/backend/scripting/events/dialogue/DialogueBoxStructureEvent.html new file mode 100644 index 0000000..c252f5a --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/DialogueBoxStructureEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.dialogue.DialogueBoxStructureEvent

CANCEL this event to customize from 0 the xml structure part!

Constructor

new()

Variables

name:String

Methods

recycle(name:String, textTypeSFX:String, dialogueBoxData:Access):DialogueBoxStructureEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/DialogueCharHideEvent.html b/docs/funkin/backend/scripting/events/dialogue/DialogueCharHideEvent.html new file mode 100644 index 0000000..7af07a6 --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/DialogueCharHideEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.dialogue.DialogueCharHideEvent

Constructor

new()

Variables

Methods

recycle(animation:String, lastAnimContext:DialogueCharAnimContext):DialogueCharHideEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/DialogueCharShowEvent.html b/docs/funkin/backend/scripting/events/dialogue/DialogueCharShowEvent.html new file mode 100644 index 0000000..880fa61 --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/DialogueCharShowEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.dialogue.DialogueCharShowEvent

Constructor

new()

Variables

Methods

recycle(x:Float, y:Float, animation:String, lastAnimContext:DialogueCharAnimContext):DialogueCharShowEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/DialogueCharStructureEvent.html b/docs/funkin/backend/scripting/events/dialogue/DialogueCharStructureEvent.html new file mode 100644 index 0000000..f30be79 --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/DialogueCharStructureEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.dialogue.DialogueCharStructureEvent

CANCEL this event to customize from 0 the xml structure part!

Constructor

new()

Variables

charData:Access

name:String

position:String

Methods

recycle(name:String, position:String, charData:Access):DialogueCharStructureEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/DialogueStructureEvent.html b/docs/funkin/backend/scripting/events/dialogue/DialogueStructureEvent.html new file mode 100644 index 0000000..ea2a54e --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/DialogueStructureEvent.html @@ -0,0 +1,12 @@ + + + +funkin.backend.scripting.events.dialogue.DialogueStructureEvent

CANCEL this event to customize from 0 the xml structure part!

Constructor

new()

Variables

Methods

recycle(dialogueData:Access):DialogueStructureEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

destroy():Void

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

toString():String

Returns a string representation of the event, in this format: +[CancellableEvent] +[CancellableEvent (Cancelled)]

Returns:

String

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/dialogue/index.html b/docs/funkin/backend/scripting/events/dialogue/index.html new file mode 100644 index 0000000..f90e079 --- /dev/null +++ b/docs/funkin/backend/scripting/events/dialogue/index.html @@ -0,0 +1,10 @@ + + + +funkin.backend.scripting.events.dialogue

funkin.backend.scripting.events.dialogue

..
DialogueBoxCharPopupEvent

DialogueBoxPlayBubbleEvent

DialogueBoxSetTextEvent

DialogueBoxStructureEvent

CANCEL this event to customize from 0 the xml structure part!

DialogueCharHideEvent

DialogueCharShowEvent

DialogueCharStructureEvent

CANCEL this event to customize from 0 the xml structure part!

DialogueStructureEvent

CANCEL this event to customize from 0 the xml structure part!

\ No newline at end of file diff --git a/docs/funkin/backend/scripting/events/index.html b/docs/funkin/backend/scripting/events/index.html index b1ded22..6a1d3aa 100644 --- a/docs/funkin/backend/scripting/events/index.html +++ b/docs/funkin/backend/scripting/events/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/backend/scripting/index.html b/docs/funkin/backend/scripting/index.html index 99af99c..648c31f 100644 --- a/docs/funkin/backend/scripting/index.html +++ b/docs/funkin/backend/scripting/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.backend.scripting

..
events
DummyScript

Simple class for empty scripts or scripts whose language isn't imported yet.

EventManager

GlobalScript

Class for THE Global Script, aka script that runs in the background at all times.

HScript

ModState

ModSubState

MultiThreadedScript

Script

ScriptPack

\ No newline at end of file +

funkin.backend.scripting

..
events
DummyScript

Simple class for empty scripts or scripts whose language isn't imported yet.

EventManager

GlobalScript

Class for THE Global Script, aka script that runs in the background at all times.

HScript

ModState

ModSubState

MultiThreadedScript

Script

ScriptPack

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/BlendModeEffect.html b/docs/funkin/backend/shaders/BlendModeEffect.html index 2e20709..35b5d73 100644 --- a/docs/funkin/backend/shaders/BlendModeEffect.html +++ b/docs/funkin/backend/shaders/BlendModeEffect.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(shader:BlendModeShader, color:FlxColor)

Variables

@:isVarcolor:FlxColor

\ No newline at end of file +

Constructor

new(shader:BlendModeShader, color:FlxColor)

Variables

@:isVarcolor:FlxColor

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/BlendModeShader.html b/docs/funkin/backend/shaders/BlendModeShader.html index 723eb41..28f418f 100644 --- a/docs/funkin/backend/shaders/BlendModeShader.html +++ b/docs/funkin/backend/shaders/BlendModeShader.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

uBlendColor:ShaderParameter_Float

\ No newline at end of file +

Fields

uBlendColor:ShaderParameter_Float

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/CustomShader.html b/docs/funkin/backend/shaders/CustomShader.html index d8be520..4d3382d 100644 --- a/docs/funkin/backend/shaders/CustomShader.html +++ b/docs/funkin/backend/shaders/CustomShader.html @@ -10,4 +10,4 @@

Class for custom shaders.

To create one, create a shaders folder in your assets/mod folder, then add a file named my-shader.frag or/and my-shader.vert.

Non-existent shaders will only load the default one, and throw a warning in the console.

-

To access the shader's uniform variables, use shader.variable

Constructor

@:value({ glslVersion : "120" })new(name:String, glslVersion:String = "120")

Creates a new custom shader

Parameters:

name

Name of the frag and vert files.

glslVersion

GLSL version to use. Defaults to 120.

Variables

@:value("")path:String = ""

Inherited Variables

Defined by FunkinShader

@:value("120")glslVer:String = "120"

Inherited Methods

Defined by FunkinShader

hget(name:String):Dynamic

hset(name:String, val:Dynamic):Dynamic

\ No newline at end of file +

To access the shader's uniform variables, use shader.variable

Constructor

@:value({ glslVersion : "120" })new(name:String, glslVersion:String = "120")

Creates a new custom shader

Parameters:

name

Name of the frag and vert files.

glslVersion

GLSL version to use. Defaults to 120.

Variables

@:value("")path:String = ""

Inherited Variables

Defined by FunkinShader

@:value("120")glslVer:String = "120"

Inherited Methods

Defined by FunkinShader

hget(name:String):Dynamic

hset(name:String, val:Dynamic):Dynamic

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/FunkinShader.html b/docs/funkin/backend/shaders/FunkinShader.html index fda0cb5..a6f3ba6 100644 --- a/docs/funkin/backend/shaders/FunkinShader.html +++ b/docs/funkin/backend/shaders/FunkinShader.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

Constructor

@:value({ glslVer : "120" })new(frag:String, vert:String, glslVer:String = "120")

Creates a new shader from the specified fragment and vertex source. -Accepts #pragma header.

Parameters:

frag

Fragment source (pass null to use default)

vert

Vertex source (pass null to use default)

glslVer

Version of GLSL to use (defaults to 120)

Variables

@:value("120")glslVer:String = "120"

Methods

hget(name:String):Dynamic

hset(name:String, val:Dynamic):Dynamic

\ No newline at end of file +Accepts #pragma header.

Parameters:

frag

Fragment source (pass null to use default)

vert

Vertex source (pass null to use default)

glslVer

Version of GLSL to use (defaults to 120)

Variables

@:value("120")glslVer:String = "120"

Methods

hget(name:String):Dynamic

hset(name:String, val:Dynamic):Dynamic

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/OverlayShader.html b/docs/funkin/backend/shaders/OverlayShader.html index 0b0f9c9..4a93769 100644 --- a/docs/funkin/backend/shaders/OverlayShader.html +++ b/docs/funkin/backend/shaders/OverlayShader.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:glFragmentSource("\r\n#pragma header\r\nuniform vec4 uBlendColor;\r\n\r\nvec3 blendLighten(base:Vec3, blend:Vec3) : Vec3 {\r\n\treturn mix(\r\n\t\t1.0 - 2.0 * (1.0 - base) * (1.0 - blend),\r\n\t\t2.0 * base * blend,\r\n\t\tstep( base, vec3(0.5) )\r\n\t);\r\n}\r\n\r\nvec4 blendLighten(vec4 base, vec4 blend, float opacity)\r\n{\r\n\treturn (blendLighten(base, blend) * opacity + base * (1.0 - opacity));\r\n}\r\n\r\nvoid main()\r\n{\r\n\tvec4 base = texture2D(bitmap, openfl_TextureCoordv);\r\n\tgl_FragColor = blendLighten(base, uBlendColor, uBlendColor.a);\r\n}")new()

Variables

@:keepuBlendColor:ShaderParameter_Float

\ No newline at end of file +

Constructor

@:glFragmentSource("\r\n#pragma header\r\nuniform vec4 uBlendColor;\r\n\r\nvec3 blendLighten(base:Vec3, blend:Vec3) : Vec3 {\r\n\treturn mix(\r\n\t\t1.0 - 2.0 * (1.0 - base) * (1.0 - blend),\r\n\t\t2.0 * base * blend,\r\n\t\tstep( base, vec3(0.5) )\r\n\t);\r\n}\r\n\r\nvec4 blendLighten(vec4 base, vec4 blend, float opacity)\r\n{\r\n\treturn (blendLighten(base, blend) * opacity + base * (1.0 - opacity));\r\n}\r\n\r\nvoid main()\r\n{\r\n\tvec4 base = texture2D(bitmap, openfl_TextureCoordv);\r\n\tgl_FragColor = blendLighten(base, uBlendColor, uBlendColor.a);\r\n}")new()

Variables

@:keepuBlendColor:ShaderParameter_Float

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/ShaderTemplates.html b/docs/funkin/backend/shaders/ShaderTemplates.html index a96c30b..16b58ba 100644 --- a/docs/funkin/backend/shaders/ShaderTemplates.html +++ b/docs/funkin/backend/shaders/ShaderTemplates.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value("#pragma header\r\n\r\nvoid main(void)\r\n{\r\n\tgl_FragColor = flixel_texture2D(bitmap, openfl_TextureCoordv);\r\n}")staticfinalread onlydefaultFragmentSource:String = "#pragma header\r\n\r\nvoid main(void)\r\n{\r\n\tgl_FragColor = flixel_texture2D(bitmap, openfl_TextureCoordv);\r\n}"

@:value("#pragma header\r\n\r\nattribute float alpha;\r\nattribute vec4 colorMultiplier;\r\nattribute vec4 colorOffset;\r\nuniform bool hasColorTransform;\r\n\r\nvoid main(void)\r\n{\r\n\t#pragma body\r\n\r\n\topenfl_Alphav = openfl_Alpha * alpha;\r\n\r\n\tif (hasColorTransform)\r\n\t{\r\n\t\topenfl_ColorOffsetv = colorOffset / 255.0;\r\n\t\topenfl_ColorMultiplierv = colorMultiplier;\r\n\t}\r\n}")staticfinalread onlydefaultVertexSource:String = "#pragma header\r\n\r\nattribute float alpha;\r\nattribute vec4 colorMultiplier;\r\nattribute vec4 colorOffset;\r\nuniform bool hasColorTransform;\r\n\r\nvoid main(void)\r\n{\r\n\t#pragma body\r\n\r\n\topenfl_Alphav = openfl_Alpha * alpha;\r\n\r\n\tif (hasColorTransform)\r\n\t{\r\n\t\topenfl_ColorOffsetv = colorOffset / 255.0;\r\n\t\topenfl_ColorMultiplierv = colorMultiplier;\r\n\t}\r\n}"

@:value("vec4 color = texture2D (bitmap, openfl_TextureCoordv);\r\n\r\nif (color.a == 0.0) {\r\n\r\n\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\r\n\r\n} else if (openfl_HasColorTransform) {\r\n\r\n\tcolor = vec4 (color.rgb / color.a, color.a);\r\n\r\n\tmat4 colorMultiplier = mat4 (0);\r\n\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n\tcolorMultiplier[3][3] = 1.0; // openfl_ColorMultiplierv.w;\r\n\r\n\tcolor = clamp (openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n\tif (color.a > 0.0) {\r\n\r\n\t\tgl_FragColor = vec4 (color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n\r\n\t} else {\r\n\r\n\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\r\n\r\n\t}\r\n\r\n} else {\r\n\r\n\tgl_FragColor = color * openfl_Alphav;\r\n\r\n}")staticfinalread onlyfragBody:String = "vec4 color = texture2D (bitmap, openfl_TextureCoordv);\r\n\r\nif (color.a == 0.0) {\r\n\r\n\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\r\n\r\n} else if (openfl_HasColorTransform) {\r\n\r\n\tcolor = vec4 (color.rgb / color.a, color.a);\r\n\r\n\tmat4 colorMultiplier = mat4 (0);\r\n\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n\tcolorMultiplier[3][3] = 1.0; // openfl_ColorMultiplierv.w;\r\n\r\n\tcolor = clamp (openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n\tif (color.a > 0.0) {\r\n\r\n\t\tgl_FragColor = vec4 (color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n\r\n\t} else {\r\n\r\n\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\r\n\r\n\t}\r\n\r\n} else {\r\n\r\n\tgl_FragColor = color * openfl_Alphav;\r\n\r\n}"

@:value("varying float openfl_Alphav;\r\nvarying vec4 openfl_ColorMultiplierv;\r\nvarying vec4 openfl_ColorOffsetv;\r\nvarying vec2 openfl_TextureCoordv;\r\n\r\nuniform bool openfl_HasColorTransform;\r\nuniform vec2 openfl_TextureSize;\r\nuniform sampler2D bitmap;\r\n\r\nuniform bool hasTransform;\r\nuniform bool hasColorTransform;\r\n\r\nvec4 flixel_texture2D(sampler2D bitmap, vec2 coord)\r\n{\r\n\tvec4 color = texture2D(bitmap, coord);\r\n\tif (!hasTransform)\r\n\t{\r\n\t\treturn color;\r\n\t}\r\n\r\n\tif (color.a == 0.0)\r\n\t{\r\n\t\treturn vec4(0.0, 0.0, 0.0, 0.0);\r\n\t}\r\n\r\n\tif (!hasColorTransform)\r\n\t{\r\n\t\treturn color * openfl_Alphav;\r\n\t}\r\n\r\n\tcolor = vec4(color.rgb / color.a, color.a);\r\n\r\n\tmat4 colorMultiplier = mat4(0);\r\n\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n\tcolorMultiplier[3][3] = openfl_ColorMultiplierv.w;\r\n\r\n\tcolor = clamp(openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n\tif (color.a > 0.0)\r\n\t{\r\n\t\treturn vec4(color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n\t}\r\n\treturn vec4(0.0, 0.0, 0.0, 0.0);\r\n}\r\n\r\nuniform vec4 _camSize;\r\n\r\nfloat map(float value, float min1, float max1, float min2, float max2) {\r\n\treturn min2 + (value - min1) * (max2 - min2) / (max1 - min1);\r\n}\r\n\r\nvec2 getCamPos(vec2 pos) {\r\n\tvec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n\treturn vec2(map(pos.x, size.x, size.x + size.z, 0.0, 1.0), map(pos.y, size.y, size.y + size.w, 0.0, 1.0));\r\n}\r\nvec2 camToOg(vec2 pos) {\r\n\tvec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n\treturn vec2(map(pos.x, 0.0, 1.0, size.x, size.x + size.z), map(pos.y, 0.0, 1.0, size.y, size.y + size.w));\r\n}\r\nvec4 textureCam(sampler2D bitmap, vec2 pos) {\r\n\treturn flixel_texture2D(bitmap, camToOg(pos));\r\n}")staticfinalread onlyfragHeader:String = "varying float openfl_Alphav;\r\nvarying vec4 openfl_ColorMultiplierv;\r\nvarying vec4 openfl_ColorOffsetv;\r\nvarying vec2 openfl_TextureCoordv;\r\n\r\nuniform bool openfl_HasColorTransform;\r\nuniform vec2 openfl_TextureSize;\r\nuniform sampler2D bitmap;\r\n\r\nuniform bool hasTransform;\r\nuniform bool hasColorTransform;\r\n\r\nvec4 flixel_texture2D(sampler2D bitmap, vec2 coord)\r\n{\r\n\tvec4 color = texture2D(bitmap, coord);\r\n\tif (!hasTransform)\r\n\t{\r\n\t\treturn color;\r\n\t}\r\n\r\n\tif (color.a == 0.0)\r\n\t{\r\n\t\treturn vec4(0.0, 0.0, 0.0, 0.0);\r\n\t}\r\n\r\n\tif (!hasColorTransform)\r\n\t{\r\n\t\treturn color * openfl_Alphav;\r\n\t}\r\n\r\n\tcolor = vec4(color.rgb / color.a, color.a);\r\n\r\n\tmat4 colorMultiplier = mat4(0);\r\n\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n\tcolorMultiplier[3][3] = openfl_ColorMultiplierv.w;\r\n\r\n\tcolor = clamp(openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n\tif (color.a > 0.0)\r\n\t{\r\n\t\treturn vec4(color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n\t}\r\n\treturn vec4(0.0, 0.0, 0.0, 0.0);\r\n}\r\n\r\nuniform vec4 _camSize;\r\n\r\nfloat map(float value, float min1, float max1, float min2, float max2) {\r\n\treturn min2 + (value - min1) * (max2 - min2) / (max1 - min1);\r\n}\r\n\r\nvec2 getCamPos(vec2 pos) {\r\n\tvec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n\treturn vec2(map(pos.x, size.x, size.x + size.z, 0.0, 1.0), map(pos.y, size.y, size.y + size.w, 0.0, 1.0));\r\n}\r\nvec2 camToOg(vec2 pos) {\r\n\tvec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n\treturn vec2(map(pos.x, 0.0, 1.0, size.x, size.x + size.z), map(pos.y, 0.0, 1.0, size.y, size.y + size.w));\r\n}\r\nvec4 textureCam(sampler2D bitmap, vec2 pos) {\r\n\treturn flixel_texture2D(bitmap, camToOg(pos));\r\n}"

@:value("openfl_Alphav = openfl_Alpha;\r\nopenfl_TextureCoordv = openfl_TextureCoord;\r\n\r\nif (openfl_HasColorTransform) {\r\n\r\n\topenfl_ColorMultiplierv = openfl_ColorMultiplier;\r\n\topenfl_ColorOffsetv = openfl_ColorOffset / 255.0;\r\n\r\n}\r\n\r\ngl_Position = openfl_Matrix * openfl_Position;")staticfinalread onlyvertBody:String = "openfl_Alphav = openfl_Alpha;\r\nopenfl_TextureCoordv = openfl_TextureCoord;\r\n\r\nif (openfl_HasColorTransform) {\r\n\r\n\topenfl_ColorMultiplierv = openfl_ColorMultiplier;\r\n\topenfl_ColorOffsetv = openfl_ColorOffset / 255.0;\r\n\r\n}\r\n\r\ngl_Position = openfl_Matrix * openfl_Position;"

@:value("attribute float openfl_Alpha;\r\nattribute vec4 openfl_ColorMultiplier;\r\nattribute vec4 openfl_ColorOffset;\r\nattribute vec4 openfl_Position;\r\nattribute vec2 openfl_TextureCoord;\r\n\r\nvarying float openfl_Alphav;\r\nvarying vec4 openfl_ColorMultiplierv;\r\nvarying vec4 openfl_ColorOffsetv;\r\nvarying vec2 openfl_TextureCoordv;\r\n\r\nuniform mat4 openfl_Matrix;\r\nuniform bool openfl_HasColorTransform;\r\nuniform vec2 openfl_TextureSize;")staticfinalread onlyvertHeader:String = "attribute float openfl_Alpha;\r\nattribute vec4 openfl_ColorMultiplier;\r\nattribute vec4 openfl_ColorOffset;\r\nattribute vec4 openfl_Position;\r\nattribute vec2 openfl_TextureCoord;\r\n\r\nvarying float openfl_Alphav;\r\nvarying vec4 openfl_ColorMultiplierv;\r\nvarying vec4 openfl_ColorOffsetv;\r\nvarying vec2 openfl_TextureCoordv;\r\n\r\nuniform mat4 openfl_Matrix;\r\nuniform bool openfl_HasColorTransform;\r\nuniform vec2 openfl_TextureSize;"

\ No newline at end of file +

Static variables

@:value("#pragma header\r\n\r\nvoid main(void)\r\n{\r\n\tgl_FragColor = flixel_texture2D(bitmap, openfl_TextureCoordv);\r\n}")staticfinalread onlydefaultFragmentSource:String = "#pragma header\r\n\r\nvoid main(void)\r\n{\r\n\tgl_FragColor = flixel_texture2D(bitmap, openfl_TextureCoordv);\r\n}"

@:value("#pragma header\r\n\r\nattribute float alpha;\r\nattribute vec4 colorMultiplier;\r\nattribute vec4 colorOffset;\r\nuniform bool hasColorTransform;\r\n\r\nvoid main(void)\r\n{\r\n\t#pragma body\r\n\r\n\topenfl_Alphav = openfl_Alpha * alpha;\r\n\r\n\tif (hasColorTransform)\r\n\t{\r\n\t\topenfl_ColorOffsetv = colorOffset / 255.0;\r\n\t\topenfl_ColorMultiplierv = colorMultiplier;\r\n\t}\r\n}")staticfinalread onlydefaultVertexSource:String = "#pragma header\r\n\r\nattribute float alpha;\r\nattribute vec4 colorMultiplier;\r\nattribute vec4 colorOffset;\r\nuniform bool hasColorTransform;\r\n\r\nvoid main(void)\r\n{\r\n\t#pragma body\r\n\r\n\topenfl_Alphav = openfl_Alpha * alpha;\r\n\r\n\tif (hasColorTransform)\r\n\t{\r\n\t\topenfl_ColorOffsetv = colorOffset / 255.0;\r\n\t\topenfl_ColorMultiplierv = colorMultiplier;\r\n\t}\r\n}"

@:value("vec4 color = texture2D (bitmap, openfl_TextureCoordv);\r\n\r\nif (color.a == 0.0) {\r\n\r\n\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\r\n\r\n} else if (openfl_HasColorTransform) {\r\n\r\n\tcolor = vec4 (color.rgb / color.a, color.a);\r\n\r\n\tmat4 colorMultiplier = mat4 (0);\r\n\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n\tcolorMultiplier[3][3] = 1.0; // openfl_ColorMultiplierv.w;\r\n\r\n\tcolor = clamp (openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n\tif (color.a > 0.0) {\r\n\r\n\t\tgl_FragColor = vec4 (color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n\r\n\t} else {\r\n\r\n\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\r\n\r\n\t}\r\n\r\n} else {\r\n\r\n\tgl_FragColor = color * openfl_Alphav;\r\n\r\n}")staticfinalread onlyfragBody:String = "vec4 color = texture2D (bitmap, openfl_TextureCoordv);\r\n\r\nif (color.a == 0.0) {\r\n\r\n\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\r\n\r\n} else if (openfl_HasColorTransform) {\r\n\r\n\tcolor = vec4 (color.rgb / color.a, color.a);\r\n\r\n\tmat4 colorMultiplier = mat4 (0);\r\n\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n\tcolorMultiplier[3][3] = 1.0; // openfl_ColorMultiplierv.w;\r\n\r\n\tcolor = clamp (openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n\tif (color.a > 0.0) {\r\n\r\n\t\tgl_FragColor = vec4 (color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n\r\n\t} else {\r\n\r\n\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\r\n\r\n\t}\r\n\r\n} else {\r\n\r\n\tgl_FragColor = color * openfl_Alphav;\r\n\r\n}"

@:value("varying float openfl_Alphav;\r\nvarying vec4 openfl_ColorMultiplierv;\r\nvarying vec4 openfl_ColorOffsetv;\r\nvarying vec2 openfl_TextureCoordv;\r\n\r\nuniform bool openfl_HasColorTransform;\r\nuniform vec2 openfl_TextureSize;\r\nuniform sampler2D bitmap;\r\n\r\nuniform bool hasTransform;\r\nuniform bool hasColorTransform;\r\n\r\nvec4 flixel_texture2D(sampler2D bitmap, vec2 coord)\r\n{\r\n\tvec4 color = texture2D(bitmap, coord);\r\n\tif (!hasTransform)\r\n\t{\r\n\t\treturn color;\r\n\t}\r\n\r\n\tif (color.a == 0.0)\r\n\t{\r\n\t\treturn vec4(0.0, 0.0, 0.0, 0.0);\r\n\t}\r\n\r\n\tif (!hasColorTransform)\r\n\t{\r\n\t\treturn color * openfl_Alphav;\r\n\t}\r\n\r\n\tcolor = vec4(color.rgb / color.a, color.a);\r\n\r\n\tmat4 colorMultiplier = mat4(0);\r\n\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n\tcolorMultiplier[3][3] = openfl_ColorMultiplierv.w;\r\n\r\n\tcolor = clamp(openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n\tif (color.a > 0.0)\r\n\t{\r\n\t\treturn vec4(color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n\t}\r\n\treturn vec4(0.0, 0.0, 0.0, 0.0);\r\n}\r\n\r\nuniform vec4 _camSize;\r\n\r\nfloat map(float value, float min1, float max1, float min2, float max2) {\r\n\treturn min2 + (value - min1) * (max2 - min2) / (max1 - min1);\r\n}\r\n\r\nvec2 getCamPos(vec2 pos) {\r\n\tvec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n\treturn vec2(map(pos.x, size.x, size.x + size.z, 0.0, 1.0), map(pos.y, size.y, size.y + size.w, 0.0, 1.0));\r\n}\r\nvec2 camToOg(vec2 pos) {\r\n\tvec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n\treturn vec2(map(pos.x, 0.0, 1.0, size.x, size.x + size.z), map(pos.y, 0.0, 1.0, size.y, size.y + size.w));\r\n}\r\nvec4 textureCam(sampler2D bitmap, vec2 pos) {\r\n\treturn flixel_texture2D(bitmap, camToOg(pos));\r\n}")staticfinalread onlyfragHeader:String = "varying float openfl_Alphav;\r\nvarying vec4 openfl_ColorMultiplierv;\r\nvarying vec4 openfl_ColorOffsetv;\r\nvarying vec2 openfl_TextureCoordv;\r\n\r\nuniform bool openfl_HasColorTransform;\r\nuniform vec2 openfl_TextureSize;\r\nuniform sampler2D bitmap;\r\n\r\nuniform bool hasTransform;\r\nuniform bool hasColorTransform;\r\n\r\nvec4 flixel_texture2D(sampler2D bitmap, vec2 coord)\r\n{\r\n\tvec4 color = texture2D(bitmap, coord);\r\n\tif (!hasTransform)\r\n\t{\r\n\t\treturn color;\r\n\t}\r\n\r\n\tif (color.a == 0.0)\r\n\t{\r\n\t\treturn vec4(0.0, 0.0, 0.0, 0.0);\r\n\t}\r\n\r\n\tif (!hasColorTransform)\r\n\t{\r\n\t\treturn color * openfl_Alphav;\r\n\t}\r\n\r\n\tcolor = vec4(color.rgb / color.a, color.a);\r\n\r\n\tmat4 colorMultiplier = mat4(0);\r\n\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n\tcolorMultiplier[3][3] = openfl_ColorMultiplierv.w;\r\n\r\n\tcolor = clamp(openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n\tif (color.a > 0.0)\r\n\t{\r\n\t\treturn vec4(color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n\t}\r\n\treturn vec4(0.0, 0.0, 0.0, 0.0);\r\n}\r\n\r\nuniform vec4 _camSize;\r\n\r\nfloat map(float value, float min1, float max1, float min2, float max2) {\r\n\treturn min2 + (value - min1) * (max2 - min2) / (max1 - min1);\r\n}\r\n\r\nvec2 getCamPos(vec2 pos) {\r\n\tvec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n\treturn vec2(map(pos.x, size.x, size.x + size.z, 0.0, 1.0), map(pos.y, size.y, size.y + size.w, 0.0, 1.0));\r\n}\r\nvec2 camToOg(vec2 pos) {\r\n\tvec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n\treturn vec2(map(pos.x, 0.0, 1.0, size.x, size.x + size.z), map(pos.y, 0.0, 1.0, size.y, size.y + size.w));\r\n}\r\nvec4 textureCam(sampler2D bitmap, vec2 pos) {\r\n\treturn flixel_texture2D(bitmap, camToOg(pos));\r\n}"

@:value("openfl_Alphav = openfl_Alpha;\r\nopenfl_TextureCoordv = openfl_TextureCoord;\r\n\r\nif (openfl_HasColorTransform) {\r\n\r\n\topenfl_ColorMultiplierv = openfl_ColorMultiplier;\r\n\topenfl_ColorOffsetv = openfl_ColorOffset / 255.0;\r\n\r\n}\r\n\r\ngl_Position = openfl_Matrix * openfl_Position;")staticfinalread onlyvertBody:String = "openfl_Alphav = openfl_Alpha;\r\nopenfl_TextureCoordv = openfl_TextureCoord;\r\n\r\nif (openfl_HasColorTransform) {\r\n\r\n\topenfl_ColorMultiplierv = openfl_ColorMultiplier;\r\n\topenfl_ColorOffsetv = openfl_ColorOffset / 255.0;\r\n\r\n}\r\n\r\ngl_Position = openfl_Matrix * openfl_Position;"

@:value("attribute float openfl_Alpha;\r\nattribute vec4 openfl_ColorMultiplier;\r\nattribute vec4 openfl_ColorOffset;\r\nattribute vec4 openfl_Position;\r\nattribute vec2 openfl_TextureCoord;\r\n\r\nvarying float openfl_Alphav;\r\nvarying vec4 openfl_ColorMultiplierv;\r\nvarying vec4 openfl_ColorOffsetv;\r\nvarying vec2 openfl_TextureCoordv;\r\n\r\nuniform mat4 openfl_Matrix;\r\nuniform bool openfl_HasColorTransform;\r\nuniform vec2 openfl_TextureSize;")staticfinalread onlyvertHeader:String = "attribute float openfl_Alpha;\r\nattribute vec4 openfl_ColorMultiplier;\r\nattribute vec4 openfl_ColorOffset;\r\nattribute vec4 openfl_Position;\r\nattribute vec2 openfl_TextureCoord;\r\n\r\nvarying float openfl_Alphav;\r\nvarying vec4 openfl_ColorMultiplierv;\r\nvarying vec4 openfl_ColorOffsetv;\r\nvarying vec2 openfl_TextureCoordv;\r\n\r\nuniform mat4 openfl_Matrix;\r\nuniform bool openfl_HasColorTransform;\r\nuniform vec2 openfl_TextureSize;"

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/ShaderTypeException.html b/docs/funkin/backend/shaders/ShaderTypeException.html index 16b6343..47aba93 100644 --- a/docs/funkin/backend/shaders/ShaderTypeException.html +++ b/docs/funkin/backend/shaders/ShaderTypeException.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(name:String, has:Class<Dynamic>, want:Dynamic)

\ No newline at end of file +

Constructor

new(name:String, has:Class<Dynamic>, want:Dynamic)

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/WiggleEffect.html b/docs/funkin/backend/shaders/WiggleEffect.html index d738ef2..c995539 100644 --- a/docs/funkin/backend/shaders/WiggleEffect.html +++ b/docs/funkin/backend/shaders/WiggleEffect.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

@:value(DREAMY)effectType:WiggleEffectType = DREAMY

@:value(new WiggleShader())read onlyshader:WiggleShader = new WiggleShader()

@:value(0)waveAmplitude:Float = 0

@:value(0)waveFrequency:Float = 0

@:value(0)waveSpeed:Float = 0

Methods

update(elapsed:Float):Void

\ No newline at end of file +

Constructor

new()

Variables

@:value(DREAMY)effectType:WiggleEffectType = DREAMY

@:value(new WiggleShader())read onlyshader:WiggleShader = new WiggleShader()

@:value(0)waveAmplitude:Float = 0

@:value(0)waveFrequency:Float = 0

@:value(0)waveSpeed:Float = 0

Methods

update(elapsed:Float):Void

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/WiggleEffectType.html b/docs/funkin/backend/shaders/WiggleEffectType.html index e8a55d2..84abea5 100644 --- a/docs/funkin/backend/shaders/WiggleEffectType.html +++ b/docs/funkin/backend/shaders/WiggleEffectType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/backend/shaders/WiggleShader.html b/docs/funkin/backend/shaders/WiggleShader.html index 8c2809d..b3240e2 100644 --- a/docs/funkin/backend/shaders/WiggleShader.html +++ b/docs/funkin/backend/shaders/WiggleShader.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:glFragmentSource("\r\n#pragma header\r\n//uniform float tx, ty; // x,y waves phase\r\nuniform float uTime;\r\n\r\nconst int EFFECT_TYPE_DREAMY = 0;\r\nconst int EFFECT_TYPE_WAVY = 1;\r\nconst int EFFECT_TYPE_HEAT_WAVE_HORIZONTAL = 2;\r\nconst int EFFECT_TYPE_HEAT_WAVE_VERTICAL = 3;\r\nconst int EFFECT_TYPE_FLAG = 4;\r\n\r\nuniform int effectType;\r\n\r\n/**\r\n\t* How fast the waves move over time\r\n\t*/\r\nuniform float uSpeed;\r\n\r\n/**\r\n\t* Number of waves over time\r\n\t*/\r\nuniform float uFrequency;\r\n\r\n/**\r\n\t* How much the pixels are going to stretch over the waves\r\n\t*/\r\nuniform float uWaveAmplitude;\r\n\r\nvec2 sineWave(vec2 pt)\r\n{\r\n\tfloat x = 0.0;\r\n\tfloat y = 0.0;\r\n\r\n\tif (effectType == EFFECT_TYPE_DREAMY)\r\n\t{\r\n\t\tfloat offsetX = sin(pt.y * uFrequency + uTime * uSpeed) * uWaveAmplitude;\r\n\t\tpt.x += offsetX; // * (pt.y - 1.0); // <- Uncomment to stop bottom part of the screen from moving\r\n\t}\r\n\telse if (effectType == EFFECT_TYPE_WAVY)\r\n\t{\r\n\t\tfloat offsetY = sin(pt.x * uFrequency + uTime * uSpeed) * uWaveAmplitude;\r\n\t\tpt.y += offsetY; // * (pt.y - 1.0); // <- Uncomment to stop bottom part of the screen from moving\r\n\t}\r\n\telse if (effectType == EFFECT_TYPE_HEAT_WAVE_HORIZONTAL)\r\n\t{\r\n\t\tx = sin(pt.x * uFrequency + uTime * uSpeed) * uWaveAmplitude;\r\n\t}\r\n\telse if (effectType == EFFECT_TYPE_HEAT_WAVE_VERTICAL)\r\n\t{\r\n\t\ty = sin(pt.y * uFrequency + uTime * uSpeed) * uWaveAmplitude;\r\n\t}\r\n\telse if (effectType == EFFECT_TYPE_FLAG)\r\n\t{\r\n\t\ty = sin(pt.y * uFrequency + 10.0 * pt.x + uTime * uSpeed) * uWaveAmplitude;\r\n\t\tx = sin(pt.x * uFrequency + 5.0 * pt.y + uTime * uSpeed) * uWaveAmplitude;\r\n\t}\r\n\r\n\treturn vec2(pt.x + x, pt.y + y);\r\n}\r\n\r\nvoid main()\r\n{\r\n\tvec2 uv = sineWave(openfl_TextureCoordv);\r\n\tgl_FragColor = texture2D(bitmap, uv);\r\n}")new()

Variables

@:keepeffectType:ShaderParameter_Int

@:keeptx:ShaderParameter_Float

@:keepuFrequency:ShaderParameter_Float

@:keepuSpeed:ShaderParameter_Float

@:keepuTime:ShaderParameter_Float

@:keepuWaveAmplitude:ShaderParameter_Float

\ No newline at end of file +

Constructor

@:glFragmentSource("\r\n#pragma header\r\n//uniform float tx, ty; // x,y waves phase\r\nuniform float uTime;\r\n\r\nconst int EFFECT_TYPE_DREAMY = 0;\r\nconst int EFFECT_TYPE_WAVY = 1;\r\nconst int EFFECT_TYPE_HEAT_WAVE_HORIZONTAL = 2;\r\nconst int EFFECT_TYPE_HEAT_WAVE_VERTICAL = 3;\r\nconst int EFFECT_TYPE_FLAG = 4;\r\n\r\nuniform int effectType;\r\n\r\n/**\r\n\t* How fast the waves move over time\r\n\t*/\r\nuniform float uSpeed;\r\n\r\n/**\r\n\t* Number of waves over time\r\n\t*/\r\nuniform float uFrequency;\r\n\r\n/**\r\n\t* How much the pixels are going to stretch over the waves\r\n\t*/\r\nuniform float uWaveAmplitude;\r\n\r\nvec2 sineWave(vec2 pt)\r\n{\r\n\tfloat x = 0.0;\r\n\tfloat y = 0.0;\r\n\r\n\tif (effectType == EFFECT_TYPE_DREAMY)\r\n\t{\r\n\t\tfloat offsetX = sin(pt.y * uFrequency + uTime * uSpeed) * uWaveAmplitude;\r\n\t\tpt.x += offsetX; // * (pt.y - 1.0); // <- Uncomment to stop bottom part of the screen from moving\r\n\t}\r\n\telse if (effectType == EFFECT_TYPE_WAVY)\r\n\t{\r\n\t\tfloat offsetY = sin(pt.x * uFrequency + uTime * uSpeed) * uWaveAmplitude;\r\n\t\tpt.y += offsetY; // * (pt.y - 1.0); // <- Uncomment to stop bottom part of the screen from moving\r\n\t}\r\n\telse if (effectType == EFFECT_TYPE_HEAT_WAVE_HORIZONTAL)\r\n\t{\r\n\t\tx = sin(pt.x * uFrequency + uTime * uSpeed) * uWaveAmplitude;\r\n\t}\r\n\telse if (effectType == EFFECT_TYPE_HEAT_WAVE_VERTICAL)\r\n\t{\r\n\t\ty = sin(pt.y * uFrequency + uTime * uSpeed) * uWaveAmplitude;\r\n\t}\r\n\telse if (effectType == EFFECT_TYPE_FLAG)\r\n\t{\r\n\t\ty = sin(pt.y * uFrequency + 10.0 * pt.x + uTime * uSpeed) * uWaveAmplitude;\r\n\t\tx = sin(pt.x * uFrequency + 5.0 * pt.y + uTime * uSpeed) * uWaveAmplitude;\r\n\t}\r\n\r\n\treturn vec2(pt.x + x, pt.y + y);\r\n}\r\n\r\nvoid main()\r\n{\r\n\tvec2 uv = sineWave(openfl_TextureCoordv);\r\n\tgl_FragColor = texture2D(bitmap, uv);\r\n}")new()

Variables

@:keepeffectType:ShaderParameter_Int

@:keeptx:ShaderParameter_Float

@:keepuFrequency:ShaderParameter_Float

@:keepuSpeed:ShaderParameter_Float

@:keepuTime:ShaderParameter_Float

@:keepuWaveAmplitude:ShaderParameter_Float

\ No newline at end of file diff --git a/docs/funkin/backend/shaders/index.html b/docs/funkin/backend/shaders/index.html index b177a3e..a8a9efa 100644 --- a/docs/funkin/backend/shaders/index.html +++ b/docs/funkin/backend/shaders/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/backend/system/Action.html b/docs/funkin/backend/system/Action.html index 43ee3a0..2e92f0a 100644 --- a/docs/funkin/backend/system/Action.html +++ b/docs/funkin/backend/system/Action.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast "accept")@:impl@:enuminlineread onlyACCEPT:Action = "accept"

@:value(cast "back")@:impl@:enuminlineread onlyBACK:Action = "back"

@:value(cast "cheat")@:impl@:enuminlineread onlyCHEAT:Action = "cheat"

@:value(cast "down")@:impl@:enuminlineread onlyDOWN:Action = "down"

@:value(cast "down-press")@:impl@:enuminlineread onlyDOWN_P:Action = "down-press"

@:value(cast "down-release")@:impl@:enuminlineread onlyDOWN_R:Action = "down-release"

@:value(cast "left")@:impl@:enuminlineread onlyLEFT:Action = "left"

@:value(cast "left-press")@:impl@:enuminlineread onlyLEFT_P:Action = "left-press"

@:value(cast "left-release")@:impl@:enuminlineread onlyLEFT_R:Action = "left-release"

@:value(cast "note-down")@:impl@:enuminlineread onlyNOTE_DOWN:Action = "note-down"

@:value(cast "note-down-press")@:impl@:enuminlineread onlyNOTE_DOWN_P:Action = "note-down-press"

@:value(cast "note-down-release")@:impl@:enuminlineread onlyNOTE_DOWN_R:Action = "note-down-release"

@:value(cast "note-left")@:impl@:enuminlineread onlyNOTE_LEFT:Action = "note-left"

@:value(cast "note-left-press")@:impl@:enuminlineread onlyNOTE_LEFT_P:Action = "note-left-press"

@:value(cast "note-left-release")@:impl@:enuminlineread onlyNOTE_LEFT_R:Action = "note-left-release"

@:value(cast "note-right")@:impl@:enuminlineread onlyNOTE_RIGHT:Action = "note-right"

@:value(cast "note-right-press")@:impl@:enuminlineread onlyNOTE_RIGHT_P:Action = "note-right-press"

@:value(cast "note-right-release")@:impl@:enuminlineread onlyNOTE_RIGHT_R:Action = "note-right-release"

@:value(cast "note-up")@:impl@:enuminlineread onlyNOTE_UP:Action = "note-up"

@:value(cast "note-up-press")@:impl@:enuminlineread onlyNOTE_UP_P:Action = "note-up-press"

@:value(cast "note-up-release")@:impl@:enuminlineread onlyNOTE_UP_R:Action = "note-up-release"

@:value(cast "pause")@:impl@:enuminlineread onlyPAUSE:Action = "pause"

@:value(cast "reset")@:impl@:enuminlineread onlyRESET:Action = "reset"

@:value(cast "right")@:impl@:enuminlineread onlyRIGHT:Action = "right"

@:value(cast "right-press")@:impl@:enuminlineread onlyRIGHT_P:Action = "right-press"

@:value(cast "right-release")@:impl@:enuminlineread onlyRIGHT_R:Action = "right-release"

@:value(cast "switchmod")@:impl@:enuminlineread onlySWITCHMOD:Action = "switchmod"

@:value(cast "up")@:impl@:enuminlineread onlyUP:Action = "up"

@:value(cast "up-press")@:impl@:enuminlineread onlyUP_P:Action = "up-press"

@:value(cast "up-release")@:impl@:enuminlineread onlyUP_R:Action = "up-release"

\ No newline at end of file +

Variables

@:value(cast "accept")@:impl@:enuminlineread onlyACCEPT:Action = "accept"

@:value(cast "back")@:impl@:enuminlineread onlyBACK:Action = "back"

@:value(cast "cheat")@:impl@:enuminlineread onlyCHEAT:Action = "cheat"

@:value(cast "down")@:impl@:enuminlineread onlyDOWN:Action = "down"

@:value(cast "down-press")@:impl@:enuminlineread onlyDOWN_P:Action = "down-press"

@:value(cast "down-release")@:impl@:enuminlineread onlyDOWN_R:Action = "down-release"

@:value(cast "left")@:impl@:enuminlineread onlyLEFT:Action = "left"

@:value(cast "left-press")@:impl@:enuminlineread onlyLEFT_P:Action = "left-press"

@:value(cast "left-release")@:impl@:enuminlineread onlyLEFT_R:Action = "left-release"

@:value(cast "note-down")@:impl@:enuminlineread onlyNOTE_DOWN:Action = "note-down"

@:value(cast "note-down-press")@:impl@:enuminlineread onlyNOTE_DOWN_P:Action = "note-down-press"

@:value(cast "note-down-release")@:impl@:enuminlineread onlyNOTE_DOWN_R:Action = "note-down-release"

@:value(cast "note-left")@:impl@:enuminlineread onlyNOTE_LEFT:Action = "note-left"

@:value(cast "note-left-press")@:impl@:enuminlineread onlyNOTE_LEFT_P:Action = "note-left-press"

@:value(cast "note-left-release")@:impl@:enuminlineread onlyNOTE_LEFT_R:Action = "note-left-release"

@:value(cast "note-right")@:impl@:enuminlineread onlyNOTE_RIGHT:Action = "note-right"

@:value(cast "note-right-press")@:impl@:enuminlineread onlyNOTE_RIGHT_P:Action = "note-right-press"

@:value(cast "note-right-release")@:impl@:enuminlineread onlyNOTE_RIGHT_R:Action = "note-right-release"

@:value(cast "note-up")@:impl@:enuminlineread onlyNOTE_UP:Action = "note-up"

@:value(cast "note-up-press")@:impl@:enuminlineread onlyNOTE_UP_P:Action = "note-up-press"

@:value(cast "note-up-release")@:impl@:enuminlineread onlyNOTE_UP_R:Action = "note-up-release"

@:value(cast "pause")@:impl@:enuminlineread onlyPAUSE:Action = "pause"

@:value(cast "reset")@:impl@:enuminlineread onlyRESET:Action = "reset"

@:value(cast "right")@:impl@:enuminlineread onlyRIGHT:Action = "right"

@:value(cast "right-press")@:impl@:enuminlineread onlyRIGHT_P:Action = "right-press"

@:value(cast "right-release")@:impl@:enuminlineread onlyRIGHT_R:Action = "right-release"

@:value(cast "switchmod")@:impl@:enuminlineread onlySWITCHMOD:Action = "switchmod"

@:value(cast "up")@:impl@:enuminlineread onlyUP:Action = "up"

@:value(cast "up-press")@:impl@:enuminlineread onlyUP_P:Action = "up-press"

@:value(cast "up-release")@:impl@:enuminlineread onlyUP_R:Action = "up-release"

\ No newline at end of file diff --git a/docs/funkin/backend/system/BPMChangeEvent.html b/docs/funkin/backend/system/BPMChangeEvent.html index 5767979..6d76f60 100644 --- a/docs/funkin/backend/system/BPMChangeEvent.html +++ b/docs/funkin/backend/system/BPMChangeEvent.html @@ -9,4 +9,4 @@ text-shadow: 0 0 0 transparent; }

... -@author

Fields

stepTime:Float

songTime:Float

bpm:Float

\ No newline at end of file +@author

Fields

stepTime:Float

songTime:Float

bpm:Float

\ No newline at end of file diff --git a/docs/funkin/backend/system/CommandLineHandler.html b/docs/funkin/backend/system/CommandLineHandler.html index f891b3f..039fb19 100644 --- a/docs/funkin/backend/system/CommandLineHandler.html +++ b/docs/funkin/backend/system/CommandLineHandler.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticparseCommandLine(cmd:Array<String>):Void

\ No newline at end of file +

Static methods

staticparseCommandLine(cmd:Array<String>):Void

\ No newline at end of file diff --git a/docs/funkin/backend/system/Conductor.html b/docs/funkin/backend/system/Conductor.html index 086eeea..be7ada9 100644 --- a/docs/funkin/backend/system/Conductor.html +++ b/docs/funkin/backend/system/Conductor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(4)staticbeatsPerMesure:Float = 4

Number of beats per mesure (top number in time signature). Defaults to 4.

@:value(100)staticbpm:Float = 100

Current BPM

@:value([])staticbpmChangeMap:Array<BPMChangeEvent> = []

Array of all BPM changes that have been mapped.

@:value(((60 / bpm) * 1000))staticcrochet:Float = ((60 / bpm) * 1000)

Current Crochet (time per beat), in milliseconds.

@:value(0)staticcurBeat:Int = 0

Current beat

@:value(0)staticcurBeatFloat:Float = 0

Current beat, as a Float (ex: 1.24, instead of 1)

@:value(0)staticcurMeasure:Int = 0

Current measure

@:value(0)staticcurMeasureFloat:Float = 0

Current measure, as a Float (ex: 1.24, instead of 1)

@:value(0)staticcurStep:Int = 0

Current step

@:value(0)staticcurStepFloat:Float = 0

Current step, as a Float (ex: 4.94, instead of 4)

@:value(new FlxTypedSignal())staticonBPMChange:FlxTypedSignal<Float ‑> Void> = new FlxTypedSignal()

@:value(new FlxTypedSignal())staticonBeatHit:FlxTypedSignal<Int ‑> Void> = new FlxTypedSignal()

@:value(new FlxTypedSignal())staticonMeasureHit:FlxTypedSignal<Int ‑> Void> = new FlxTypedSignal()

FlxSignals

@:value(new FlxTypedSignal())staticonStepHit:FlxTypedSignal<Int ‑> Void> = new FlxTypedSignal()

@:value(0)staticsongOffset:Float = 0

Offset of the song

staticsongPosition:Float

Current position of the song, in milliseconds.

@:value(crochet / 4)staticstepCrochet:Float = crochet / 4

Current StepCrochet (time per step), in milliseconds.

@:value(4)staticstepsPerBeat:Float = 4

Number of steps per beat (bottom number in time signature). Defaults to 4.

Static methods

@:value({ stepsPerBeat : 4, beatsPerMesure : 4 })staticchangeBPM(newBpm:Float, beatsPerMesure:Float = 4, stepsPerBeat:Float = 4):Void

staticinlinegetMeasureLength():Float

staticinlinegetMeasuresLength():Float

staticgetStepForTime(time:Float):Float

staticgetTimeForStep(step:Float):Float

staticinit():Void

staticmapBPMChanges(song:ChartData):Void

Maps BPM changes from a song.

Parameters:

song

Song to map BPM changes from.

staticreset():Void

staticsetupSong(SONG:ChartData):Void

\ No newline at end of file +

Static variables

@:value(4)staticbeatsPerMeasure:Float = 4

Number of beats per mesure (top number in time signature). Defaults to 4.

@:value(100)staticbpm:Float = 100

Current BPM

@:value([])staticbpmChangeMap:Array<BPMChangeEvent> = []

Array of all BPM changes that have been mapped.

@:value(((60 / bpm) * 1000))staticcrochet:Float = ((60 / bpm) * 1000)

Current Crochet (time per beat), in milliseconds.

@:value(0)staticcurBeat:Int = 0

Current beat

@:value(0)staticcurBeatFloat:Float = 0

Current beat, as a Float (ex: 1.24, instead of 1)

@:value(0)staticcurMeasure:Int = 0

Current measure

@:value(0)staticcurMeasureFloat:Float = 0

Current measure, as a Float (ex: 1.24, instead of 1)

@:value(0)staticcurStep:Int = 0

Current step

@:value(0)staticcurStepFloat:Float = 0

Current step, as a Float (ex: 4.94, instead of 4)

@:value(new FlxTypedSignal())staticonBPMChange:FlxTypedSignal<Float ‑> Void> = new FlxTypedSignal()

@:value(new FlxTypedSignal())staticonBeatHit:FlxTypedSignal<Int ‑> Void> = new FlxTypedSignal()

@:value(new FlxTypedSignal())staticonMeasureHit:FlxTypedSignal<Int ‑> Void> = new FlxTypedSignal()

FlxSignals

@:value(new FlxTypedSignal())staticonStepHit:FlxTypedSignal<Int ‑> Void> = new FlxTypedSignal()

@:value(0)staticsongOffset:Float = 0

Offset of the song

staticsongPosition:Float

Current position of the song, in milliseconds.

@:value(crochet / 4)staticstepCrochet:Float = crochet / 4

Current StepCrochet (time per step), in milliseconds.

@:value(4)staticstepsPerBeat:Float = 4

Number of steps per beat (bottom number in time signature). Defaults to 4.

Static methods

@:value({ stepsPerBeat : 4, beatsPerMeasure : 4 })staticchangeBPM(newBpm:Float, beatsPerMeasure:Float = 4, stepsPerBeat:Float = 4):Void

staticinlinegetMeasureLength():Float

staticinlinegetMeasuresLength():Float

staticgetStepForTime(time:Float):Float

staticgetTimeForStep(step:Float):Float

staticinit():Void

staticmapBPMChanges(song:ChartData):Void

Maps BPM changes from a song.

Parameters:

song

Song to map BPM changes from.

staticreset():Void

staticsetupSong(SONG:ChartData):Void

\ No newline at end of file diff --git a/docs/funkin/backend/system/Control.html b/docs/funkin/backend/system/Control.html index bdf654f..9fa1727 100644 --- a/docs/funkin/backend/system/Control.html +++ b/docs/funkin/backend/system/Control.html @@ -11,4 +11,4 @@ }

Since, in many cases multiple actions should use similar keys, we don't want the rebinding UI to list every action. ActionBinders are what the user perceives as -an input so, for instance, they can't set jump-press and jump-release to different keys.

Values

\ No newline at end of file +an input so, for instance, they can't set jump-press and jump-release to different keys.

Values

UP

LEFT

RIGHT

DOWN

NOTE_UP

NOTE_LEFT

NOTE_RIGHT

NOTE_DOWN

RESET

ACCEPT

BACK

PAUSE

CHEAT

SWITCHMOD

\ No newline at end of file diff --git a/docs/funkin/backend/system/Controls.html b/docs/funkin/backend/system/Controls.html index 4c3fdf1..2227f32 100644 --- a/docs/funkin/backend/system/Controls.html +++ b/docs/funkin/backend/system/Controls.html @@ -9,8 +9,8 @@ text-shadow: 0 0 0 transparent; }

A list of actions that a player would invoke via some input device. -Uses FlxActions to funnel various inputs to a single action.

Constructor

@:value({ scheme : None })new(name:String, scheme:KeyboardScheme = None)

Variables

read onlyACCEPT:Bool

read onlyBACK:Bool

read onlyCHEAT:Bool

read onlyDOWN:Bool

read onlyDOWN_P:Bool

read onlyDOWN_R:Bool

read onlyLEFT:Bool

read onlyLEFT_P:Bool

read onlyLEFT_R:Bool

read onlyNOTE_DOWN:Bool

read onlyNOTE_DOWN_P:Bool

read onlyNOTE_DOWN_R:Bool

read onlyNOTE_LEFT:Bool

read onlyNOTE_LEFT_P:Bool

read onlyNOTE_LEFT_R:Bool

read onlyNOTE_RIGHT:Bool

read onlyNOTE_RIGHT_P:Bool

read onlyNOTE_RIGHT_R:Bool

read onlyNOTE_UP:Bool

read onlyNOTE_UP_P:Bool

read onlyNOTE_UP_R:Bool

read onlyPAUSE:Bool

read onlyRESET:Bool

read onlyRIGHT:Bool

read onlyRIGHT_P:Bool

read onlyRIGHT_R:Bool

read onlySWITCHMOD:Bool

read onlyUP:Bool

read onlyUP_P:Bool

read onlyUP_R:Bool

@:value([])gamepadsAdded:Array<Int> = []

@:value(KeyboardScheme.None)keyboardScheme:KeyboardScheme = KeyboardScheme.None

Methods

addDefaultGamepad(id:Int):Void

addGamepad(id:Int, ?buttonMap:Map<Control, Array<FlxGamepadInputID>>):Void

bindButtons(control:Control, id:Int, buttons:Array<FlxGamepadInputID>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. +Uses FlxActions to funnel various inputs to a single action.

Constructor

@:value({ scheme : None })new(name:String, scheme:KeyboardScheme = None)

Variables

ACCEPT:Bool

BACK:Bool

CHEAT:Bool

DOWN:Bool

DOWN_P:Bool

DOWN_R:Bool

LEFT:Bool

LEFT_P:Bool

LEFT_R:Bool

NOTE_UP:Bool

PAUSE:Bool

RESET:Bool

RIGHT:Bool

RIGHT_P:Bool

RIGHT_R:Bool

UP:Bool

UP_P:Bool

UP_R:Bool

@:value([])gamepadsAdded:Array<Int> = []

@:value(KeyboardScheme.None)keyboardScheme:KeyboardScheme = KeyboardScheme.None

Methods

addDefaultGamepad(id:Int):Void

addGamepad(id:Int, ?buttonMap:Map<Control, Array<FlxGamepadInputID>>):Void

bindButtons(control:Control, id:Int, buttons:Array<FlxGamepadInputID>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. If binder is a literal you can inline this

bindKeys(control:Control, keys:Array<FlxKey>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. If binder is a literal you can inline this

checkByName(name:Action):Bool

copyFrom(controls:Controls, ?device:Device):Void

inlinecopyTo(controls:Controls, ?device:Device):Void

getDialogueName(action:FlxActionDigital):String

getDialogueNameFromToken(token:String):String

getInputsFor(control:Control, device:Device, ?list:Array<Int>):Array<Int>

removeDevice(device:Device):Void

@:value({ deviceID : FlxInputDeviceID.ALL })removeGamepad(deviceID:Int = FlxInputDeviceID.ALL):Void

replaceBinding(control:Control, device:Device, ?toAdd:Int, ?toRemove:Int):Void

@:value({ reset : true })setKeyboardScheme(scheme:KeyboardScheme, reset:Bool = true):Void

unbindButtons(control:Control, gamepadID:Int, buttons:Array<FlxGamepadInputID>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. If binder is a literal you can inline this

unbindKeys(control:Control, keys:Array<FlxKey>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. -If binder is a literal you can inline this

\ No newline at end of file +If binder is a literal you can inline this

\ No newline at end of file diff --git a/docs/funkin/backend/system/Device.html b/docs/funkin/backend/system/Device.html index 4857d52..a367625 100644 --- a/docs/funkin/backend/system/Device.html +++ b/docs/funkin/backend/system/Device.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Values

Gamepad(id:Int)

\ No newline at end of file +

Values

Gamepad(id:Int)

\ No newline at end of file diff --git a/docs/funkin/backend/system/ErrorCode.html b/docs/funkin/backend/system/ErrorCode.html index 828bfad..2385108 100644 --- a/docs/funkin/backend/system/ErrorCode.html +++ b/docs/funkin/backend/system/ErrorCode.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast 1)@:impl@:enuminlineread onlyFAILED:ErrorCode = 1

@:value(cast 2)@:impl@:enuminlineread onlyMISSING_PROPERTY:ErrorCode = 2

@:value(cast 0)@:impl@:enuminlineread onlyOK:ErrorCode = 0

@:value(cast 5)@:impl@:enuminlineread onlyREFLECT_ERROR:ErrorCode = 5

@:value(cast 3)@:impl@:enuminlineread onlyTYPE_INCORRECT:ErrorCode = 3

@:value(cast 4)@:impl@:enuminlineread onlyVALUE_NULL:ErrorCode = 4

\ No newline at end of file +

Variables

@:value(cast 1)@:impl@:enuminlineread onlyFAILED:ErrorCode = 1

@:value(cast 2)@:impl@:enuminlineread onlyMISSING_PROPERTY:ErrorCode = 2

@:value(cast 0)@:impl@:enuminlineread onlyOK:ErrorCode = 0

@:value(cast 5)@:impl@:enuminlineread onlyREFLECT_ERROR:ErrorCode = 5

@:value(cast 3)@:impl@:enuminlineread onlyTYPE_INCORRECT:ErrorCode = 3

@:value(cast 4)@:impl@:enuminlineread onlyVALUE_NULL:ErrorCode = 4

\ No newline at end of file diff --git a/docs/funkin/backend/system/FunkinGame.html b/docs/funkin/backend/system/FunkinGame.html index 843579e..36e637d 100644 --- a/docs/funkin/backend/system/FunkinGame.html +++ b/docs/funkin/backend/system/FunkinGame.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?gameWidth:Int, ?gameHeight:Int, ?initialState:Class<FlxState>, ?updateFramerate:Int, ?drawFramerate:Int, ?skipSplash:Bool, ?startFullscreen:Bool)

Methods

\ No newline at end of file +

Constructor

new(?gameWidth:Int, ?gameHeight:Int, ?initialState:Class<FlxState>, ?updateFramerate:Int, ?drawFramerate:Int, ?skipSplash:Bool, ?startFullscreen:Bool)

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/FunkinRatioScaleMode.html b/docs/funkin/backend/system/FunkinRatioScaleMode.html index 27f681e..dc2d917 100644 --- a/docs/funkin/backend/system/FunkinRatioScaleMode.html +++ b/docs/funkin/backend/system/FunkinRatioScaleMode.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?fillScreen:Bool)

Variables

@:value(null)@:isVarheight:Null<Int> = null

@:value(null)@:isVarwidth:Null<Int> = null

Methods

resetSize():Void

\ No newline at end of file +

Constructor

new(?fillScreen:Bool)

Variables

@:value(null)@:isVarheight:Null<Int> = null

@:value(null)@:isVarwidth:Null<Int> = null

Methods

resetSize():Void

\ No newline at end of file diff --git a/docs/funkin/backend/system/GraphicCacheSprite.html b/docs/funkin/backend/system/GraphicCacheSprite.html index b901b27..2ab34b0 100644 --- a/docs/funkin/backend/system/GraphicCacheSprite.html +++ b/docs/funkin/backend/system/GraphicCacheSprite.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Dummy FlxSprite that allows you to cache FlxGraphics, and immediatly send them to GPU memory.

Constructor

new()

Variables

@:value([])cachedGraphics:Array<FlxGraphic> = []

Array containing all of the graphics cached by this sprite.

@:value([])nonRenderedCachedGraphics:Array<FlxGraphic> = []

Array containing all of the non rendered (not sent to GPU) cached graphics.

Methods

cache(path:String):Void

Caches a graphic at specified path.

Parameters:

path

Path to the graphic.

\ No newline at end of file +

Dummy FlxSprite that allows you to cache FlxGraphics, and immediatly send them to GPU memory.

Constructor

new()

Variables

@:value([])cachedGraphics:Array<FlxGraphic> = []

Array containing all of the graphics cached by this sprite.

@:value([])nonRenderedCachedGraphics:Array<FlxGraphic> = []

Array containing all of the non rendered (not sent to GPU) cached graphics.

Methods

cache(path:String):Void

Caches a graphic at specified path.

Parameters:

path

Path to the graphic.

cacheGraphic(graphic:FlxGraphic):Void

Caches a graphic.

Parameters:

graphic

The FlxGraphic

\ No newline at end of file diff --git a/docs/funkin/backend/system/KeyboardScheme.html b/docs/funkin/backend/system/KeyboardScheme.html index ba97647..e9ec567 100644 --- a/docs/funkin/backend/system/KeyboardScheme.html +++ b/docs/funkin/backend/system/KeyboardScheme.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Values

Duo(first:Bool)

\ No newline at end of file +

Values

Duo(first:Bool)

\ No newline at end of file diff --git a/docs/funkin/backend/system/Level.html b/docs/funkin/backend/system/Level.html index af7e7cf..e1017ea 100644 --- a/docs/funkin/backend/system/Level.html +++ b/docs/funkin/backend/system/Level.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast 2)@:impl@:enuminlineread onlyERROR:Level = 2

@:value(cast 0)@:impl@:enuminlineread onlyINFO:Level = 0

@:value(cast 3)@:impl@:enuminlineread onlyTRACE:Level = 3

@:value(cast 4)@:impl@:enuminlineread onlyVERBOSE:Level = 4

@:value(cast 1)@:impl@:enuminlineread onlyWARNING:Level = 1

\ No newline at end of file +

Variables

@:value(cast 2)@:impl@:enuminlineread onlyERROR:Level = 2

@:value(cast 0)@:impl@:enuminlineread onlyINFO:Level = 0

@:value(cast 3)@:impl@:enuminlineread onlyTRACE:Level = 3

@:value(cast 4)@:impl@:enuminlineread onlyVERBOSE:Level = 4

@:value(cast 1)@:impl@:enuminlineread onlyWARNING:Level = 1

\ No newline at end of file diff --git a/docs/funkin/backend/system/LogText.html b/docs/funkin/backend/system/LogText.html index 656565a..24acd40 100644 --- a/docs/funkin/backend/system/LogText.html +++ b/docs/funkin/backend/system/LogText.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

\ No newline at end of file +

Fields

\ No newline at end of file diff --git a/docs/funkin/backend/system/Logs.html b/docs/funkin/backend/system/Logs.html index f68f662..ccd0d77 100644 --- a/docs/funkin/backend/system/Logs.html +++ b/docs/funkin/backend/system/Logs.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(Log.trace)staticnativeTrace:(v:Dynamic, infos:PosInfos) ‑> Void = Log.trace

Static methods

static__showInConsole(text:Array<LogText>):Void

staticinit():Void

@:value({ color : LIGHTGRAY })staticlogText(text:String, color:ConsoleColor = LIGHTGRAY):LogText

@:value({ level : INFO })staticprepareColoredTrace(text:Array<LogText>, level:Level = INFO):Array<LogText>

@:value({ color : LIGHTGRAY, level : INFO })statictrace(text:String, level:Level = INFO, color:ConsoleColor = LIGHTGRAY):Void

@:value({ level : INFO })statictraceColored(text:Array<LogText>, level:Level = INFO):Void

\ No newline at end of file +

Static variables

@:value(Log.trace)staticnativeTrace:(v:Dynamic, infos:PosInfos) ‑> Void = Log.trace

Static methods

static__showInConsole(text:Array<LogText>):Void

staticinit():Void

@:value({ color : LIGHTGRAY })staticlogText(text:String, color:ConsoleColor = LIGHTGRAY):LogText

@:value({ level : INFO })staticprepareColoredTrace(text:Array<LogText>, level:Level = INFO):Array<LogText>

@:value({ color : LIGHTGRAY, level : INFO })statictrace(text:String, level:Level = INFO, color:ConsoleColor = LIGHTGRAY):Void

@:value({ level : INFO })statictraceColored(text:Array<LogText>, level:Level = INFO):Void

\ No newline at end of file diff --git a/docs/funkin/backend/system/Main.html b/docs/funkin/backend/system/Main.html index 4a79bc4..7c68c3d 100644 --- a/docs/funkin/backend/system/Main.html +++ b/docs/funkin/backend/system/Main.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(0)@:keepstaticchangeID:Int = 0

@:value(false)@:keepstaticforceGPUOnlyBitmapsOff:Bool = false

@:keepstaticgame:FunkinGame

@:value([])@:keepstaticgameThreads:Array<Thread> = []

@:keepstaticinstance:Main

@:value(null)@:keepstaticmodToLoad:String = null

@:value(false)@:keepstaticnoTerminalColor:Bool = false

@:value("../../../../")@:keepstaticpathBack:String = "../../../../"

@:value(false)@:keepstaticstartedFromSource:Bool = false

@:value(0)@:keepstatictime:Int = 0

Static methods

@:keepstaticexecAsync(func:() ‑> Void):Void

@:keepstaticinitTransition():Void

@:keepstaticloadGameSettings():Void

@:keepstaticrefreshAssets():Void

Constructor

@:keepnew()

\ No newline at end of file +

Static variables

@:value(0)@:keepstaticchangeID:Int = 0

@:value(false)@:keepstaticforceGPUOnlyBitmapsOff:Bool = false

@:keepstaticgame:FunkinGame

@:value([])@:keepstaticgameThreads:Array<Thread> = []

@:keepstaticinstance:Main

@:value(null)@:keepstaticmodToLoad:String = null

@:value(false)@:keepstaticnoTerminalColor:Bool = false

@:value("../../../../")@:keepstaticpathBack:String = "../../../../"

@:value("Beta")@:keepstaticfinalread onlyreleaseCycle:String = "Beta"

@:value(false)@:keepstaticstartedFromSource:Bool = false

@:value(0)@:keepstatictime:Int = 0

Static methods

@:keepstaticexecAsync(func:() ‑> Void):Void

@:keepstaticinitTransition():Void

@:keepstaticloadGameSettings():Void

@:keepstaticrefreshAssets():Void

Constructor

@:keepnew()

\ No newline at end of file diff --git a/docs/funkin/backend/system/MainState.html b/docs/funkin/backend/system/MainState.html index a87cc70..9e14c70 100644 --- a/docs/funkin/backend/system/MainState.html +++ b/docs/funkin/backend/system/MainState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Simple state used for loading the game

Static variables

@:value(false)staticbetaWarningShown:Bool = false

@:value(false)staticinitiated:Bool = false

Constructor

new(?MaxSize:Int)

Methods

\ No newline at end of file +

Simple state used for loading the game

Static variables

@:value(false)staticbetaWarningShown:Bool = false

@:value(false)staticinitiated:Bool = false

Constructor

new(?MaxSize:Int)

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/OptimizedBitmapData.html b/docs/funkin/backend/system/OptimizedBitmapData.html index 137674c..7e9e74e 100644 --- a/docs/funkin/backend/system/OptimizedBitmapData.html +++ b/docs/funkin/backend/system/OptimizedBitmapData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(width:Int, height:Int, ?transparent:Bool, ?fillColor:UInt)

\ No newline at end of file +

Constructor

new(width:Int, height:Int, ?transparent:Bool, ?fillColor:UInt)

\ No newline at end of file diff --git a/docs/funkin/backend/system/RotatingSpriteGroup.html b/docs/funkin/backend/system/RotatingSpriteGroup.html index a1916a7..f5d791e 100644 --- a/docs/funkin/backend/system/RotatingSpriteGroup.html +++ b/docs/funkin/backend/system/RotatingSpriteGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?X:Float, ?Y:Float, ?MaxSize:Int)

Methods

@:value({ Revive : true, Force : false })recycleLoop(?ObjectClass:Class<FlxSprite>, ?ObjectFactory:() ‑> FlxSprite, Force:Bool = false, Revive:Bool = true):FlxSprite

\ No newline at end of file +

Constructor

new(?X:Float, ?Y:Float, ?MaxSize:Int)

Methods

@:value({ Revive : true, Force : false })recycleLoop(?ObjectClass:Class<FlxSprite>, ?ObjectFactory:() ‑> FlxSprite, Force:Bool = false, Revive:Bool = true):FlxSprite

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/AssetTreeInfo.html b/docs/funkin/backend/system/framerate/AssetTreeInfo.html index e15d977..6f43860 100644 --- a/docs/funkin/backend/system/framerate/AssetTreeInfo.html +++ b/docs/funkin/backend/system/framerate/AssetTreeInfo.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

Inherited Variables

Defined by FramerateCategory

bgSprite:Bitmap

text:TextField

title:TextField

Inherited Methods

\ No newline at end of file +

Constructor

new()

Methods

Inherited Variables

Defined by FramerateCategory

bgSprite:Bitmap

text:TextField

title:TextField

Inherited Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/CodenameBuildField.html b/docs/funkin/backend/system/framerate/CodenameBuildField.html index cf9522a..a3d4781 100644 --- a/docs/funkin/backend/system/framerate/CodenameBuildField.html +++ b/docs/funkin/backend/system/framerate/CodenameBuildField.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

\ No newline at end of file +

Constructor

new()

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/ConductorInfo.html b/docs/funkin/backend/system/framerate/ConductorInfo.html index 1ca8479..47ba874 100644 --- a/docs/funkin/backend/system/framerate/ConductorInfo.html +++ b/docs/funkin/backend/system/framerate/ConductorInfo.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

Inherited Variables

Defined by FramerateCategory

bgSprite:Bitmap

text:TextField

title:TextField

Inherited Methods

\ No newline at end of file +

Constructor

new()

Methods

Inherited Variables

Defined by FramerateCategory

bgSprite:Bitmap

text:TextField

title:TextField

Inherited Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/FlixelInfo.html b/docs/funkin/backend/system/framerate/FlixelInfo.html index 68efcfa..79d654f 100644 --- a/docs/funkin/backend/system/framerate/FlixelInfo.html +++ b/docs/funkin/backend/system/framerate/FlixelInfo.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

Inherited Variables

Defined by FramerateCategory

bgSprite:Bitmap

text:TextField

title:TextField

Inherited Methods

\ No newline at end of file +

Constructor

new()

Methods

Inherited Variables

Defined by FramerateCategory

bgSprite:Bitmap

text:TextField

title:TextField

Inherited Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/Framerate.html b/docs/funkin/backend/system/framerate/Framerate.html index 045643f..78f3c98 100644 --- a/docs/funkin/backend/system/framerate/Framerate.html +++ b/docs/funkin/backend/system/framerate/Framerate.html @@ -9,4 +9,4 @@ }

Static variables

@:value(null)@:isVarstaticread only__bitmap:BitmapData = null

@:value(1)staticdebugMode:Int = 1

0: FPS INVISIBLE 1: FPS VISIBLE -2: FPS & DEBUG INFO VISIBLE

@:value("${Sys.getEnv(\"windir\")}\\Fonts\\consola.ttf")staticfontName:String = "${Sys.getEnv(\"windir\")}\\Fonts\\consola.ttf"

@:value(false)staticisLoaded:Bool = false

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

statictextFormat:TextFormat

Constructor

new()

Variables

bgSprite:Bitmap

@:value([])categories:Array<FramerateCategory> = []

Methods

\ No newline at end of file +2: FPS & DEBUG INFO VISIBLE

@:value("${Sys.getEnv(\"windir\")}\\Fonts\\consola.ttf")staticfontName:String = "${Sys.getEnv(\"windir\")}\\Fonts\\consola.ttf"

staticfpsCounter:FramerateCounter

staticinstance:Framerate

@:value(false)staticisLoaded:Bool = false

staticmemoryCounter:MemoryCounter

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

statictextFormat:TextFormat

Constructor

new()

Variables

bgSprite:Bitmap

@:value([])categories:Array<FramerateCategory> = []

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/FramerateCategory.html b/docs/funkin/backend/system/framerate/FramerateCategory.html index 1757959..ed0c392 100644 --- a/docs/funkin/backend/system/framerate/FramerateCategory.html +++ b/docs/funkin/backend/system/framerate/FramerateCategory.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ text : "" })new(title:String, text:String = "")

Variables

bgSprite:Bitmap

text:TextField

title:TextField

Methods

\ No newline at end of file +

Constructor

@:value({ text : "" })new(title:String, text:String = "")

Variables

bgSprite:Bitmap

text:TextField

title:TextField

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/FramerateCounter.html b/docs/funkin/backend/system/framerate/FramerateCounter.html index 001f50e..980c46d 100644 --- a/docs/funkin/backend/system/framerate/FramerateCounter.html +++ b/docs/funkin/backend/system/framerate/FramerateCounter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

fpsLabel:TextField

fpsNum:TextField

@:value(0)lastFPS:Float = 0

Methods

\ No newline at end of file +

Constructor

new()

Variables

fpsLabel:TextField

fpsNum:TextField

@:value(0)lastFPS:Float = 0

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/MemoryCounter.html b/docs/funkin/backend/system/framerate/MemoryCounter.html index 19821bc..99055ff 100644 --- a/docs/funkin/backend/system/framerate/MemoryCounter.html +++ b/docs/funkin/backend/system/framerate/MemoryCounter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

@:value(0)memory:Float = 0

@:value(0)memoryPeak:Float = 0

memoryPeakText:TextField

memoryText:TextField

Methods

\ No newline at end of file +

Constructor

new()

Variables

@:value(0)memory:Float = 0

@:value(0)memoryPeak:Float = 0

memoryPeakText:TextField

memoryText:TextField

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/SystemInfo.html b/docs/funkin/backend/system/framerate/SystemInfo.html index 8894ce2..941e136 100644 --- a/docs/funkin/backend/system/framerate/SystemInfo.html +++ b/docs/funkin/backend/system/framerate/SystemInfo.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value("Unknown")staticcpuName:String = "Unknown"

@:value("Unknown")staticgpuMaxSize:String = "Unknown"

@:value("Unknown")staticgpuName:String = "Unknown"

@:value("Unknown")staticmemType:String = "Unknown"

@:value("Unknown")staticosInfo:String = "Unknown"

@:value("Unknown")statictotalMem:String = "Unknown"

@:value("Unknown")staticvRAM:String = "Unknown"

Static methods

staticinlineinit():Void

Constructor

new()

Methods

Inherited Variables

Defined by FramerateCategory

bgSprite:Bitmap

text:TextField

title:TextField

Inherited Methods

\ No newline at end of file +

Static variables

@:value("Unknown")staticcpuName:String = "Unknown"

@:value("Unknown")staticgpuMaxSize:String = "Unknown"

@:value("Unknown")staticgpuName:String = "Unknown"

@:value("Unknown")staticmemType:String = "Unknown"

@:value("Unknown")staticosInfo:String = "Unknown"

@:value("Unknown")statictotalMem:String = "Unknown"

@:value("Unknown")staticvRAM:String = "Unknown"

Static methods

staticinlineinit():Void

Constructor

new()

Methods

Inherited Variables

Defined by FramerateCategory

bgSprite:Bitmap

text:TextField

title:TextField

Inherited Methods

\ No newline at end of file diff --git a/docs/funkin/backend/system/framerate/index.html b/docs/funkin/backend/system/framerate/index.html index 6b32e7d..43f121a 100644 --- a/docs/funkin/backend/system/framerate/index.html +++ b/docs/funkin/backend/system/framerate/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHub.html b/docs/funkin/backend/system/github/GitHub.html index b738e56..e884141 100644 --- a/docs/funkin/backend/system/github/GitHub.html +++ b/docs/funkin/backend/system/github/GitHub.html @@ -7,4 +7,6 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

static__requestBytesOnGitHubServers(url:String):Bytes

static__requestOnGitHubServers(url:String):String

@:value({ keepDrafts : false, keepPrereleases : true })staticinlinefilterReleases(releases:Array<GitHubRelease>, keepPrereleases:Bool = true, keepDrafts:Bool = false):Array<GitHubRelease>

Filters all releases gotten by getReleases

Parameters:

releases

Releases

keepPrereleases

Whenever to keep Pre-Releases.

keepDrafts

Whenever to keep Drafts.

Returns:

Filtered releases.

staticgetContributors(user:String, repository:String, ?onError:Exception ‑> Void):Array<GitHubContributor>

staticgetReleases(user:String, repository:String, ?onError:Exception ‑> Void):Array<GitHubRelease>

Gets all the releases from a specific GitHub repository using the GitHub API.

Parameters:

user
repository

Returns:

Releases

\ No newline at end of file +

Static methods

static__requestBytesOnGitHubServers(url:String):Bytes

static__requestOnGitHubServers(url:String):String

@:value({ keepDrafts : false, keepPrereleases : true })staticinlinefilterReleases(releases:Array<GitHubRelease>, keepPrereleases:Bool = true, keepDrafts:Bool = false):Array<GitHubRelease>

Filters all releases gotten by getReleases

Parameters:

releases

Releases

keepPrereleases

Whenever to keep Pre-Releases.

keepDrafts

Whenever to keep Drafts.

Returns:

Filtered releases.

staticgetContributors(user:String, repository:String, ?onError:Exception ‑> Void):Array<GitHubContributor>

Gets the contributors list from a specific GitHub repository using the GitHub API.

Parameters:

user

The user/organization that owns the repository

repository

The repository name

onError

Error Callback

Returns:

Contributors List

staticgetOrganization(org:String, ?onError:Exception ‑> Void):GitHubOrganization

Gets a specific GitHub organization using the GitHub API.

Parameters:

org

The organization to get

onError

Error Callback

Returns:

Organization

staticgetOrganizationMembers(org:String, ?onError:Exception ‑> Void):Array<GitHubContributor>

Gets the members list from a specific GitHub organization using the GitHub API. +NOTE: Members use Contributors' structure!

Parameters:

org

The organization to get the members from

onError

Error Callback

Returns:

Members List

staticgetReleases(user:String, repository:String, ?onError:Exception ‑> Void):Array<GitHubRelease>

Gets all the releases from a specific GitHub repository using the GitHub API.

Parameters:

user

The user/organization that owns the repository

repository

The repository name

onError

Error Callback

Returns:

Releases

staticgetUser(user:String, ?onError:Exception ‑> Void):GitHubUser

Gets a specific GitHub user/organization using the GitHub API. +NOTE: If organization, it will be returned with the structure of a normal user; use getOrganization if you specifically want an organization!

Parameters:

user

The user/organization to get

onError

Error Callback

Returns:

User/Organization

\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHubAsset.html b/docs/funkin/backend/system/github/GitHubAsset.html index 0916e84..409bb69 100644 --- a/docs/funkin/backend/system/github/GitHubAsset.html +++ b/docs/funkin/backend/system/github/GitHubAsset.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

url:String

updated_at:String

state:String

size:UInt

node_id:String

name:String

label:String

id:Int

created_at:String

\ No newline at end of file +

Fields

url:String

updated_at:String

state:String

size:UInt

node_id:String

name:String

label:String

id:Int

created_at:String

\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHubContributor.html b/docs/funkin/backend/system/github/GitHubContributor.html index c9b127b..ee0b97b 100644 --- a/docs/funkin/backend/system/github/GitHubContributor.html +++ b/docs/funkin/backend/system/github/GitHubContributor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

\ No newline at end of file +

Fields

\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHubException.html b/docs/funkin/backend/system/github/GitHubException.html index a666daf..f28402a 100644 --- a/docs/funkin/backend/system/github/GitHubException.html +++ b/docs/funkin/backend/system/github/GitHubException.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(apiMessage:String, documentationUrl:String)

Variables

\ No newline at end of file +

Constructor

new(apiMessage:String, documentationUrl:String)

Variables

\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHubOrganization.html b/docs/funkin/backend/system/github/GitHubOrganization.html new file mode 100644 index 0000000..282da23 --- /dev/null +++ b/docs/funkin/backend/system/github/GitHubOrganization.html @@ -0,0 +1,10 @@ + + + +funkin.backend.system.github.GitHubOrganization
\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHubReactions.html b/docs/funkin/backend/system/github/GitHubReactions.html index 432cfcc..1cc6cae 100644 --- a/docs/funkin/backend/system/github/GitHubReactions.html +++ b/docs/funkin/backend/system/github/GitHubReactions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

url:String

rocket:Int

laugh:Int

hooray:Int

heart:Int

eyes:Int

\ No newline at end of file +

Fields

url:String

rocket:Int

laugh:Int

hooray:Int

heart:Int

eyes:Int

\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHubRelease.html b/docs/funkin/backend/system/github/GitHubRelease.html index 1088fc8..41161de 100644 --- a/docs/funkin/backend/system/github/GitHubRelease.html +++ b/docs/funkin/backend/system/github/GitHubRelease.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

url:String

Url of the release (GitHub API)

upload_url:String

Template URL for asset download link.

tag_name:String

node_id:String

name:String

id:Int

ID of the release.

html_url:String

Link to the release on the GitHub website.

draft:Bool

created_at:String

body:String

Body of the GitHub request (Markdown)

author:GitHubUser

Author of the release

assets_url:String

Url for the assets JSON. Also accessible via GitHubRelease.assets

\ No newline at end of file +

Fields

url:String

Url of the release (GitHub API)

upload_url:String

Template URL for asset download link.

tag_name:String

node_id:String

name:String

id:Int

ID of the release.

html_url:String

Link to the release on the GitHub website.

draft:Bool

created_at:String

body:String

Body of the GitHub request (Markdown)

author:GitHubUser

Author of the release

assets_url:String

Url for the assets JSON. Also accessible via GitHubRelease.assets

\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHubUser.html b/docs/funkin/backend/system/github/GitHubUser.html index dd87ff8..02a0a95 100644 --- a/docs/funkin/backend/system/github/GitHubUser.html +++ b/docs/funkin/backend/system/github/GitHubUser.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

url:String

URL to the user on GitHub's servers.

updated_at:String

Date of last account update.

type:GitHubUserType

Type of the user.

twitter_username:String

Twitter username of the user. Can be null.

starred_url:String

URL on GitHub's API to access this user's starred repositories.

site_admin:Bool

Whenever the user is a GitHub administrator.

public_repos:Int

Number of public repos this user own.

public_gists:Int

Number of public gists this user own.

node_id:String

ID of the current node on the GitHub database.

name:String

Name of the user.

login:String

Username of the user.

location:String

id:Int

ID of the user.

html_url:String

URL to the user on GitHub's website.

hireable:Null<Bool>

gravatar_id:String

Unknown

gists_url:String

URL on GitHub's API to access this user's gists.

following_url:String

URL on GitHub's API to access the accounts this user is following.

following:Int

Number of accounts this user follows.

followers_url:String

URL on GitHub's API to access this user's followers.

followers:Int

Number of followers this user have

email:String

created_at:String

Date of creation of the account

company:String

The company this user belongs to. Can be null.

blog:String

bio:String

avatar_url:String

Link to the avatar (profile picture).

\ No newline at end of file +

Fields

url:String

URL to the user on GitHub's servers.

updated_at:String

Date of last account update.

type:GitHubUserType

Type of the user.

twitter_username:String

Twitter username of the user. Can be null.

starred_url:String

URL on GitHub's API to access this user's starred repositories.

site_admin:Bool

Whenever the user is a GitHub administrator.

public_repos:Int

Number of public repos this user own.

public_gists:Int

Number of public gists this user own.

node_id:String

ID of the current node on the GitHub database.

name:String

Name of the user.

login:String

Username of the user.

location:String

id:Int

ID of the user.

html_url:String

URL to the user on GitHub's website.

hireable:Null<Bool>

gravatar_id:String

Unknown

gists_url:String

URL on GitHub's API to access this user's gists.

following_url:String

URL on GitHub's API to access the accounts this user is following.

following:Int

Number of accounts this user follows.

followers_url:String

URL on GitHub's API to access this user's followers.

followers:Int

Number of followers this user have

email:String

created_at:String

Date of creation of the account

company:String

The company this user belongs to. Can be null.

blog:String

bio:String

avatar_url:String

Link to the avatar (profile picture).

\ No newline at end of file diff --git a/docs/funkin/backend/system/github/GitHubUserType.html b/docs/funkin/backend/system/github/GitHubUserType.html index aea59cd..049bfde 100644 --- a/docs/funkin/backend/system/github/GitHubUserType.html +++ b/docs/funkin/backend/system/github/GitHubUserType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast "Organization")@:impl@:enuminlineread onlyORGANIZATION:GitHubUserType = "Organization"

@:value(cast "User")@:impl@:enuminlineread onlyUSER:GitHubUserType = "User"

\ No newline at end of file +

Variables

@:value(cast "Organization")@:impl@:enuminlineread onlyORGANIZATION:GitHubUserType = "Organization"

@:value(cast "User")@:impl@:enuminlineread onlyUSER:GitHubUserType = "User"

\ No newline at end of file diff --git a/docs/funkin/backend/system/github/index.html b/docs/funkin/backend/system/github/index.html index 5e80556..1421d8a 100644 --- a/docs/funkin/backend/system/github/index.html +++ b/docs/funkin/backend/system/github/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/backend/system/index.html b/docs/funkin/backend/system/index.html index ae0b65b..0c35a16 100644 --- a/docs/funkin/backend/system/index.html +++ b/docs/funkin/backend/system/index.html @@ -11,4 +11,4 @@ @author

CommandLineHandler

Conductor

Control

Since, in many cases multiple actions should use similar keys, we don't want the rebinding UI to list every action. ActionBinders are what the user perceives as an input so, for instance, they can't set jump-press and jump-release to different keys.

Controls

A list of actions that a player would invoke via some input device. -Uses FlxActions to funnel various inputs to a single action.

Device

ErrorCode

FunkinGame

FunkinRatioScaleMode

GraphicCacheSprite

Dummy FlxSprite that allows you to cache FlxGraphics, and immediatly send them to GPU memory.

KeyboardScheme

Level

LogText

Logs

Main

MainState

Simple state used for loading the game

OptimizedBitmapData

RotatingSpriteGroup

\ No newline at end of file +Uses FlxActions to funnel various inputs to a single action.

Device

ErrorCode

FunkinGame

FunkinRatioScaleMode

GraphicCacheSprite

Dummy FlxSprite that allows you to cache FlxGraphics, and immediatly send them to GPU memory.

KeyboardScheme

Level

LogText

Logs

Main

MainState

Simple state used for loading the game

OptimizedBitmapData

RotatingSpriteGroup

\ No newline at end of file diff --git a/docs/funkin/backend/system/interfaces/IBeatReceiver.html b/docs/funkin/backend/system/interfaces/IBeatReceiver.html index a9620c6..4417a1f 100644 --- a/docs/funkin/backend/system/interfaces/IBeatReceiver.html +++ b/docs/funkin/backend/system/interfaces/IBeatReceiver.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Methods

beatHit(curBeat:Int):Void

measureHit(curMeasure:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file +

Methods

beatHit(curBeat:Int):Void

measureHit(curMeasure:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file diff --git a/docs/funkin/backend/system/interfaces/IOffsetCompatible.html b/docs/funkin/backend/system/interfaces/IOffsetCompatible.html index 517baf7..6b75011 100644 --- a/docs/funkin/backend/system/interfaces/IOffsetCompatible.html +++ b/docs/funkin/backend/system/interfaces/IOffsetCompatible.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Methods

@:value({ y : 0, x : 0 })addOffset(anim:String, x:Float = 0, y:Float = 0):Void

\ No newline at end of file +

Methods

@:value({ y : 0, x : 0 })addOffset(anim:String, x:Float = 0, y:Float = 0):Void

\ No newline at end of file diff --git a/docs/funkin/backend/system/interfaces/index.html b/docs/funkin/backend/system/interfaces/index.html index 780d672..94ae020 100644 --- a/docs/funkin/backend/system/interfaces/index.html +++ b/docs/funkin/backend/system/interfaces/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.backend.system.interfaces

..
IBeatReceiver

IOffsetCompatible

\ No newline at end of file +

funkin.backend.system.interfaces

..
IBeatReceiver

IOffsetCompatible

\ No newline at end of file diff --git a/docs/funkin/backend/system/macros/DefinesMacro.html b/docs/funkin/backend/system/macros/DefinesMacro.html index 1f0bb8e..63989df 100644 --- a/docs/funkin/backend/system/macros/DefinesMacro.html +++ b/docs/funkin/backend/system/macros/DefinesMacro.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

staticread onlydefines:Map<String, Dynamic>

Returns the defined values

\ No newline at end of file +

Static variables

staticread onlydefines:Map<String, Dynamic>

Returns the defined values

\ No newline at end of file diff --git a/docs/funkin/backend/system/macros/GitCommitMacro.html b/docs/funkin/backend/system/macros/GitCommitMacro.html index 0e5058a..9692494 100644 --- a/docs/funkin/backend/system/macros/GitCommitMacro.html +++ b/docs/funkin/backend/system/macros/GitCommitMacro.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

staticread onlycommitHash:String

Returns the current commit hash

staticread onlycommitNumber:Int

Returns the current commit number

\ No newline at end of file +

Static variables

staticread onlycommitHash:String

Returns the current commit hash

staticread onlycommitNumber:Int

Returns the current commit number

\ No newline at end of file diff --git a/docs/funkin/backend/system/macros/HashLinkFixer.html b/docs/funkin/backend/system/macros/HashLinkFixer.html index 1bcc5ea..187d2bd 100644 --- a/docs/funkin/backend/system/macros/HashLinkFixer.html +++ b/docs/funkin/backend/system/macros/HashLinkFixer.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

\ No newline at end of file +

\ No newline at end of file diff --git a/docs/funkin/backend/system/macros/Utils.html b/docs/funkin/backend/system/macros/Utils.html index 2d8a7ec..cc6401c 100644 --- a/docs/funkin/backend/system/macros/Utils.html +++ b/docs/funkin/backend/system/macros/Utils.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

\ No newline at end of file +

\ No newline at end of file diff --git a/docs/funkin/backend/system/macros/index.html b/docs/funkin/backend/system/macros/index.html index ba6558c..0136d89 100644 --- a/docs/funkin/backend/system/macros/index.html +++ b/docs/funkin/backend/system/macros/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/backend/system/modules/CrashHandler.html b/docs/funkin/backend/system/modules/CrashHandler.html index 8ebcf2a..4e02110 100644 --- a/docs/funkin/backend/system/modules/CrashHandler.html +++ b/docs/funkin/backend/system/modules/CrashHandler.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

@:has_untypedstaticinit():Void

staticonUncaughtError(e:UncaughtErrorEvent):Void

\ No newline at end of file +

Static methods

@:has_untypedstaticinit():Void

staticonUncaughtError(e:UncaughtErrorEvent):Void

\ No newline at end of file diff --git a/docs/funkin/backend/system/modules/FunkinCache.html b/docs/funkin/backend/system/modules/FunkinCache.html index e9e3b0b..aa91cf7 100644 --- a/docs/funkin/backend/system/modules/FunkinCache.html +++ b/docs/funkin/backend/system/modules/FunkinCache.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

Static methods

staticinit():Void

Constructor

new()

Methods

getBitmapData(id:String):BitmapData

Retrieves a cached BitmapData.

Parameters:

id

The ID of the cached BitmapData

Returns:

The cached BitmapData instance

getFont(id:String):Font

Retrieves a cached Font.

Parameters:

id

The ID of the cached Font

Returns:

The cached Font instance

getSound(id:String):Sound

Retrieves a cached Sound.

Parameters:

id

The ID of the cached Sound

Returns:

The cached Sound instance

hasBitmapData(id:String):Bool

Checks whether a BitmapData asset is cached.

Parameters:

id

The ID of a BitmapData asset

Returns:

Whether the object has been cached

hasFont(id:String):Bool

Checks whether a Font asset is cached.

Parameters:

id

The ID of a Font asset

Returns:

Whether the object has been cached

hasSound(id:String):Bool

Checks whether a Sound asset is cached.

Parameters:

id

The ID of a Sound asset

Returns:

Whether the object has been cached

removeBitmapData(id:String):Bool

Removes a BitmapData from the cache.

Parameters:

id

The ID of a BitmapData asset

Returns:

true if the asset was removed, false if it was not in the cache

removeFont(id:String):Bool

Removes a Font from the cache.

Parameters:

id

The ID of a Font asset

Returns:

true if the asset was removed, false if it was not in the cache

removeSound(id:String):Bool

Removes a Sound from the cache.

Parameters:

id

The ID of a Sound asset

Returns:

true if the asset was removed, false if it was not in the cache

\ No newline at end of file +

Static variables

Static methods

staticinit():Void

Constructor

new()

Methods

getBitmapData(id:String):BitmapData

Retrieves a cached BitmapData.

Parameters:

id

The ID of the cached BitmapData

Returns:

The cached BitmapData instance

getFont(id:String):Font

Retrieves a cached Font.

Parameters:

id

The ID of the cached Font

Returns:

The cached Font instance

getSound(id:String):Sound

Retrieves a cached Sound.

Parameters:

id

The ID of the cached Sound

Returns:

The cached Sound instance

hasBitmapData(id:String):Bool

Checks whether a BitmapData asset is cached.

Parameters:

id

The ID of a BitmapData asset

Returns:

Whether the object has been cached

hasFont(id:String):Bool

Checks whether a Font asset is cached.

Parameters:

id

The ID of a Font asset

Returns:

Whether the object has been cached

hasSound(id:String):Bool

Checks whether a Sound asset is cached.

Parameters:

id

The ID of a Sound asset

Returns:

Whether the object has been cached

removeBitmapData(id:String):Bool

Removes a BitmapData from the cache.

Parameters:

id

The ID of a BitmapData asset

Returns:

true if the asset was removed, false if it was not in the cache

removeFont(id:String):Bool

Removes a Font from the cache.

Parameters:

id

The ID of a Font asset

Returns:

true if the asset was removed, false if it was not in the cache

removeSound(id:String):Bool

Removes a Sound from the cache.

Parameters:

id

The ID of a Sound asset

Returns:

true if the asset was removed, false if it was not in the cache

\ No newline at end of file diff --git a/docs/funkin/backend/system/modules/PlayingSound.html b/docs/funkin/backend/system/modules/PlayingSound.html index 838d469..4925bee 100644 --- a/docs/funkin/backend/system/modules/PlayingSound.html +++ b/docs/funkin/backend/system/modules/PlayingSound.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

time:Float

sound:FlxSound

\ No newline at end of file +

Fields

time:Float

sound:FlxSound

\ No newline at end of file diff --git a/docs/funkin/backend/system/modules/index.html b/docs/funkin/backend/system/modules/index.html index 66e0d68..ea988a5 100644 --- a/docs/funkin/backend/system/modules/index.html +++ b/docs/funkin/backend/system/modules/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.backend.system.modules

..
CrashHandler

FunkinCache

PlayingSound

\ No newline at end of file +

funkin.backend.system.modules

..
CrashHandler

FunkinCache

PlayingSound

\ No newline at end of file diff --git a/docs/funkin/backend/system/net/Socket.html b/docs/funkin/backend/system/net/Socket.html index c6b6177..d4b18cb 100644 --- a/docs/funkin/backend/system/net/Socket.html +++ b/docs/funkin/backend/system/net/Socket.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?socket:SysSocket)

Variables

socket:SysSocket

Methods

connect(host:Host, port:Int):Void

destroy():Void

@:value({ nbConnections : 1 })host(host:Host, port:Int, nbConnections:Int = 1):Void

hostAndWait(h:Host, port:Int):Socket

read():String

write(str:String):Bool

\ No newline at end of file +

Constructor

new(?socket:SysSocket)

Variables

socket:SysSocket

Methods

connect(host:Host, port:Int):Void

destroy():Void

@:value({ nbConnections : 1 })host(host:Host, port:Int, nbConnections:Int = 1):Void

hostAndWait(h:Host, port:Int):Socket

read():String

write(str:String):Bool

\ No newline at end of file diff --git a/docs/funkin/backend/system/net/index.html b/docs/funkin/backend/system/net/index.html index a9fa48b..ff9a454 100644 --- a/docs/funkin/backend/system/net/index.html +++ b/docs/funkin/backend/system/net/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.backend.system.net

..
Socket

\ No newline at end of file +

funkin.backend.system.net

..
Socket

\ No newline at end of file diff --git a/docs/funkin/backend/utils/AnimData.html b/docs/funkin/backend/utils/AnimData.html index 121c27d..3cf7a50 100644 --- a/docs/funkin/backend/utils/AnimData.html +++ b/docs/funkin/backend/utils/AnimData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

y:Float

x:Float

name:String

loop:Bool

indices:Array<Int>

fps:Float

anim:String

\ No newline at end of file +

Fields

y:Float

x:Float

name:String

loop:Bool

indices:Array<Int>

fps:Float

@:optionaloptionalforced:Null<Bool>

anim:String

\ No newline at end of file diff --git a/docs/funkin/backend/utils/AudioAnalyzer.html b/docs/funkin/backend/utils/AudioAnalyzer.html new file mode 100644 index 0000000..0339916 --- /dev/null +++ b/docs/funkin/backend/utils/AudioAnalyzer.html @@ -0,0 +1,10 @@ + + + +funkin.backend.utils.AudioAnalyzer

Constructor

new(sound:FlxSound)

Variables

buffer:AudioBuffer

Methods

analyze(startPos:Float, endPos:Float):Float

\ No newline at end of file diff --git a/docs/funkin/backend/utils/BeatAnim.html b/docs/funkin/backend/utils/BeatAnim.html new file mode 100644 index 0000000..598fe7a --- /dev/null +++ b/docs/funkin/backend/utils/BeatAnim.html @@ -0,0 +1,10 @@ + + + +funkin.backend.utils.BeatAnim

Fields

name:String

forced:Bool

\ No newline at end of file diff --git a/docs/funkin/backend/utils/BitmapUtil.html b/docs/funkin/backend/utils/BitmapUtil.html index 3aa7687..2aa0072 100644 --- a/docs/funkin/backend/utils/BitmapUtil.html +++ b/docs/funkin/backend/utils/BitmapUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticgetMostPresentColor(bmap:BitmapData):FlxColor

Returns the most present color in a Bitmap.

Parameters:

bmap

Bitmap

Returns:

FlxColor Color that is the most present.

staticgetMostPresentSaturatedColor(bmap:BitmapData):FlxColor

Returns the most present saturated color in a Bitmap.

Parameters:

bmap

Bitmap

Returns:

FlxColor Color that is the most present.

\ No newline at end of file +

Static methods

staticgetMostPresentColor(bmap:BitmapData):FlxColor

Returns the most present color in a Bitmap.

Parameters:

bmap

Bitmap

Returns:

FlxColor Color that is the most present.

staticgetMostPresentSaturatedColor(bmap:BitmapData):FlxColor

Returns the most present saturated color in a Bitmap.

Parameters:

bmap

Bitmap

Returns:

FlxColor Color that is the most present.

\ No newline at end of file diff --git a/docs/funkin/backend/utils/ConsoleColor.html b/docs/funkin/backend/utils/ConsoleColor.html index ed45c1d..9ee17c9 100644 --- a/docs/funkin/backend/utils/ConsoleColor.html +++ b/docs/funkin/backend/utils/ConsoleColor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast 0)@:impl@:enuminlineread onlyBLACK:ConsoleColor = 0

@:value(cast 9)@:impl@:enuminlineread onlyBLUE:ConsoleColor = 9

@:value(cast 11)@:impl@:enuminlineread onlyCYAN:ConsoleColor = 11

@:value(cast 1)@:impl@:enuminlineread onlyDARKBLUE:ConsoleColor = 1

@:value(cast 3)@:impl@:enuminlineread onlyDARKCYAN:ConsoleColor = 3

@:value(cast 2)@:impl@:enuminlineread onlyDARKGREEN:ConsoleColor = 2

@:value(cast 5)@:impl@:enuminlineread onlyDARKMAGENTA:ConsoleColor = 5

@:value(cast 4)@:impl@:enuminlineread onlyDARKRED:ConsoleColor = 4

@:value(cast 6)@:impl@:enuminlineread onlyDARKYELLOW:ConsoleColor = 6

@:value(cast 8)@:impl@:enuminlineread onlyGRAY:ConsoleColor = 8

@:value(cast 10)@:impl@:enuminlineread onlyGREEN:ConsoleColor = 10

@:value(cast 7)@:impl@:enuminlineread onlyLIGHTGRAY:ConsoleColor = 7

@:value(cast 13)@:impl@:enuminlineread onlyMAGENTA:ConsoleColor = 13

@:value(cast -1)@:impl@:enuminlineread onlyNONE:ConsoleColor = -1

@:value(cast 12)@:impl@:enuminlineread onlyRED:ConsoleColor = 12

@:value(cast 15)@:impl@:enuminlineread onlyWHITE:ConsoleColor = 15

@:value(cast 14)@:impl@:enuminlineread onlyYELLOW:ConsoleColor = 14

\ No newline at end of file +

Variables

@:value(cast 0)@:impl@:enuminlineread onlyBLACK:ConsoleColor = 0

@:value(cast 9)@:impl@:enuminlineread onlyBLUE:ConsoleColor = 9

@:value(cast 11)@:impl@:enuminlineread onlyCYAN:ConsoleColor = 11

@:value(cast 1)@:impl@:enuminlineread onlyDARKBLUE:ConsoleColor = 1

@:value(cast 3)@:impl@:enuminlineread onlyDARKCYAN:ConsoleColor = 3

@:value(cast 2)@:impl@:enuminlineread onlyDARKGREEN:ConsoleColor = 2

@:value(cast 5)@:impl@:enuminlineread onlyDARKMAGENTA:ConsoleColor = 5

@:value(cast 4)@:impl@:enuminlineread onlyDARKRED:ConsoleColor = 4

@:value(cast 6)@:impl@:enuminlineread onlyDARKYELLOW:ConsoleColor = 6

@:value(cast 8)@:impl@:enuminlineread onlyGRAY:ConsoleColor = 8

@:value(cast 10)@:impl@:enuminlineread onlyGREEN:ConsoleColor = 10

@:value(cast 7)@:impl@:enuminlineread onlyLIGHTGRAY:ConsoleColor = 7

@:value(cast 13)@:impl@:enuminlineread onlyMAGENTA:ConsoleColor = 13

@:value(cast -1)@:impl@:enuminlineread onlyNONE:ConsoleColor = -1

@:value(cast 12)@:impl@:enuminlineread onlyRED:ConsoleColor = 12

@:value(cast 15)@:impl@:enuminlineread onlyWHITE:ConsoleColor = 15

@:value(cast 14)@:impl@:enuminlineread onlyYELLOW:ConsoleColor = 14

\ No newline at end of file diff --git a/docs/funkin/backend/utils/CoolSfx.html b/docs/funkin/backend/utils/CoolSfx.html index 13aabad..3baf2f3 100644 --- a/docs/funkin/backend/utils/CoolSfx.html +++ b/docs/funkin/backend/utils/CoolSfx.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

SFXs to play using playMenuSFX.

Variables

@:value(cast 2)@:impl@:enuminlineread onlyCANCEL:CoolSfx = 2

@:value(cast 3)@:impl@:enuminlineread onlyCHECKED:CoolSfx = 3

@:value(cast 1)@:impl@:enuminlineread onlyCONFIRM:CoolSfx = 1

@:value(cast 0)@:impl@:enuminlineread onlySCROLL:CoolSfx = 0

@:value(cast 4)@:impl@:enuminlineread onlyUNCHECKED:CoolSfx = 4

@:value(cast 5)@:impl@:enuminlineread onlyWARNING:CoolSfx = 5

\ No newline at end of file +

SFXs to play using playMenuSFX.

Variables

@:value(cast 2)@:impl@:enuminlineread onlyCANCEL:CoolSfx = 2

@:value(cast 3)@:impl@:enuminlineread onlyCHECKED:CoolSfx = 3

@:value(cast 1)@:impl@:enuminlineread onlyCONFIRM:CoolSfx = 1

@:value(cast 0)@:impl@:enuminlineread onlySCROLL:CoolSfx = 0

@:value(cast 4)@:impl@:enuminlineread onlyUNCHECKED:CoolSfx = 4

@:value(cast 5)@:impl@:enuminlineread onlyWARNING:CoolSfx = 5

\ No newline at end of file diff --git a/docs/funkin/backend/utils/CoolUtil.html b/docs/funkin/backend/utils/CoolUtil.html index df9e9e8..ce4e228 100644 --- a/docs/funkin/backend/utils/CoolUtil.html +++ b/docs/funkin/backend/utils/CoolUtil.html @@ -7,11 +7,12 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticinlineaddEndZeros(str:String, num:Int):String

Add several zeros at the end of a string, so that 2 becomes 20, useful for ms.

Parameters:

str

String to add zeros

num

The length required

staticinlineaddZeros(str:String, num:Int):String

Add several zeros at the beginning of a string, so that 2 becomes 02.

Parameters:

str

String to add zeros

num

The length required

@:value({ axes : XY })staticinlinecameraCenter(obj:FlxObject, cam:FlxCamera, axes:FlxAxes = XY):Void

Centers an object in a camera's field, basically screenCenter() but camera.width and camera.height are used instead of FlxG.width and FlxG.height.

Parameters:

obj

Sprite to center

cam

Camera

axes

Axes (XY)

staticinlineclear<T>(array:Array<T>):Array<T>

Clears the content of an array

staticcoolTextFile(path:String):Array<String>

Allows you to split a text file from a path, into a "cool text file", AKA a list. Allows for comments. For example, +

Static methods

staticinlineaddEndZeros(str:String, num:Int):String

Add several zeros at the end of a string, so that 2 becomes 20, useful for ms.

Parameters:

str

String to add zeros

num

The length required

staticinlineaddZeros(str:String, num:Int):String

Add several zeros at the beginning of a string, so that 2 becomes 02.

Parameters:

str

String to add zeros

num

The length required

staticautoSetFormat(text:FlxText, formats:Array<TextFormat>):FlxText

Sets automatically all the compatible formats to a text.

+

WARNING: These are dependant from the font, so if the font doesn't support for example the bold format it won't work!

Parameters:

text

Text to set the format for

formats

Array of the formats (to get the formats from a node, you can use XMLUtil.getTextFormats(node))

@:value({ axes : XY })staticinlinecameraCenter(obj:FlxObject, cam:FlxCamera, axes:FlxAxes = XY):Void

Centers an object in a camera's field, basically screenCenter() but camera.width and camera.height are used instead of FlxG.width and FlxG.height.

Parameters:

obj

Sprite to center

cam

Camera

axes

Axes (XY)

staticinlineclear<T>(array:Array<T>):Array<T>

Clears the content of an array

@:noUsingstaticcoolTextFile(path:String):Array<String>

Allows you to split a text file from a path, into a "cool text file", AKA a list. Allows for comments. For example, # comment test1 test2 -will return ["test1", "test2"]

Parameters:

path

Returns:

Array

staticinlinecopyColorTransform(color1:ColorTransform, color2:ColorTransform):Void

Copies a color transform from color1 to color2

Parameters:

color1

Color transform to copy to

color2

Color transform to copy from

staticdeleteFolder(delete:String):Void

Deletes a folder recursively

Parameters:

delete

Path to the folder.

staticinlinefloorInt(e:Float):Int

Equivalent of Math.floor, except doesn't require a Int -> Float -> Int conversion.

Parameters:

e

Value to get the floor of.

staticinlinefpsLerp(v1:Float, v2:Float, ratio:Float):Float

Alternative linear interpolation function for each frame use, without worrying about framerate changes.

Parameters:

v1

Begin value

v2

End value

ratio

Ratio

Returns:

Float Final value

staticinlinegetAtt(xml:Access, name:String):String

Gets an XML attribute from an Access abstract, without throwing an exception if invalid. -Example: xml.getAtt("test").getDefault("Hello, World!");

Parameters:

xml

XML to get the attribute from

name

Name of the attribute

staticgetColorFromDynamic(c:Dynamic):Null<FlxColor>

Tries to get a color from a Dynamic variable.

Parameters:

c

Dynamic color.

Returns:

The result color, or null if invalid.

staticinlinegetDefault<T>(v:Null<T>, defaultValue:T):T

staticinlinegetFPSRatio(ratio:Float):Float

Modifies a lerp ratio based on current FPS to keep a stable speed on higher framerate.

Parameters:

ratio

Ratio

Returns:

FPS-Modified Ratio

staticgetLastExceptionStack():String

staticinlinegetMacroAbstractClass(className:String):Class<Dynamic>

Gets the macro class created by hscript-improved for an abstract / enum

staticgetSizeString(size:Float):String

Returns a string representation of a size, following this format: 1.02 GB, 134.00 MB

Parameters:

size

Size to convert ot string

Returns:

String Result string representation

staticinlineindexOfFromLast<T>(array:Array<T>, element:T):Int

Basically indexOf, but starts from the end.

Parameters:

array

Array to scan

element

Element

Returns:

Index, or -1 if unsuccessful.

staticinlineisNaN(v:Dynamic):Bool

Whenever a value is NaN or not.

Parameters:

v

Value

staticinlinekeyToString(key:Null<FlxKey>):String

Returns a simple string representation of a FlxKey. Used in Controls options.

Parameters:

key

Key

Returns:

Simple representation

staticinlinelast<T>(array:Array<T>):T

Returns the last of an Array

Parameters:

array

Array

Returns:

T Last element

@:value({ fpsSensitive : false })staticinlinelerpColor(color1:FlxColor, color2:FlxColor, ratio:Float, fpsSensitive:Bool = false):FlxColor

Lerps from color1 into color2 (Shortcut to FlxColor.interpolate)

Parameters:

color1

Color 1

color2

Color 2

ratio

Ratio

fpsSensitive

Whenever the ratio should be fps sensitive (adapted when game is running at 120 instead of 60)

staticloadAnimatedGraphic(spr:FlxSprite, path:String):FlxSprite

Loads an animated graphic, and automatically animates it.

Parameters:

spr

Sprite to load the graphic for

path

Path to the graphic

staticinlinemaxInt(p1:Int, p2:Int):Int

Equivalent of Math.max, except doesn't require a Int -> Float -> Int conversion.

Parameters:

p1
p2

Returns:

return p1 < p2 ? p2 : p1

@:value({ min : 0 })staticinlinenumberArray(max:Int, min:Int = 0):Array<Int>

Returns an array of number from min to max. Equivalent of [for (i in min...max) i].

Parameters:

max

Max value

min

Minimal value (0)

Returns:

Array Final array

staticinlineopenURL(url:String):Void

Opens an URL in the browser.

Parameters:

null

url

staticparseJson(assetPath:String):Unknown

Shortcut to parse JSON from an Asset path

Parameters:

assetPath

Path to the JSON asset.

staticinlineparseJsonString(str:String):Unknown

Shortcut to parse a JSON string

Parameters:

str

Path to the JSON string

Returns:

Parsed JSON

@:value({ volume : 1, menuSFX : SCROLL })staticinlineplayMenuSFX(menuSFX:CoolSfx = SCROLL, volume:Float = 1):Void

Plays a specified Menu SFX.

Parameters:

menuSFX

Menu SFX to play

volume

At which volume it should play

@:value({ fadeIn : false })staticplayMenuSong(fadeIn:Bool = false):Void

Plays the main menu theme.

Parameters:

null

fadeIn

@:value({ DefaultBPM : 102, Looped : true, Volume : 1, Persist : false })staticplayMusic(path:String, Persist:Bool = false, Volume:Int = 1, Looped:Bool = true, DefaultBPM:Int = 102, ?Group:FlxSoundGroup):Void

Plays music, while resetting the Conductor, and taking info from INI in count.

Parameters:

path

Path to the music

Persist

Whenever the music should persist while switching states

DefaultBPM

Default BPM of the music (102)

Volume

Volume of the music (1)

Looped

Whenever the music loops (true)

Group

A group that this music belongs to (default)

staticpreloadCharacter(name:String, ?spriteName:String):Void

Preloads a character.

Parameters:

name

Character name

spriteName

(Optional) sprite name.

staticinlinepushGroup<T>(array:Array<T>, args:Rest<T>):Array<T>

Push an entire group into an array.

Parameters:

array

Array to push the group into

...args

Group entries

Returns:

Array

staticinlinereplay(sound:FlxSound):Void

Stops a sound, set its time to 0 then play it again.

Parameters:

sound

Sound to replay.

staticresetSprite(spr:FlxSprite, x:Float, y:Float):Void

Resets an FlxSprite

Parameters:

spr

Sprite to reset

x

New X position

y

New Y position

staticsetFieldDefault<T>(v:Dynamic, name:String, defaultValue:T):T

Sets a field's default value, and returns it. In case it already exists, returns the existing one.

Parameters:

v

Dynamic to set the default value to

name

Name of the value

defaultValue

Default value

Returns:

T New/old value.

staticinlinesetMusic(frontEnd:SoundFrontEnd, music:FlxSound):Void

Sets a SoundFrontEnd's music to a FlxSound. -Example: FlxG.sound.setMusic(music);

Parameters:

frontEnd

SoundFrontEnd to set the music of

music

Music

staticinlinesetSpriteSize(sprite:FlxSprite, width:Float, height:Float):Void

Equivalent of setGraphicSize, except that it can accept floats and automatically updates the hitbox.

Parameters:

sprite

Sprite to set the size of

width

Width

height

Height

@:value({ maxScale : 0, fill : true })staticinlinesetUnstretchedGraphicSize(sprite:FlxSprite, width:Int, height:Int, fill:Bool = true, maxScale:Float = 0):Void

Allows you to set a graphic size (ex: 150x150), with proper hitbox without a stretched sprite.

Parameters:

sprite

Sprite to apply the new graphic size to

width

Width

height

Height

fill

Whenever the sprite should fill instead of shrinking (true)

maxScale

Maximum scale (0 / none)

staticswitchAnimFrames(anim1:FlxAnimation, anim2:FlxAnimation):Void

Switches frames from 2 FlxAnimations.

Parameters:

anim1

First animation

anim2

Second animation

staticinlinetimeToStr(time:Float):String

Converts a timestamp to a readable format such as 01:22 (mm:ss)

\ No newline at end of file +will return ["test1", "test2"]

Parameters:

path

Returns:

Array

staticinlinecopyColorTransform(color1:ColorTransform, color2:ColorTransform):Void

Copies a color transform from color1 to color2

Parameters:

color1

Color transform to copy to

color2

Color transform to copy from

@:noUsingstaticdeleteFolder(delete:String):Void

Deletes a folder recursively

Parameters:

delete

Path to the folder.

staticinlinefloorInt(e:Float):Int

Equivalent of Math.floor, except doesn't require a Int -> Float -> Int conversion.

Parameters:

e

Value to get the floor of.

@:noUsingstaticinlineflxeaseFromString(mainEase:String, suffix:String):Null<EaseFunction>

@:noUsingstaticinlinefpsLerp(v1:Float, v2:Float, ratio:Float):Float

Alternative linear interpolation function for each frame use, without worrying about framerate changes.

Parameters:

v1

Begin value

v2

End value

ratio

Ratio

Returns:

Float Final value

staticinlinegetAtt(xml:Access, name:String):String

Gets an XML attribute from an Access abstract, without throwing an exception if invalid. +Example: xml.getAtt("test").getDefault("Hello, World!");

Parameters:

xml

XML to get the attribute from

name

Name of the attribute

staticgetColorFromDynamic(c:Dynamic):Null<FlxColor>

Tries to get a color from a Dynamic variable.

Parameters:

c

Dynamic color.

Returns:

The result color, or null if invalid.

staticinlinegetDefault<T>(v:Null<T>, defaultValue:T):T

@:noUsingstaticinlinegetFPSRatio(ratio:Float):Float

Modifies a lerp ratio based on current FPS to keep a stable speed on higher framerate.

Parameters:

ratio

Ratio

Returns:

FPS-Modified Ratio

staticgetLastExceptionStack():String

@:noUsingstaticinlinegetMacroAbstractClass(className:String):Class<Dynamic>

Gets the macro class created by hscript-improved for an abstract / enum

staticgetSizeString(size:Float):String

Returns a string representation of a size, following this format: 1.02 GB, 134.00 MB

Parameters:

size

Size to convert to string

Returns:

String Result string representation

staticinlineindexOfFromLast<T>(array:Array<T>, element:T):Int

Basically indexOf, but starts from the end.

Parameters:

array

Array to scan

element

Element

Returns:

Index, or -1 if unsuccessful.

staticinlineisNaN(v:Dynamic):Bool

Whenever a value is NaN or not.

Parameters:

v

Value

staticinlineisNotNull(v:Null<Dynamic>):Bool

staticinlinekeyToString(key:Null<FlxKey>):String

Returns a simple string representation of a FlxKey. Used in Controls options.

Parameters:

key

Key

Returns:

Simple representation

staticinlinelast<T>(array:Array<T>):T

Returns the last of an Array

Parameters:

array

Array

Returns:

T Last element

@:value({ fpsSensitive : false })@:noUsingstaticinlinelerpColor(color1:FlxColor, color2:FlxColor, ratio:Float, fpsSensitive:Bool = false):FlxColor

Lerps from color1 into color2 (Shortcut to FlxColor.interpolate)

Parameters:

color1

Color 1

color2

Color 2

ratio

Ratio

fpsSensitive

Whenever the ratio should be fps sensitive (adapted when game is running at 120 instead of 60)

staticloadAnimatedGraphic(spr:FlxSprite, path:String):FlxSprite

Loads an animated graphic, and automatically animates it.

Parameters:

spr

Sprite to load the graphic for

path

Path to the graphic

@:noUsingstaticinlinemaxInt(p1:Int, p2:Int):Int

Equivalent of Math.max, except doesn't require a Int -> Float -> Int conversion.

Parameters:

p1
p2

Returns:

return p1 < p2 ? p2 : p1

@:value({ min : 0 })@:noUsingstaticinlinenumberArray(max:Int, min:Int = 0):Array<Int>

Returns an array of number from min to max. Equivalent of [for (i in min...max) i].

Parameters:

max

Max value

min

Minimal value (0)

Returns:

Array Final array

@:noUsingstaticinlineopenURL(url:String):Void

Opens an URL in the browser.

Parameters:

null

url

staticparseJson(assetPath:String):Unknown

Shortcut to parse JSON from an Asset path

Parameters:

assetPath

Path to the JSON asset.

staticinlineparseJsonString(str:String):Unknown

Shortcut to parse a JSON string

Parameters:

str

Path to the JSON string

Returns:

Parsed JSON

@:value({ volume : 1, menuSFX : SCROLL })@:noUsingstaticinlineplayMenuSFX(menuSFX:CoolSfx = SCROLL, volume:Float = 1):Void

Plays a specified Menu SFX.

Parameters:

menuSFX

Menu SFX to play

volume

At which volume it should play

@:value({ fadeIn : false })@:noUsingstaticplayMenuSong(fadeIn:Bool = false):Void

Plays the main menu theme.

Parameters:

null

fadeIn

@:value({ DefaultBPM : 102, Looped : true, Volume : 1, Persist : false })@:noUsingstaticplayMusic(path:String, Persist:Bool = false, Volume:Int = 1, Looped:Bool = true, DefaultBPM:Int = 102, ?Group:FlxSoundGroup):Void

Plays music, while resetting the Conductor, and taking info from INI in count.

Parameters:

path

Path to the music

Persist

Whenever the music should persist while switching states

DefaultBPM

Default BPM of the music (102)

Volume

Volume of the music (1)

Looped

Whenever the music loops (true)

Group

A group that this music belongs to (default)

@:noUsingstaticpreloadCharacter(name:String, ?spriteName:String):Void

Preloads a character.

Parameters:

name

Character name

spriteName

(Optional) sprite name.

staticinlinepushGroup<T>(array:Array<T>, args:Rest<T>):Array<T>

Push an entire group into an array.

Parameters:

array

Array to push the group into

...args

Group entries

Returns:

Array

@:noUsingstaticinlinequantize(Value:Float, Quant:Float):Float

staticinlineremoveIP(msg:String):String

Replaces in a string any kind of IP with [Your IP] making the string safer to trace.

Parameters:

msg

String to check and edit

Returns:

String Result without any kind of IP

staticinlinereplay(sound:FlxSound):Void

Stops a sound, set its time to 0 then play it again.

Parameters:

sound

Sound to replay.

staticresetSprite(spr:FlxSprite, x:Float, y:Float):Void

Resets an FlxSprite

Parameters:

spr

Sprite to reset

x

New X position

y

New Y position

staticsetFieldDefault<T>(v:Dynamic, name:String, defaultValue:T):T

Sets a field's default value, and returns it. In case it already exists, returns the existing one.

Parameters:

v

Dynamic to set the default value to

name

Name of the value

defaultValue

Default value

Returns:

T New/old value.

staticinlinesetMusic(frontEnd:SoundFrontEnd, music:FlxSound):Void

Sets a SoundFrontEnd's music to a FlxSound. +Example: FlxG.sound.setMusic(music);

Parameters:

frontEnd

SoundFrontEnd to set the music of

music

Music

staticinlinesetSpriteSize(sprite:FlxSprite, width:Float, height:Float):Void

Equivalent of setGraphicSize, except that it can accept floats and automatically updates the hitbox.

Parameters:

sprite

Sprite to set the size of

width

Width

height

Height

@:value({ maxScale : 0, fill : true })staticinlinesetUnstretchedGraphicSize(sprite:FlxSprite, width:Int, height:Int, fill:Bool = true, maxScale:Float = 0):Void

Allows you to set a graphic size (ex: 150x150), with proper hitbox without a stretched sprite.

Parameters:

sprite

Sprite to apply the new graphic size to

width

Width

height

Height

fill

Whenever the sprite should fill instead of shrinking (true)

maxScale

Maximum scale (0 / none)

@:noUsingstaticswitchAnimFrames(anim1:FlxAnimation, anim2:FlxAnimation):Void

Switches frames from 2 FlxAnimations.

Parameters:

anim1

First animation

anim2

Second animation

staticinlinetimeToStr(time:Float):String

Converts a timestamp to a readable format such as 01:22 (mm:ss)

\ No newline at end of file diff --git a/docs/funkin/backend/utils/DiscordJson.html b/docs/funkin/backend/utils/DiscordJson.html index 19efb95..5e2cf62 100644 --- a/docs/funkin/backend/utils/DiscordJson.html +++ b/docs/funkin/backend/utils/DiscordJson.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionallogoText:Null<String>

@:optionaloptionallogoKey:Null<String>

@:optionaloptionalclientID:Null<String>

\ No newline at end of file +

Fields

@:optionaloptionallogoText:Null<String>

@:optionaloptionallogoKey:Null<String>

@:optionaloptionalclientID:Null<String>

\ No newline at end of file diff --git a/docs/funkin/backend/utils/DiscordUtil.html b/docs/funkin/backend/utils/DiscordUtil.html index 12ee42b..f724321 100644 --- a/docs/funkin/backend/utils/DiscordUtil.html +++ b/docs/funkin/backend/utils/DiscordUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(null)staticcurrentID:String = null

@:value(null)staticdata:DiscordJson = null

@:value(null)staticdiscordThread:Thread = null

@:value(false)staticready:Bool = false

Static methods

staticchangeClientID(id:String):Void

staticchangePresence(details:String, state:String, ?smallImageKey:String):Void

staticchangePresenceAdvanced(data:DiscordPresenceOptions):Void

staticchangeSongPresence(details:String, state:String, audio:FlxSound, ?smallImageKey:String):Void

staticinit():Void

staticreloadJsonData():Void

staticshutdown():Void

\ No newline at end of file +

Static variables

@:value(null)staticcurrentID:String = null

@:value(null)staticdata:DiscordJson = null

@:value(null)staticdiscordThread:Thread = null

@:value(false)staticready:Bool = false

Static methods

staticchangeClientID(id:String):Void

staticchangePresence(details:String, state:String, ?smallImageKey:String):Void

staticchangePresenceAdvanced(data:DiscordPresenceOptions):Void

staticchangeSongPresence(details:String, state:String, audio:FlxSound, ?smallImageKey:String):Void

staticinit():Void

staticreloadJsonData():Void

staticshutdown():Void

\ No newline at end of file diff --git a/docs/funkin/backend/utils/EngineUtil.html b/docs/funkin/backend/utils/EngineUtil.html index 24d2016..bafaed6 100644 --- a/docs/funkin/backend/utils/EngineUtil.html +++ b/docs/funkin/backend/utils/EngineUtil.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

Static methods

staticstartMultithreadedScript(path:String):MultiThreadedScript

Starts a new multithreaded script. -This script will share all the variables with the current one, which means already existing callbacks will be replaced by new ones on conflict.

Parameters:

null

path

\ No newline at end of file +This script will share all the variables with the current one, which means already existing callbacks will be replaced by new ones on conflict.

Parameters:

null

path

\ No newline at end of file diff --git a/docs/funkin/backend/utils/FlxInterpolateColor.html b/docs/funkin/backend/utils/FlxInterpolateColor.html index e90ccce..82cd90c 100644 --- a/docs/funkin/backend/utils/FlxInterpolateColor.html +++ b/docs/funkin/backend/utils/FlxInterpolateColor.html @@ -9,4 +9,4 @@ text-shadow: 0 0 0 transparent; }

Additional class for FlxColor lerping. -Gets rid of precision issues with FlxColor.interpolate

Constructor

new(color:FlxColor)

Variables

@:value(0)alpha:Float = 0

@:value(0)blue:Float = 0

color:FlxColor

@:value(0)green:Float = 0

@:value(0)red:Float = 0

Methods

inlinefpsLerpTo(color:FlxColor, ratio:Float):Void

lerpTo(color:FlxColor, ratio:Float):Void

inlinetoString():String

\ No newline at end of file +Gets rid of precision issues with FlxColor.interpolate

Constructor

new(color:FlxColor)

Variables

@:value(0)alpha:Float = 0

@:value(0)blue:Float = 0

color:FlxColor

@:value(0)green:Float = 0

@:value(0)red:Float = 0

Methods

inlinefpsLerpTo(color:FlxColor, ratio:Float):Void

lerpTo(color:FlxColor, ratio:Float):Void

inlinetoString():String

\ No newline at end of file diff --git a/docs/funkin/backend/utils/FunkinParentDisabler.html b/docs/funkin/backend/utils/FunkinParentDisabler.html index 8b6072a..d8bec85 100644 --- a/docs/funkin/backend/utils/FunkinParentDisabler.html +++ b/docs/funkin/backend/utils/FunkinParentDisabler.html @@ -16,4 +16,4 @@ - Camera Movement - Timers - Sounds

-

To use, add add(new FunkinParentDisabler()); after super.create(); in your create function.

Constructor

@:value({ replaceUponDestroy : false })new(replaceUponDestroy:Bool = false)

Methods

reset():Void

\ No newline at end of file +

To use, add add(new FunkinParentDisabler()); after super.create(); in your create function.

Constructor

@:value({ replaceUponDestroy : false })new(replaceUponDestroy:Bool = false)

Methods

reset():Void

\ No newline at end of file diff --git a/docs/funkin/backend/utils/IXMLEvents.html b/docs/funkin/backend/utils/IXMLEvents.html index 67837ce..b714b36 100644 --- a/docs/funkin/backend/utils/IXMLEvents.html +++ b/docs/funkin/backend/utils/IXMLEvents.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Methods

onPropertySet(property:String, value:Dynamic):Void

\ No newline at end of file +

Methods

onPropertySet(property:String, value:Dynamic):Void

\ No newline at end of file diff --git a/docs/funkin/backend/utils/IniUtil.html b/docs/funkin/backend/utils/IniUtil.html index 4e71e4a..c46d513 100644 --- a/docs/funkin/backend/utils/IniUtil.html +++ b/docs/funkin/backend/utils/IniUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

DOESNT SUPPORT CATEGORIES YET!!

Static methods

staticinlineparseAsset(assetPath:String, ?defaultVariables:Map<String, String>):Map<String, String>

staticparseString(data:String, ?defaultVariables:Map<String, String>):Map<String, String>

\ No newline at end of file +

DOESNT SUPPORT CATEGORIES YET!!

Static methods

staticinlineparseAsset(assetPath:String, ?defaultVariables:Map<String, String>):Map<String, String>

staticparseString(data:String, ?defaultVariables:Map<String, String>):Map<String, String>

\ No newline at end of file diff --git a/docs/funkin/backend/utils/MarkdownUtil.html b/docs/funkin/backend/utils/MarkdownUtil.html index 0f21fe8..9762296 100644 --- a/docs/funkin/backend/utils/MarkdownUtil.html +++ b/docs/funkin/backend/utils/MarkdownUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticapplyMarkdownText(text:FlxText, str:String):Void

@:value({ underline : false, italic : false, bold : false })staticcreateAdvancedMarkerPair(marker:String, color:FlxColor, size:Null<Float>, bold:Bool = false, italic:Bool = false, underline:Bool = false, ?blockIndent:Int, ?bullet:Bool):FlxTextFormatMarkerPair

@:value({ emoteEnd : "\n" })staticparseEmote(text:String, emote:String, beginning:String, end:String, emoteEnd:String = "\n"):String

staticparseWarnings(text:String):String

staticprepareMarkdown(text:String):String

\ No newline at end of file +

Static methods

staticapplyMarkdownText(text:FlxText, str:String):Void

@:value({ underline : false, italic : false, bold : false })staticcreateAdvancedMarkerPair(marker:String, color:FlxColor, size:Null<Float>, bold:Bool = false, italic:Bool = false, underline:Bool = false, ?blockIndent:Int, ?bullet:Bool):FlxTextFormatMarkerPair

@:value({ emoteEnd : "\n" })staticparseEmote(text:String, emote:String, beginning:String, end:String, emoteEnd:String = "\n"):String

staticparseWarnings(text:String):String

staticprepareMarkdown(text:String):String

\ No newline at end of file diff --git a/docs/funkin/backend/utils/MemoryUtil.html b/docs/funkin/backend/utils/MemoryUtil.html index 67fedd2..6ed295d 100644 --- a/docs/funkin/backend/utils/MemoryUtil.html +++ b/docs/funkin/backend/utils/MemoryUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(0)staticdisableCount:Int = 0

Static methods

staticaskDisable():Void

staticaskEnable():Void

staticclearMajor():Void

staticclearMinor():Void

staticinlinecurrentMemUsage():Float

staticdisable():Void

staticenable():Void

staticgetMemType():String

staticgetTotalMem():Float

staticinit():Void

\ No newline at end of file +

Static variables

@:value(0)staticdisableCount:Int = 0

Static methods

staticaskDisable():Void

staticaskEnable():Void

staticclearMajor():Void

staticclearMinor():Void

staticinlinecurrentMemUsage():Float

staticdisable():Void

staticenable():Void

staticgetMemType():String

staticgetTotalMem():Float

staticinit():Void

\ No newline at end of file diff --git a/docs/funkin/backend/utils/MessageBoxIcon.html b/docs/funkin/backend/utils/MessageBoxIcon.html index e8fa44b..72583a6 100644 --- a/docs/funkin/backend/utils/MessageBoxIcon.html +++ b/docs/funkin/backend/utils/MessageBoxIcon.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast 0x00000010)@:impl@:enuminlineread onlyMSG_ERROR:MessageBoxIcon = 0x00000010

@:value(cast 0x00000040)@:impl@:enuminlineread onlyMSG_INFORMATION:MessageBoxIcon = 0x00000040

@:value(cast 0x00000020)@:impl@:enuminlineread onlyMSG_QUESTION:MessageBoxIcon = 0x00000020

@:value(cast 0x00000030)@:impl@:enuminlineread onlyMSG_WARNING:MessageBoxIcon = 0x00000030

\ No newline at end of file +

Variables

@:value(cast 0x00000010)@:impl@:enuminlineread onlyMSG_ERROR:MessageBoxIcon = 0x00000010

@:value(cast 0x00000040)@:impl@:enuminlineread onlyMSG_INFORMATION:MessageBoxIcon = 0x00000040

@:value(cast 0x00000020)@:impl@:enuminlineread onlyMSG_QUESTION:MessageBoxIcon = 0x00000020

@:value(cast 0x00000030)@:impl@:enuminlineread onlyMSG_WARNING:MessageBoxIcon = 0x00000030

\ No newline at end of file diff --git a/docs/funkin/backend/utils/NativeAPI.html b/docs/funkin/backend/utils/NativeAPI.html index 819cc99..db840e7 100644 --- a/docs/funkin/backend/utils/NativeAPI.html +++ b/docs/funkin/backend/utils/NativeAPI.html @@ -9,4 +9,4 @@ text-shadow: 0 0 0 transparent; }

Class for Windows-only functions, such as transparent windows, message boxes, and more. -Does not have any effect on other platforms.

Static methods

staticallocConsole():Void

Allocates a new console. The console will automatically be opened

@:value({ backgroundColor : NONE, foregroundColor : NONE })staticsetConsoleColors(foregroundColor:ConsoleColor = NONE, backgroundColor:ConsoleColor = NONE):Void

Sets the console colors

staticsetDarkMode(title:String, enable:Bool):Void

@:value({ icon : MSG_WARNING })staticshowMessageBox(caption:String, message:String, icon:MessageBoxIcon = MSG_WARNING):Void

Shows a message box

\ No newline at end of file +Does not have any effect on other platforms.

Static methods

staticallocConsole():Void

Allocates a new console. The console will automatically be opened

staticconsoleColorToANSI(color:ConsoleColor):Int

staticconsoleColorToOpenFL(color:ConsoleColor):Int

@:value({ backgroundColor : NONE, foregroundColor : NONE })staticsetConsoleColors(foregroundColor:ConsoleColor = NONE, backgroundColor:ConsoleColor = NONE):Void

Sets the console colors

staticsetDarkMode(title:String, enable:Bool):Void

@:value({ icon : MSG_WARNING })staticshowMessageBox(caption:String, message:String, icon:MessageBoxIcon = MSG_WARNING):Void

Shows a message box

\ No newline at end of file diff --git a/docs/funkin/backend/utils/NdllUtil.html b/docs/funkin/backend/utils/NdllUtil.html index 4e6854d..2e105dc 100644 --- a/docs/funkin/backend/utils/NdllUtil.html +++ b/docs/funkin/backend/utils/NdllUtil.html @@ -17,4 +17,4 @@ - The NDLL is not found - The Function cannot be found in the NDLL then an empty function will be returned instead, and a message will be shown in logs.

Static variables

@:value("windows")staticfinalread onlyos:String = "windows"

Static methods

staticgetFunction(ndll:String, name:String, args:Int):Dynamic

Returns an function from a Haxe NDLL. -Limited to 25 argument due to a limitation

Parameters:

ndll

Name of the NDLL.

name

Name of the function.

args

Number of arguments of that function.

staticgetFunctionFromPath(ndll:String, name:String, args:Int):Dynamic

Returns an function from a Haxe NDLL at specified path.

Parameters:

ndll

Asset path to the NDLL.

name

Name of the function.

args

Number of arguments of that function.

\ No newline at end of file +Limited to 25 argument due to a limitation

Parameters:

ndll

Name of the NDLL.

name

Name of the function.

args

Number of arguments of that function.

staticgetFunctionFromPath(ndll:String, name:String, args:Int):Dynamic

Returns an function from a Haxe NDLL at specified path.

Parameters:

ndll

Asset path to the NDLL.

name

Name of the function.

args

Number of arguments of that function.

\ No newline at end of file diff --git a/docs/funkin/backend/utils/ShaderResizeFix.html b/docs/funkin/backend/utils/ShaderResizeFix.html index d70f01c..83222c1 100644 --- a/docs/funkin/backend/utils/ShaderResizeFix.html +++ b/docs/funkin/backend/utils/ShaderResizeFix.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(true)staticdoResizeFix:Bool = true

Static methods

staticinlinefixSpriteShaderSize(sprite:Sprite):Void

staticinlinefixSpritesShadersSizes():Void

staticinit():Void

\ No newline at end of file +

Static variables

@:value(true)staticdoResizeFix:Bool = true

Static methods

staticinlinefixSpriteShaderSize(sprite:Sprite):Void

staticinlinefixSpritesShadersSizes():Void

staticinit():Void

\ No newline at end of file diff --git a/docs/funkin/backend/utils/SortedArrayUtil.html b/docs/funkin/backend/utils/SortedArrayUtil.html index e85e4a7..de773f7 100644 --- a/docs/funkin/backend/utils/SortedArrayUtil.html +++ b/docs/funkin/backend/utils/SortedArrayUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

All types of utils only usable in a sorted array.

Static methods

staticinlineaddSorted<T>(array:Array<T>, val:T, getVal:T ‑> Float):Void

Adds to a sorted array, using binary search.

Parameters:

array

Array to add to

val

Value to add

getVal

Function that returns the value that needs to be sorted

staticinlinebinarySearch<T>(array:Array<T>, val:Float, getVal:T ‑> Float):Int

Gets the index of a possible new element of an Array of T using an efficient algorithm.

Parameters:

array

Array of T to check in

getVal

Function that returns the position value of T

Returns:

Index

\ No newline at end of file +

All types of utils only usable in a sorted array.

Static methods

staticinlineaddSorted<T>(array:Array<T>, val:T, getVal:T ‑> Float):Void

Adds to a sorted array, using binary search.

Parameters:

array

Array to add to

val

Value to add

getVal

Function that returns the value that needs to be sorted

staticinlinebinarySearch<T>(array:Array<T>, val:Float, getVal:T ‑> Float):Int

Gets the index of a possible new element of an Array of T using an efficient algorithm.

Parameters:

array

Array of T to check in

getVal

Function that returns the position value of T

Returns:

Index

\ No newline at end of file diff --git a/docs/funkin/backend/utils/StrNameLabel.html b/docs/funkin/backend/utils/StrNameLabel.html index c4bae7f..70bac27 100644 --- a/docs/funkin/backend/utils/StrNameLabel.html +++ b/docs/funkin/backend/utils/StrNameLabel.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(name:String, label:String)

Variables

label:String

name:String

\ No newline at end of file +

Constructor

new(name:String, label:String)

Variables

label:String

name:String

\ No newline at end of file diff --git a/docs/funkin/backend/utils/SysZip.html b/docs/funkin/backend/utils/SysZip.html index 47e576f..95935af 100644 --- a/docs/funkin/backend/utils/SysZip.html +++ b/docs/funkin/backend/utils/SysZip.html @@ -10,4 +10,4 @@ }

Class that extends Reader allowing you to load ZIP entries without blowing your RAM up!! Half of the code is taken from haxe libraries btw

Static methods

staticopenFromFile(path:String):SysZip

Opens a zip from a specified path.

Parameters:

path

Path to the zip file.

Constructor

new(input:FileInput)

Creates a new SysZip from a specified file input.

Parameters:

input

File input.

Variables

Methods

dispose():Void

readEntryData(e:SysZipEntry):Bytes

Reads all the data present in a specified entry. -NOTE: If the entry is compressed, the data won't be decompressed. For decompression, use unzipEntry.

Parameters:

e

Entry

unzipEntry(f:SysZipEntry):Bytes

Unzips and returns all of the data present in an entry.

Parameters:

f

Entry to read from.

\ No newline at end of file +NOTE: If the entry is compressed, the data won't be decompressed. For decompression, use unzipEntry.

Parameters:

e

Entry

unzipEntry(f:SysZipEntry):Bytes

Unzips and returns all of the data present in an entry.

Parameters:

f

Entry to read from.

\ No newline at end of file diff --git a/docs/funkin/backend/utils/SysZipEntry.html b/docs/funkin/backend/utils/SysZipEntry.html index 3b4cea7..20466a5 100644 --- a/docs/funkin/backend/utils/SysZipEntry.html +++ b/docs/funkin/backend/utils/SysZipEntry.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

fileName:String

@:optionaloptionalextraFields:Null<List<ExtraField>>

data:Null<Bytes>

crc32:Null<Int>

\ No newline at end of file +

Fields

fileName:String

@:optionaloptionalextraFields:Null<List<ExtraField>>

data:Null<Bytes>

crc32:Null<Int>

\ No newline at end of file diff --git a/docs/funkin/backend/utils/TextFormat.html b/docs/funkin/backend/utils/TextFormat.html new file mode 100644 index 0000000..86ca97c --- /dev/null +++ b/docs/funkin/backend/utils/TextFormat.html @@ -0,0 +1,10 @@ + + + +funkin.backend.utils.TextFormat

Fields

text:String

format:Dynamic

\ No newline at end of file diff --git a/docs/funkin/backend/utils/ThreadUtil.html b/docs/funkin/backend/utils/ThreadUtil.html index 5d6e405..9d58b9c 100644 --- a/docs/funkin/backend/utils/ThreadUtil.html +++ b/docs/funkin/backend/utils/ThreadUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

@:value({ autoRestart : false })staticcreateSafe(func:() ‑> Void, autoRestart:Bool = false):Thread

Creates a new Thread with an error handler.

Parameters:

func

Function to execute

autoRestart

Whenever the thread should auto restart itself after crashing.

\ No newline at end of file +

Static methods

@:value({ autoRestart : false })staticcreateSafe(func:() ‑> Void, autoRestart:Bool = false):Thread

Creates a new Thread with an error handler.

Parameters:

func

Function to execute

autoRestart

Whenever the thread should auto restart itself after crashing.

\ No newline at end of file diff --git a/docs/funkin/backend/utils/WindowUtils.html b/docs/funkin/backend/utils/WindowUtils.html index 22423dd..949d6f0 100644 --- a/docs/funkin/backend/utils/WindowUtils.html +++ b/docs/funkin/backend/utils/WindowUtils.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value("")staticendfix:String = ""

@:value("")staticprefix:String = ""

@:value(true)staticpreventClosing:Bool = true

staticwinTitle:String

staticonClosing:() ‑> Void

Static methods

staticinlineinit():Void

staticinlineresetClosing():Void

staticinlineresetTitle():Void

staticset_endfix(endPrefix:String):String

staticset_prefix(newPrefix:String):String

staticset_winTitle(newWinTitle:String):String

staticinlineupdateTitle():Void

\ No newline at end of file +

Static variables

@:value("")staticendfix:String = ""

@:value("")staticprefix:String = ""

@:value(true)staticpreventClosing:Bool = true

staticwinTitle:String

staticonClosing:() ‑> Void

Static methods

staticinlineinit():Void

staticinlineresetClosing():Void

staticinlineresetTitle():Void

staticset_endfix(endPrefix:String):String

staticset_prefix(newPrefix:String):String

staticset_winTitle(newWinTitle:String):String

staticinlineupdateTitle():Void

\ No newline at end of file diff --git a/docs/funkin/backend/utils/XMLUtil.html b/docs/funkin/backend/utils/XMLUtil.html index 8e4701b..6d72230 100644 --- a/docs/funkin/backend/utils/XMLUtil.html +++ b/docs/funkin/backend/utils/XMLUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Class made to make XML parsing easier.

Static methods

staticaddAnimToSprite(sprite:FlxSprite, animData:AnimData):ErrorCode

@:value({ loop : false })staticaddXMLAnimation(sprite:FlxSprite, anim:Access, loop:Bool = false):ErrorCode

Adds an XML animation to sprite.

Parameters:

sprite

Destination sprite

anim

Animation (Must be a anim XML node)

staticapplyXMLProperty(object:Dynamic, property:Access):ErrorCode

Applies a property XML node to an object.

Parameters:

object

Object to which the xml property will be applied

property

property node.

@:value({ defaultAnimType : BEAT, parentFolder : "" })staticcreateSpriteFromXML(node:Access, parentFolder:String = "", defaultAnimType:XMLAnimType = BEAT, ?cl:Class<FunkinSprite>):FunkinSprite

Creates a new sprite based on a XML node.

@:value({ loop : false, animType : NONE })staticextractAnimFromXML(anim:Access, animType:XMLAnimType = NONE, loop:Bool = false):AnimData

staticinlinefixXMLText(text:String):String

\ No newline at end of file +

Class made to make XML parsing easier.

Static methods

staticaddAnimToSprite(sprite:FlxSprite, animData:AnimData):ErrorCode

@:value({ loop : false })staticaddXMLAnimation(sprite:FlxSprite, anim:Access, loop:Bool = false):ErrorCode

Adds an XML animation to sprite.

Parameters:

sprite

Destination sprite

anim

Animation (Must be a anim XML node)

staticapplyXMLProperty(object:Dynamic, property:Access):ErrorCode

Applies a property XML node to an object.

Parameters:

object

Object to which the xml property will be applied

property

property node.

@:value({ defaultAnimType : BEAT, parentFolder : "" })staticinlinecreateSpriteFromXML(node:Access, parentFolder:String = "", defaultAnimType:XMLAnimType = BEAT, ?cl:Class<FunkinSprite>, ?args:Array<Dynamic>):FunkinSprite

Creates a new sprite based on a XML node.

@:value({ loop : false, animType : NONE })staticextractAnimFromXML(anim:Access, animType:XMLAnimType = NONE, loop:Bool = false):AnimData

staticfixSpacingInNode(node:Access):Access

WARNING: will edit directly the node!

staticinlinefixXMLText(text:String):String

@:value({ parsedSegments : null, currentFormat : null })staticgetTextFormats(_node:OneOfTwo<Xml, Access>, ?currentFormat:Dynamic, ?parsedSegments:Array<TextFormat>):Array<TextFormat>

@:value({ defaultAnimType : BEAT, parentFolder : "" })staticloadSpriteFromXML(spr:FunkinSprite, node:Access, parentFolder:String = "", defaultAnimType:XMLAnimType = BEAT):FunkinSprite

Overrides a sprite based on a XML node.

\ No newline at end of file diff --git a/docs/funkin/backend/utils/ZipProgress.html b/docs/funkin/backend/utils/ZipProgress.html index d344509..3dab4d1 100644 --- a/docs/funkin/backend/utils/ZipProgress.html +++ b/docs/funkin/backend/utils/ZipProgress.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

@:value(0)curFile:Int = 0

@:value(false)done:Bool = false

@:value(null)error:Exception = null

@:value(0)fileCount:Int = 0

read onlypercentage:Float

\ No newline at end of file +

Constructor

new()

Variables

@:value(0)curFile:Int = 0

@:value(false)done:Bool = false

@:value(null)error:Exception = null

@:value(0)fileCount:Int = 0

read onlypercentage:Float

\ No newline at end of file diff --git a/docs/funkin/backend/utils/ZipReader.html b/docs/funkin/backend/utils/ZipReader.html index a8f61ba..4ee0480 100644 --- a/docs/funkin/backend/utils/ZipReader.html +++ b/docs/funkin/backend/utils/ZipReader.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(i:Input)

Variables

files:List<Entry>

Methods

\ No newline at end of file +

Constructor

new(i:Input)

Variables

files:List<Entry>

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/utils/ZipUtil.html b/docs/funkin/backend/utils/ZipUtil.html index a086515..b03c886 100644 --- a/docs/funkin/backend/utils/ZipUtil.html +++ b/docs/funkin/backend/utils/ZipUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value([".git", ".gitignore", ".github", ".vscode", ".gitattributes", "readme.txt"])staticbannedNames:Array<String> = [".git", ".gitignore", ".github", ".vscode", ".gitattributes", "readme.txt"]

Static methods

staticarrayToList(array:Array<Entry>):List<Entry>

[Description] Converts an Array<Entry> to a List<Entry>.

Parameters:

array

Returns:

List

staticcreateZipFile(path:String):ZipWriter

[Description] Creates a ZIP file at the specified location and returns the Writer.

Parameters:

path

Returns:

Writer

staticopenZip(zipPath:String):Reader

[Description] Returns a zip.Reader instance from path.

Parameters:

zipPath

Returns:

Reader

staticuncompressZip(zip:Reader, destFolder:String, ?prefix:String, ?prog:ZipProgress):ZipProgress

[Description] Uncompresses zip into the destFolder folder

Parameters:

zip
null

destFolder

staticuncompressZipAsync(zip:Reader, destFolder:String, ?prog:ZipProgress, ?prefix:String):ZipProgress

staticunzip(f:Entry):Null<Bytes>

[Description] Copy of haxe's Zip unzip function cause lime replaced it.

Parameters:

f

Zip entry

staticwriteFolderToZip(zip:ZipWriter, path:String, ?prefix:String, ?prog:ZipProgress, ?whitelist:Array<String>):ZipProgress

[Description] Writes the entirety of a folder to a zip file.

Parameters:

zip

ZIP file to write to

path

Folder path

prefix

(Additional) allows you to set a prefix in the zip itself.

staticwriteFolderToZipAsync(zip:ZipWriter, path:String, ?prefix:String):ZipProgress

\ No newline at end of file +

Static variables

@:value([".git", ".gitignore", ".github", ".vscode", ".gitattributes", "readme.txt"])staticbannedNames:Array<String> = [".git", ".gitignore", ".github", ".vscode", ".gitattributes", "readme.txt"]

Static methods

staticarrayToList(array:Array<Entry>):List<Entry>

[Description] Converts an Array<Entry> to a List<Entry>.

Parameters:

array

Returns:

List

staticcreateZipFile(path:String):ZipWriter

[Description] Creates a ZIP file at the specified location and returns the Writer.

Parameters:

path

Returns:

Writer

staticopenZip(zipPath:String):Reader

[Description] Returns a zip.Reader instance from path.

Parameters:

zipPath

Returns:

Reader

staticuncompressZip(zip:Reader, destFolder:String, ?prefix:String, ?prog:ZipProgress):ZipProgress

[Description] Uncompresses zip into the destFolder folder

Parameters:

zip
null

destFolder

staticuncompressZipAsync(zip:Reader, destFolder:String, ?prog:ZipProgress, ?prefix:String):ZipProgress

staticunzip(f:Entry):Null<Bytes>

[Description] Copy of haxe's Zip unzip function cause lime replaced it.

Parameters:

f

Zip entry

staticwriteFolderToZip(zip:ZipWriter, path:String, ?prefix:String, ?prog:ZipProgress, ?whitelist:Array<String>):ZipProgress

[Description] Writes the entirety of a folder to a zip file.

Parameters:

zip

ZIP file to write to

path

Folder path

prefix

(Additional) allows you to set a prefix in the zip itself.

staticwriteFolderToZipAsync(zip:ZipWriter, path:String, ?prefix:String):ZipProgress

\ No newline at end of file diff --git a/docs/funkin/backend/utils/ZipWriter.html b/docs/funkin/backend/utils/ZipWriter.html index 860a9e7..53fd671 100644 --- a/docs/funkin/backend/utils/ZipWriter.html +++ b/docs/funkin/backend/utils/ZipWriter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(o:Output)

Methods

close():Void

flush():Void

writeFile(entry:Entry):Void

\ No newline at end of file +

Constructor

new(o:Output)

Methods

close():Void

flush():Void

writeFile(entry:Entry):Void

\ No newline at end of file diff --git a/docs/funkin/backend/utils/index.html b/docs/funkin/backend/utils/index.html index 9896505..8170d80 100644 --- a/docs/funkin/backend/utils/index.html +++ b/docs/funkin/backend/utils/index.html @@ -7,11 +7,11 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.backend.utils

..
native
AnimData

BitmapUtil

ConsoleColor

CoolSfx

SFXs to play using playMenuSFX.

CoolUtil

DiscordJson

DiscordUtil

EngineUtil

FlxInterpolateColor

Additional class for FlxColor lerping. +

funkin.backend.utils

..
native
AnimData

AudioAnalyzer

BeatAnim

BitmapUtil

ConsoleColor

CoolSfx

SFXs to play using playMenuSFX.

CoolUtil

DiscordJson

DiscordUtil

EngineUtil

FlxInterpolateColor

Additional class for FlxColor lerping. Gets rid of precision issues with FlxColor.interpolate

FunkinParentDisabler

FlxBasic allowing you to disable those elements from the parent state while this substate is opened - Tweens - Camera Movement - Timers - Sounds

IXMLEvents

IniUtil

DOESNT SUPPORT CATEGORIES YET!!

MarkdownUtil

MemoryUtil

MessageBoxIcon

NativeAPI

Class for Windows-only functions, such as transparent windows, message boxes, and more. Does not have any effect on other platforms.

NdllUtil

Small util that allows you to load any function from ndlls via getFunction.

ShaderResizeFix

SortedArrayUtil

All types of utils only usable in a sorted array.

StrNameLabel

SysZip

Class that extends Reader allowing you to load ZIP entries without blowing your RAM up!! -Half of the code is taken from haxe libraries btw

SysZipEntry

ThreadUtil

WindowUtils

XMLUtil

Class made to make XML parsing easier.

ZipProgress

ZipReader

ZipUtil

ZipWriter

\ No newline at end of file +Half of the code is taken from haxe libraries btw

SysZipEntry

TextFormat

ThreadUtil

WindowUtils

XMLUtil

Class made to make XML parsing easier.

ZipProgress

ZipReader

ZipUtil

ZipWriter

\ No newline at end of file diff --git a/docs/funkin/backend/utils/native/HiddenProcess.html b/docs/funkin/backend/utils/native/HiddenProcess.html index 23eedff..3bbd1c6 100644 --- a/docs/funkin/backend/utils/native/HiddenProcess.html +++ b/docs/funkin/backend/utils/native/HiddenProcess.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(cmd:String, ?args:Array<String>, ?detached:Bool)

Variables

read onlystderr:Input

read onlystdin:Output

read onlystdout:Input

Methods

close():Void

@:value({ block : true })exitCode(block:Bool = true):Null<Int>

getPid():Int

kill():Void

\ No newline at end of file +

Constructor

new(cmd:String, ?args:Array<String>, ?detached:Bool)

Variables

read onlystderr:Input

read onlystdin:Output

read onlystdout:Input

Methods

close():Void

@:value({ block : true })exitCode(block:Bool = true):Null<Int>

getPid():Int

kill():Void

\ No newline at end of file diff --git a/docs/funkin/backend/utils/native/Stdin.html b/docs/funkin/backend/utils/native/Stdin.html index f17e848..a42f234 100644 --- a/docs/funkin/backend/utils/native/Stdin.html +++ b/docs/funkin/backend/utils/native/Stdin.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(p:Dynamic)

Methods

\ No newline at end of file +

Constructor

new(p:Dynamic)

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/utils/native/Stdout.html b/docs/funkin/backend/utils/native/Stdout.html index 758e048..e9d6626 100644 --- a/docs/funkin/backend/utils/native/Stdout.html +++ b/docs/funkin/backend/utils/native/Stdout.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(p:Dynamic, out:Bool)

Methods

\ No newline at end of file +

Constructor

new(p:Dynamic, out:Bool)

Methods

\ No newline at end of file diff --git a/docs/funkin/backend/utils/native/index.html b/docs/funkin/backend/utils/native/index.html index a9eb42a..c4f91ec 100644 --- a/docs/funkin/backend/utils/native/index.html +++ b/docs/funkin/backend/utils/native/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.backend.utils.native

..
HiddenProcess

Stdin

Stdout

\ No newline at end of file +

funkin.backend.utils.native

..
HiddenProcess

Stdin

Stdout

\ No newline at end of file diff --git a/docs/funkin/editors/DebugOptions.html b/docs/funkin/editors/DebugOptions.html index 65b7cd5..452d1b2 100644 --- a/docs/funkin/editors/DebugOptions.html +++ b/docs/funkin/editors/DebugOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

Inherited Variables

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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

stateScript:Script

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 TreeMenu

exit():Void

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new()

Methods

Inherited Variables

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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 TreeMenu

exit():Void

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/DebugOptionsScreen.html b/docs/funkin/editors/DebugOptionsScreen.html index 5b5195e..ee96006 100644 --- a/docs/funkin/editors/DebugOptionsScreen.html +++ b/docs/funkin/editors/DebugOptionsScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file +

Constructor

new()

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file diff --git a/docs/funkin/editors/Editor.html b/docs/funkin/editors/Editor.html index 3261b88..2b588d4 100644 --- a/docs/funkin/editors/Editor.html +++ b/docs/funkin/editors/Editor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

\ No newline at end of file +

Fields

\ No newline at end of file diff --git a/docs/funkin/editors/EditorPicker.html b/docs/funkin/editors/EditorPicker.html index 250e319..f39ec67 100644 --- a/docs/funkin/editors/EditorPicker.html +++ b/docs/funkin/editors/EditorPicker.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

bg:FlxSprite

@:value(0)camVelocity:Float = 0

@:value(FlxPoint.get())curMousePos:FlxPoint = FlxPoint.get()

@:value(0)curSelected:Int = 0

@:value(FlxPoint.get())oldMousePos:FlxPoint = FlxPoint.get()

@:value(0)optionHeight:Float = 0

@:value([{ name : "Chart Editor", iconID : 0, state : funkin.editors.charter.CharterSelection }, { name : "Character Editor", iconID : 1, state : funkin.editors.character.CharacterSelection }, { name : "Stage Editor", iconID : 2, state : null }, { name : "UI Debug State", iconID : 3, state : UIDebugState }, { name : "Debug Options", iconID : 4, state : DebugOptions }])options:Array<Editor> = [{ name : "Chart Editor", iconID : 0, state : funkin.editors.charter.CharterSelection }, { name : "Character Editor", iconID : 1, state : funkin.editors.character.CharacterSelection }, { name : "Stage Editor", iconID : 2, state : null }, { name : "UI Debug State", iconID : 3, state : UIDebugState }, { name : "Debug Options", iconID : 4, state : DebugOptions }]

@:value(false)selected:Bool = false

@:value([])sprites:Array<EditorPickerOption> = []

subCam:FlxCamera

Methods

changeSelection(change:Int):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

bg:FlxSprite

@:value(0)camVelocity:Float = 0

@:value(FlxPoint.get())curMousePos:FlxPoint = FlxPoint.get()

@:value(0)curSelected:Int = 0

@:value(FlxPoint.get())oldMousePos:FlxPoint = FlxPoint.get()

@:value(0)optionHeight:Float = 0

@:value([{ name : "Chart Editor", iconID : 0, state : funkin.editors.charter.CharterSelection }, { name : "Character Editor", iconID : 1, state : funkin.editors.character.CharacterSelection }, { name : "Stage Editor", iconID : 2, state : null }, { name : "UI Debug State", iconID : 3, state : UIDebugState }, { name : "Debug Options", iconID : 4, state : DebugOptions }])options:Array<Editor> = [{ name : "Chart Editor", iconID : 0, state : funkin.editors.charter.CharterSelection }, { name : "Character Editor", iconID : 1, state : funkin.editors.character.CharacterSelection }, { name : "Stage Editor", iconID : 2, state : null }, { name : "UI Debug State", iconID : 3, state : UIDebugState }, { name : "Debug Options", iconID : 4, state : DebugOptions }]

@:value(false)selected:Bool = false

@:value([])sprites:Array<EditorPickerOption> = []

subCam:FlxCamera

Methods

changeSelection(change:Int):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/EditorPickerOption.html b/docs/funkin/editors/EditorPickerOption.html index 3c9f6a5..5eff547 100644 --- a/docs/funkin/editors/EditorPickerOption.html +++ b/docs/funkin/editors/EditorPickerOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(name:String, iconID:Int, height:Float)

Variables

@:value(0)iconRotationCycle:Float = 0

iconSpr:FlxSprite

@:value(false)selected:Bool = false

selectionBG:FlxSprite

@:value(0)selectionLerp:Float = 0

Methods

flicker(callback:() ‑> Void):Void

\ No newline at end of file +

Constructor

new(name:String, iconID:Int, height:Float)

Variables

@:value(0)iconRotationCycle:Float = 0

iconSpr:FlxSprite

@:value(false)selected:Bool = false

selectionBG:FlxSprite

@:value(0)selectionLerp:Float = 0

Methods

flicker(callback:() ‑> Void):Void

\ No newline at end of file diff --git a/docs/funkin/editors/EditorTreeMenu.html b/docs/funkin/editors/EditorTreeMenu.html index daecf15..c672f97 100644 --- a/docs/funkin/editors/EditorTreeMenu.html +++ b/docs/funkin/editors/EditorTreeMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

bg:FlxBackdrop

@:value("default")bgType:String = "default"

Methods

Inherited Variables

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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

stateScript:Script

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 TreeMenu

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new()

Variables

bg:FlxBackdrop

@:value("default")bgType:String = "default"

Methods

Inherited Variables

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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 TreeMenu

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/SaveSubstate.html b/docs/funkin/editors/SaveSubstate.html index 0441507..6e605ea 100644 --- a/docs/funkin/editors/SaveSubstate.html +++ b/docs/funkin/editors/SaveSubstate.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(data:String, ?options:SaveSubstateData, ?saveOptions:Map<String, Bool>)

Variables

cam:FlxCamera

data:String

saveOptions:Map<String, Bool>

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(data:String, ?options:SaveSubstateData, ?saveOptions:Map<String, Bool>)

Variables

cam:FlxCamera

data:String

saveOptions:Map<String, Bool>

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/SaveSubstateData.html b/docs/funkin/editors/SaveSubstateData.html index 81c6d2e..9fee64b 100644 --- a/docs/funkin/editors/SaveSubstateData.html +++ b/docs/funkin/editors/SaveSubstateData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionalsaveExt:Null<String>

@:optionaloptionaldefaultSaveFile:Null<String>

\ No newline at end of file +

Fields

@:optionaloptionalsaveExt:Null<String>

@:optionaloptionaldefaultSaveFile:Null<String>

\ No newline at end of file diff --git a/docs/funkin/editors/SaveWarning.html b/docs/funkin/editors/SaveWarning.html index 5b25d74..feb7fa3 100644 --- a/docs/funkin/editors/SaveWarning.html +++ b/docs/funkin/editors/SaveWarning.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(null)staticselectionClass:Class<EditorTreeMenu> = null

staticshowWarning:Bool

Static methods

staticinit():Void

staticinlinereset():Void

staticset_showWarning(warning:Bool):Bool

@:value({ closingWindow : false })statictriggerWarning(closingWindow:Bool = false):Void

\ No newline at end of file +

Static variables

@:value(null)staticselectionClass:Class<EditorTreeMenu> = null

staticshowWarning:Bool

@:value(null)staticsaveFunc:() ‑> Void = null

@:value(null)staticwarningFunc:Bool ‑> Void = null

Static methods

staticinit():Void

staticinlinereset():Void

staticset_showWarning(warning:Bool):Bool

@:value({ closingWindow : false })statictriggerWarning(closingWindow:Bool = false):Void

\ No newline at end of file diff --git a/docs/funkin/editors/UIDebugState.html b/docs/funkin/editors/UIDebugState.html index 6c16956..596a344 100644 --- a/docs/funkin/editors/UIDebugState.html +++ b/docs/funkin/editors/UIDebugState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Methods

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

stateScript:Script

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Methods

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/UndoList.html b/docs/funkin/editors/UndoList.html index afa0690..cf7a909 100644 --- a/docs/funkin/editors/UndoList.html +++ b/docs/funkin/editors/UndoList.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

@:value([])redoList:Array<T> = []

@:value([])undoList:Array<T> = []

read onlyunsaved:Bool

Methods

inlineaddToUndo(c:T):Void

inlineget_unsaved():Bool

inlineredo():T

inlinesave():Void

inlineundo():T

\ No newline at end of file +

Constructor

new()

Variables

@:value([])redoList:Array<T> = []

@:value([])undoList:Array<T> = []

read onlyunsaved:Bool

Methods

inlineaddToUndo(c:T):Void

inlineget_unsaved():Bool

inlineredo():T

inlinesave():Void

inlineundo():T

\ No newline at end of file diff --git a/docs/funkin/editors/character/CharacterAnimButtons.html b/docs/funkin/editors/character/CharacterAnimButtons.html index 7639df6..0456a03 100644 --- a/docs/funkin/editors/character/CharacterAnimButtons.html +++ b/docs/funkin/editors/character/CharacterAnimButtons.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, anim:String, offset:FlxPoint)

Variables

Methods

updateInfo(anim:String, offset:FlxPoint, ghost:Bool):Void

inlineupdatePos():Void

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file +

Constructor

new(x:Float, y:Float, anim:String, offset:FlxPoint)

Variables

Methods

updateInfo(anim:String, offset:FlxPoint, ghost:Bool):Void

inlineupdatePos():Void

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/character/CharacterAnimScreen.html b/docs/funkin/editors/character/CharacterAnimScreen.html index cb65d25..26ab2d0 100644 --- a/docs/funkin/editors/character/CharacterAnimScreen.html +++ b/docs/funkin/editors/character/CharacterAnimScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(animData:AnimData, ?onSave:(animData:AnimData) ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(animData:AnimData, ?onSave:(animData:AnimData) ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/character/CharacterChange.html b/docs/funkin/editors/character/CharacterChange.html index 86e66ab..c0230d4 100644 --- a/docs/funkin/editors/character/CharacterChange.html +++ b/docs/funkin/editors/character/CharacterChange.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Values

CEditInfo(oldInfo:Xml, newInfo:Xml)

CCreateAnim(animID:Int, animData:AnimData)

CEditAnim(name:String, oldData:AnimData, animData:AnimData)

CDeleteAnim(animID:Int, animData:AnimData)

CChangeOffset(name:String, change:FlxPoint)

CResetOffsets(oldOffsets:Map<String, FlxPoint>)

\ No newline at end of file +

Values

CEditInfo(oldInfo:Xml, newInfo:Xml)

CCreateAnim(animID:Int, animData:AnimData)

CEditAnim(name:String, oldData:AnimData, animData:AnimData)

CDeleteAnim(animID:Int, animData:AnimData)

CChangeOffset(name:String, change:FlxPoint)

CResetOffsets(oldOffsets:Map<String, FlxPoint>)

\ No newline at end of file diff --git a/docs/funkin/editors/character/CharacterEditor.html b/docs/funkin/editors/character/CharacterEditor.html index ba035bc..dcea758 100644 --- a/docs/funkin/editors/character/CharacterEditor.html +++ b/docs/funkin/editors/character/CharacterEditor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

staticread onlyinstance:CharacterEditor

Constructor

new(character:String)

Variables

animsCamera:FlxCamera

charCamera:FlxCamera

characterBG:FunkinSprite

CHARACTER UI STUFF

uiCamera:FlxCamera

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

@:value(new UndoList<CharacterChange>())undos:UndoList<CharacterChange> = new UndoList<CharacterChange>()

Methods

@:value({ addtoUndo : true, animID : -1 })createAnim(animData:AnimData, animID:Int = -1, addtoUndo:Bool = true):Void

@:value({ addtoUndo : true })deleteAnim(name:String, addtoUndo:Bool = true):Void

@:value({ addtoUndo : true })editAnim(name:String, animData:AnimData, addtoUndo:Bool = true):Void

editAnimWithUI(name:String):Void

@:value({ addtoUndo : true })editInfo(newInfo:Xml, addtoUndo:Bool = true):Void

ghostAnim(anim:String):Void

playAnimation(anim:String):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).

stateScript:Script

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

staticread onlyinstance:CharacterEditor

Constructor

new(character:String)

Variables

animsCamera:FlxCamera

charCamera:FlxCamera

characterBG:FunkinSprite

CHARACTER UI STUFF

uiCamera:FlxCamera

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

@:value(new UndoList<CharacterChange>())undos:UndoList<CharacterChange> = new UndoList<CharacterChange>()

Methods

@:value({ addtoUndo : true, animID : -1 })createAnim(animData:AnimData, animID:Int = -1, addtoUndo:Bool = true):Void

@:value({ addtoUndo : true })deleteAnim(name:String, addtoUndo:Bool = true):Void

@:value({ addtoUndo : true })editAnim(name:String, animData:AnimData, addtoUndo:Bool = true):Void

editAnimWithUI(name:String):Void

@:value({ addtoUndo : true })editInfo(newInfo:Xml, addtoUndo:Bool = true):Void

ghostAnim(anim:String):Void

playAnimation(anim:String):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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/character/CharacterGhostsHandler.html b/docs/funkin/editors/character/CharacterGhostsHandler.html index a7f81ed..c923ff3 100644 --- a/docs/funkin/editors/character/CharacterGhostsHandler.html +++ b/docs/funkin/editors/character/CharacterGhostsHandler.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(character:Character)

Variables

@:value([])animGhosts:Map<String, Character> = []

Methods

createGhost(anim:String):Void

removeGhost(anim:String):Void

setOffsets(name:String, offset:FlxPoint):Void

updateInfos(xml:Xml):Void

updateOffsets(name:String, change:FlxPoint):Void

\ No newline at end of file +

Constructor

new(character:Character)

Variables

@:value([])animGhosts:Map<String, Character> = []

Methods

createGhost(anim:String):Void

removeGhost(anim:String):Void

setOffsets(name:String, offset:FlxPoint):Void

updateInfos(xml:Xml):Void

updateOffsets(name:String, change:FlxPoint):Void

\ No newline at end of file diff --git a/docs/funkin/editors/character/CharacterInfoScreen.html b/docs/funkin/editors/character/CharacterInfoScreen.html index 99e1119..4a80709 100644 --- a/docs/funkin/editors/character/CharacterInfoScreen.html +++ b/docs/funkin/editors/character/CharacterInfoScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(character:Character, ?onSave:(xml:Xml) ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(character:Character, ?onSave:(xml:Xml) ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/character/CharacterPropertiesWindow.html b/docs/funkin/editors/character/CharacterPropertiesWindow.html index 56b60c8..cdd37f2 100644 --- a/docs/funkin/editors/character/CharacterPropertiesWindow.html +++ b/docs/funkin/editors/character/CharacterPropertiesWindow.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

Inherited Variables

Defined by UIWindow

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIWindow

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new()

Variables

Inherited Variables

Defined by UIWindow

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIWindow

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/character/CharacterSelection.html b/docs/funkin/editors/character/CharacterSelection.html index e3ffb25..996b4da 100644 --- a/docs/funkin/editors/character/CharacterSelection.html +++ b/docs/funkin/editors/character/CharacterSelection.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

Inherited Variables

Defined by EditorTreeMenu

bg:FlxBackdrop

@:value("default")bgType:String = "default"

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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

stateScript:Script

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 EditorTreeMenu

Defined by TreeMenu

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new()

Methods

Inherited Variables

Defined by EditorTreeMenu

bg:FlxBackdrop

@:value("default")bgType:String = "default"

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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 EditorTreeMenu

Defined by TreeMenu

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/character/index.html b/docs/funkin/editors/character/index.html index b439bb3..0184637 100644 --- a/docs/funkin/editors/character/index.html +++ b/docs/funkin/editors/character/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharacterButton.html b/docs/funkin/editors/charter/CharacterButton.html index f16c8ef..f64c1ec 100644 --- a/docs/funkin/editors/charter/CharacterButton.html +++ b/docs/funkin/editors/charter/CharacterButton.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, char:String, charsList:Array<String>, parent:UIButtonList<CharacterButton>)

Variables

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file +

Constructor

new(x:Float, y:Float, char:String, charsList:Array<String>, parent:UIButtonList<CharacterButton>)

Variables

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/ChartCreationScreen.html b/docs/funkin/editors/charter/ChartCreationScreen.html new file mode 100644 index 0000000..dae404d --- /dev/null +++ b/docs/funkin/editors/charter/ChartCreationScreen.html @@ -0,0 +1,10 @@ + + + +funkin.editors.charter.ChartCreationScreen

Constructor

new(?onSave:(String, ChartData) ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/ChartDataScreen.html b/docs/funkin/editors/charter/ChartDataScreen.html index fd07ed6..42c62b3 100644 --- a/docs/funkin/editors/charter/ChartDataScreen.html +++ b/docs/funkin/editors/charter/ChartDataScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

Variables

Methods

saveInfo():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

Variables

Methods

saveInfo():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/Charter.html b/docs/funkin/editors/charter/Charter.html index 6069e73..75b1955 100644 --- a/docs/funkin/editors/charter/Charter.html +++ b/docs/funkin/editors/charter/Charter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

staticread onlyinstance:Charter

@:value(false)staticstartHere:Bool = false

@:value(0)staticstartTime:Float = 0

Constructor

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

Variables

@:value(0)__endStep:Float = 0

charterBG:FunkinSprite

CONFIG & UI (might make this customizable later)

charterCamera:FlxCamera

CAMERAS

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

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

hitsound:FlxSound

metronome:FlxSound

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

@:value(new Selection())selection:Selection = new Selection()

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

ACTUAL CHART DATA

strumlineInfoBG:FlxSprite

uiCamera:FlxCamera

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

@:value(new UndoList<CharterChange>())undos:UndoList<CharterChange> = new UndoList<CharterChange>()

vocals:FlxSound

Methods

buildChart():Void

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

@:value({ addToUndo : true })createStrumline(strumLineID:Int, strL:ChartStrumLine, addToUndo: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

inlineeditStrumline(strL:ChartStrumLine):Void

inlinehitsoundsEnabled(id:Int):Bool

loadSong():Void

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

inlineremoveStrumlineFromSelection(strumLineID:Int):Void

updateNoteLogic(elapsed:Float):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).

stateScript:Script

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

static__song:String

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

staticread onlyinstance:Charter

@:value(false)staticstartHere:Bool = false

@:value(0)staticstartTime:Float = 0

Constructor

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

Variables

@:value(0)__endStep:Float = 0

charterCamera:FlxCamera

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

hitsound:FlxSound

metronome:FlxSound

@:value(0)noteType:Int = 0

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

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

@: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]

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

strumlineInfoBG:FlxSprite

uiCamera:FlxCamera

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

vocals:FlxSound

Methods

buildChart():Void

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

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

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

inlineeditStrumline(strL:ChartStrumLine):Void

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

inlineremoveStrumlineFromSelection(strumLineID:Int):Void

updateNoteLogic(elapsed:Float):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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterBackdrop.html b/docs/funkin/editors/charter/CharterBackdrop.html index 67f6fa1..f66d493 100644 --- a/docs/funkin/editors/charter/CharterBackdrop.html +++ b/docs/funkin/editors/charter/CharterBackdrop.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(gridGraphic:FlxGraphic)

Variables

beatSeparator:FlxBackdrop

bottomLimit:FlxSprite

bottomSeparator:FlxSprite

gridBackDrop:FlxBackdrop

@:value(new FlxTypedGroup<CharterNote>())notesGroup:FlxTypedGroup<CharterNote> = new FlxTypedGroup<CharterNote>()

sectionSeparator:FlxBackdrop

topLimit:FlxSprite

topSeparator:FlxSprite

Methods

\ No newline at end of file +

Constructor

new(gridGraphic:FlxGraphic)

Variables

beatSeparator:FlxBackdrop

bottomLimit:FlxSprite

bottomSeparator:FlxSprite

gridBackDrop:FlxBackdrop

@:value(new FlxTypedGroup<CharterNote>())notesGroup:FlxTypedGroup<CharterNote> = new FlxTypedGroup<CharterNote>()

sectionSeparator:FlxBackdrop

topLimit:FlxSprite

topSeparator:FlxSprite

Methods

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterBackdropDummy.html b/docs/funkin/editors/charter/CharterBackdropDummy.html index d6357e3..b612310 100644 --- a/docs/funkin/editors/charter/CharterBackdropDummy.html +++ b/docs/funkin/editors/charter/CharterBackdropDummy.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

Methods

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

Methods

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterBackdropGroup.html b/docs/funkin/editors/charter/CharterBackdropGroup.html index 0ff1a1a..6af37c2 100644 --- a/docs/funkin/editors/charter/CharterBackdropGroup.html +++ b/docs/funkin/editors/charter/CharterBackdropGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(strumLineGroup:CharterStrumLineGroup)

Variables

@:value(true)beatsVisible:Bool = true

@:value(0)bottomLimitY:Float = 0

@:value(0)conductorSprY:Float = 0

@:value(null)draggingObj:CharterBackdrop = null

@:value(true)sectionsVisible:Bool = true

@:value(0)strumlinesAmount:Int = 0

Methods

@:value({ amount : 0 })createGrids(amount:Int = 0):Void

\ No newline at end of file +

Constructor

new(strumLineGroup:CharterStrumLineGroup)

Variables

@:value(true)beatsVisible:Bool = true

@:value(0)bottomLimitY:Float = 0

@:value(0)conductorSprY:Float = 0

@:value(null)draggingObj:CharterBackdrop = null

@:value(true)sectionsVisible:Bool = true

@:value(0)strumlinesAmount:Int = 0

Methods

@:value({ amount : 0 })createGrids(amount:Int = 0):Void

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterChange.html b/docs/funkin/editors/charter/CharterChange.html index 1649aa1..bd33aa7 100644 --- a/docs/funkin/editors/charter/CharterChange.html +++ b/docs/funkin/editors/charter/CharterChange.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Values

CCreateStrumLine(strumLineID:Int, strumLine:ChartStrumLine)

CEditStrumLine(strumLineID:Int, oldStrumLine:ChartStrumLine, newStrumLine:ChartStrumLine)

COrderStrumLine(strumLineID:Int, oldID:Int, newID:Int)

CDeleteStrumLine(strumLineID:Int, strumLine:ChartStrumLine)

CSelectionDrag(selectionDrags:Array<SelectionDragChange>)

CEditEvent(event:CharterEvent, oldEvents:Array<ChartEvent>, newEvents:Array<ChartEvent>)

CEditChartData(oldData:{stage:String, speed:Float}, newData:{stage:String, speed:Float})

\ No newline at end of file +

Values

CCreateStrumLine(strumLineID:Int, strumLine:ChartStrumLine)

CEditStrumLine(strumLineID:Int, oldStrumLine:ChartStrumLine, newStrumLine:ChartStrumLine)

COrderStrumLine(strumLineID:Int, oldID:Int, newID:Int)

CDeleteStrumLine(strumLineID:Int, strumLine:ChartStrumLine)

CSelectionDrag(selectionDrags:Array<SelectionDragChange>)

CEditEvent(event:CharterEvent, oldEvents:Array<ChartEvent>, newEvents:Array<ChartEvent>)

CEditChartData(oldData:{stage:String, speed:Float}, newData:{stage:String, speed:Float})

CEditNoteTypes(oldArray:Array<String>, newArray:Array<String>)

CEditSpecNotesType(notes:Array<CharterNote>, oldNoteTypes:Array<Int>, newNoteTypes:Array<Int>)

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterCopyboardObject.html b/docs/funkin/editors/charter/CharterCopyboardObject.html index 463fc8c..fa9668e 100644 --- a/docs/funkin/editors/charter/CharterCopyboardObject.html +++ b/docs/funkin/editors/charter/CharterCopyboardObject.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Values

CNote(step:Float, id:Int, strumLineID:Int, susLength:Float, type:Int)

CEvent(step:Float, events:Array<ChartEvent>)

\ No newline at end of file +

Values

CNote(step:Float, id:Int, strumLineID:Int, susLength:Float, type:Int)

CEvent(step:Float, events:Array<ChartEvent>)

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterEvent.html b/docs/funkin/editors/charter/CharterEvent.html index 3f3d9c6..136a9f7 100644 --- a/docs/funkin/editors/charter/CharterEvent.html +++ b/docs/funkin/editors/charter/CharterEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticgenerateEventIcon(event:ChartEvent):FlxSprite

Constructor

new(step:Float, ?events:Array<ChartEvent>)

Variables

@:value(true)draggable:Bool = true

@:value([])icons:Array<FlxSprite> = []

@:value(false)selected:Bool = false

@:value(true)snappedToGrid:Bool = true

step:Float

Methods

handleDrag(change:FlxPoint):Void

handleSelection(selectionBox:UISliceSprite):Bool

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file +

Static methods

staticgenerateEventIcon(event:ChartEvent):FlxSprite

Constructor

new(step:Float, ?events:Array<ChartEvent>)

Variables

@:value(true)draggable:Bool = true

@:value([])icons:Array<FlxSprite> = []

@:value(false)selected:Bool = false

@:value(true)snappedToGrid:Bool = true

step:Float

Methods

handleDrag(change:FlxPoint):Void

handleSelection(selectionBox:UISliceSprite):Bool

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterEventAdd.html b/docs/funkin/editors/charter/CharterEventAdd.html index 6767a55..1766233 100644 --- a/docs/funkin/editors/charter/CharterEventAdd.html +++ b/docs/funkin/editors/charter/CharterEventAdd.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

@:value(null)curCharterEvent:CharterEvent = null

@:value(0)sprAlpha:Float = 0

@:value(0)step:Float = 0

Methods

updatePos(y:Float):Void

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file +

Constructor

new()

Variables

@:value(null)curCharterEvent:CharterEvent = null

@:value(0)sprAlpha:Float = 0

@:value(0)step:Float = 0

Methods

updatePos(step:Float):Void

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterEventGroup.html b/docs/funkin/editors/charter/CharterEventGroup.html index b30b666..53da2ea 100644 --- a/docs/funkin/editors/charter/CharterEventGroup.html +++ b/docs/funkin/editors/charter/CharterEventGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?MaxSize:Int)

Variables

Methods

inlinefilterEvents():Void

inlinesortEvents():Void

\ No newline at end of file +

Constructor

new(?MaxSize:Int)

Variables

@:value(true)autoSort:Bool = true

Methods

inlinefilterEvents():Void

inlinesortEvents():Void

inlineupdateEventsIDs():Void

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterEventScreen.html b/docs/funkin/editors/charter/CharterEventScreen.html index dfaadcc..6be0b56 100644 --- a/docs/funkin/editors/charter/CharterEventScreen.html +++ b/docs/funkin/editors/charter/CharterEventScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(step:Float, ?chartEvent:CharterEvent)

Variables

@:value(-1)curEvent:Int = -1

@:value([])events:Array<ChartEvent> = []

@:value([])paramsFields:Array<FlxBasic> = []

paramsPanel:FlxGroup

@:value(0)step:Float = 0

Methods

@:value({ save : true })changeTab(id:Int, save:Bool = true):Void

saveCurTab():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(step:Float, ?chartEvent:CharterEvent)

Variables

@:value(-1)curEvent:Int = -1

@:value([])events:Array<ChartEvent> = []

@:value([])paramsFields:Array<FlxBasic> = []

paramsPanel:FlxGroup

@:value(0)step:Float = 0

Methods

@:value({ save : true })changeTab(id:Int, save:Bool = true):Void

saveCurTab():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterEventTypeSelection.html b/docs/funkin/editors/charter/CharterEventTypeSelection.html index 29f4fdb..b8cd3b1 100644 --- a/docs/funkin/editors/charter/CharterEventTypeSelection.html +++ b/docs/funkin/editors/charter/CharterEventTypeSelection.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(callback:String ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(callback:String ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterGridActionType.html b/docs/funkin/editors/charter/CharterGridActionType.html index c9a29cb..738ff8f 100644 --- a/docs/funkin/editors/charter/CharterGridActionType.html +++ b/docs/funkin/editors/charter/CharterGridActionType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

@:value(cast 1)@:impl@:enuminlineread onlyBOX:CharterGridActionType = 1

@:value(cast 2)@:impl@:enuminlineread onlyDRAG:CharterGridActionType = 2

@:value(cast 3)@:impl@:enuminlineread onlyINVALID_DRAG:CharterGridActionType = 3

@:value(cast 0)@:impl@:enuminlineread onlyNONE:CharterGridActionType = 0

\ No newline at end of file +

Variables

@:value(cast 1)@:impl@:enuminlineread onlyBOX:CharterGridActionType = 1

@:value(cast 2)@:impl@:enuminlineread onlyDRAG:CharterGridActionType = 2

@:value(cast 3)@:impl@:enuminlineread onlyINVALID_DRAG:CharterGridActionType = 3

@:value(cast 0)@:impl@:enuminlineread onlyNONE:CharterGridActionType = 0

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterNote.html b/docs/funkin/editors/charter/CharterNote.html index 41e23ed..785b3ac 100644 --- a/docs/funkin/editors/charter/CharterNote.html +++ b/docs/funkin/editors/charter/CharterNote.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

@:value(true)draggable:Bool = true

read onlyfullID:Int

id:Int

@:value(false)selected:Bool = false

@:value(true)snappedToStrumline:Bool = true

step:Float

read onlystrumLineID:Int

susLength:Float

sustainSpr:FlxSprite

type:Int

Methods

handleDrag(change:FlxPoint):Void

handleSelection(selectionBox:UISliceSprite):Bool

@:value({ strumLine : null, type : 0, susLength : 0 })updatePos(step:Float, id:Int, susLength:Float = 0, type:Int = 0, ?strumLine:CharterStrumline):Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new()

Variables

@:value(true)draggable:Bool = true

read onlyfullID:Int

id:Int

@:value(false)selected:Bool = false

@:value(true)snappedToStrumline:Bool = true

step:Float

@:value(-1)strumLineID:Int = -1

susLength:Float

sustainSpr:FlxSprite

type:Int

Methods

handleDrag(change:FlxPoint):Void

handleSelection(selectionBox:UISliceSprite):Bool

@:value({ strumLine : null, type : 0, susLength : 0 })updatePos(step:Float, id:Int, susLength:Float = 0, type:Int = 0, ?strumLine:CharterStrumline):Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterNoteGroup.html b/docs/funkin/editors/charter/CharterNoteGroup.html index e43f280..9847a79 100644 --- a/docs/funkin/editors/charter/CharterNoteGroup.html +++ b/docs/funkin/editors/charter/CharterNoteGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?MaxSize:Int)

Methods

sortNotes():Void

\ No newline at end of file +

Constructor

new(?MaxSize:Int)

Variables

@:value(true)autoSort:Bool = true

Methods

inlinepreallocate(len:Int):Void

sortNotes():Void

inlineupdateNoteIDs():Void

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterNoteHoverer.html b/docs/funkin/editors/charter/CharterNoteHoverer.html new file mode 100644 index 0000000..1d864f2 --- /dev/null +++ b/docs/funkin/editors/charter/CharterNoteHoverer.html @@ -0,0 +1,10 @@ + + + +funkin.editors.charter.CharterNoteHoverer

Constructor

new()

Methods

Inherited Variables

Defined by CharterNote

@:value(true)draggable:Bool = true

read onlyfullID:Int

id:Int

@:value(false)selected:Bool = false

@:value(true)snappedToStrumline:Bool = true

step:Float

@:value(-1)strumLineID:Int = -1

susLength:Float

sustainSpr:FlxSprite

type:Int

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by CharterNote

handleDrag(change:FlxPoint):Void

handleSelection(selectionBox:UISliceSprite):Bool

@:value({ strumLine : null, type : 0, susLength : 0 })updatePos(step:Float, id:Int, susLength:Float = 0, type:Int = 0, ?strumLine:CharterStrumline):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterNoteTypesList.html b/docs/funkin/editors/charter/CharterNoteTypesList.html new file mode 100644 index 0000000..4642cd7 --- /dev/null +++ b/docs/funkin/editors/charter/CharterNoteTypesList.html @@ -0,0 +1,10 @@ + + + +funkin.editors.charter.CharterNoteTypesList

Static variables

@:value("data/notes/")staticpathString:String = "data/notes/"

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

Methods

@:value({ mods : false })getNoteTypesList(mods:Bool = false):Array<String>

saveList():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterQuantButton.html b/docs/funkin/editors/charter/CharterQuantButton.html new file mode 100644 index 0000000..d46ce0e --- /dev/null +++ b/docs/funkin/editors/charter/CharterQuantButton.html @@ -0,0 +1,10 @@ + + + +funkin.editors.charter.CharterQuantButton

Constructor

new(x:Float, y:Float, quant:Int)

Variables

@:value(0)quant:Int = 0

Inherited Variables

Defined by UITopButton

onClick:() ‑> Void

Defined by UITopMenuButton

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UITopButton

Defined by UITopMenuButton

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterSelection.html b/docs/funkin/editors/charter/CharterSelection.html index fff1c39..c6957fd 100644 --- a/docs/funkin/editors/charter/CharterSelection.html +++ b/docs/funkin/editors/charter/CharterSelection.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

Methods

saveSong(creation:SongCreationData):Void

Inherited Variables

Defined by EditorTreeMenu

bg:FlxBackdrop

@:value("default")bgType:String = "default"

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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

stateScript:Script

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 EditorTreeMenu

Defined by TreeMenu

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new()

Variables

Methods

saveChart(name:String, data:ChartData):Void

saveSong(creation:SongCreationData):Void

Inherited Variables

Defined by EditorTreeMenu

bg:FlxBackdrop

@:value("default")bgType:String = "default"

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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 EditorTreeMenu

Defined by TreeMenu

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterStrumLineGroup.html b/docs/funkin/editors/charter/CharterStrumLineGroup.html index 51bf556..fe3ad39 100644 --- a/docs/funkin/editors/charter/CharterStrumLineGroup.html +++ b/docs/funkin/editors/charter/CharterStrumLineGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?MaxSize:Int)

Variables

@:value(false)draggable:Bool = false

read onlyisDragging:Bool

Methods

@:value({ addToUndo : true })finishDrag(addToUndo:Bool = true):Void

inlinefixEvents():Void

orderStrumline(strumLine:CharterStrumline, newID:Int):Void

snapStrums():Void

\ No newline at end of file +

Constructor

new(?MaxSize:Int)

Variables

@:value(false)draggable:Bool = false

read onlyisDragging:Bool

Methods

@:value({ addToUndo : true })finishDrag(addToUndo:Bool = true):Void

inlinefixEvents():Void

orderStrumline(strumLine:CharterStrumline, newID:Int):Void

snapStrums():Void

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterStrumline.html b/docs/funkin/editors/charter/CharterStrumline.html index 4787bb1..000fa6d 100644 --- a/docs/funkin/editors/charter/CharterStrumline.html +++ b/docs/funkin/editors/charter/CharterStrumline.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(strumLine:ChartStrumLine)

Variables

@:value(null)curMenu:UIContextMenu = null

@:value(false)draggable:Bool = false

@:value(false)dragging:Bool = false

@:value(true)hitsounds:Bool = true

Methods

updateInfo():Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(strumLine:ChartStrumLine)

Variables

@:value(null)curMenu:UIContextMenu = null

@:value(false)draggable:Bool = false

@:value(false)dragging:Bool = false

healthIcons:FlxSpriteGroup

@:value(true)hitsounds:Bool = true

vocals:FlxSound

Methods

updateInfo():Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterStrumlineButton.html b/docs/funkin/editors/charter/CharterStrumlineButton.html index 8bf112b..fcc0498 100644 --- a/docs/funkin/editors/charter/CharterStrumlineButton.html +++ b/docs/funkin/editors/charter/CharterStrumlineButton.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(imagePath:String, text:String)

Variables

Methods

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(imagePath:String, text:String)

Variables

@:value(true)animationOnClick:Bool = true

@:value(1)textColorLerp:Float = 1

onClick:() ‑> Void

Methods

@:value({ extra : false })pressAnimation(extra:Bool = false):Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterStrumlineOptions.html b/docs/funkin/editors/charter/CharterStrumlineOptions.html index 99de9f8..0ede0d6 100644 --- a/docs/funkin/editors/charter/CharterStrumlineOptions.html +++ b/docs/funkin/editors/charter/CharterStrumlineOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

Methods

Inherited Variables

Defined by UITopMenuButton

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UITopMenuButton

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file +

Constructor

Methods

Inherited Variables

Defined by UITopMenuButton

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UITopMenuButton

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CharterStrumlineScreen.html b/docs/funkin/editors/charter/CharterStrumlineScreen.html index 2a8d148..33b1663 100644 --- a/docs/funkin/editors/charter/CharterStrumlineScreen.html +++ b/docs/funkin/editors/charter/CharterStrumlineScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(strumLineID:Int, strumLine:ChartStrumLine, ?onSave:ChartStrumLine ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(strumLineID:Int, strumLine:ChartStrumLine, ?onSave:ChartStrumLine ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/CompactCharacterButton.html b/docs/funkin/editors/charter/CompactCharacterButton.html new file mode 100644 index 0000000..c03378c --- /dev/null +++ b/docs/funkin/editors/charter/CompactCharacterButton.html @@ -0,0 +1,10 @@ + + + +funkin.editors.charter.CompactCharacterButton

Constructor

new(char:String, charsList:Array<String>, parent:UIButtonList<CompactCharacterButton>)

Variables

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/EventBackdrop.html b/docs/funkin/editors/charter/EventBackdrop.html index a09efa3..14e3d57 100644 --- a/docs/funkin/editors/charter/EventBackdrop.html +++ b/docs/funkin/editors/charter/EventBackdrop.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

bottomSeparator:FlxSprite

eventBeatSeparator:FlxBackdrop

eventSecSeparator:FlxBackdrop

topSeparator:FlxSprite

Methods

\ No newline at end of file +

Constructor

new()

Variables

bottomSeparator:FlxSprite

eventBeatSeparator:FlxBackdrop

eventSecSeparator:FlxBackdrop

topSeparator:FlxSprite

Methods

\ No newline at end of file diff --git a/docs/funkin/editors/charter/EventButton.html b/docs/funkin/editors/charter/EventButton.html index 638d8ad..d7c9f26 100644 --- a/docs/funkin/editors/charter/EventButton.html +++ b/docs/funkin/editors/charter/EventButton.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(event:ChartEvent, icon:FlxSprite, id:Int, substate:CharterEventScreen, parent:UIButtonList<EventButton>)

Variables

deleteIcon:FlxSprite

@:value(null)event:ChartEvent = null

@:value(null)icon:FlxSprite = null

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file +

Constructor

new(event:ChartEvent, icon:FlxSprite, id:Int, substate:CharterEventScreen, parent:UIButtonList<EventButton>)

Variables

deleteIcon:FlxSprite

@:value(null)event:ChartEvent = null

@:value(null)icon:FlxSprite = null

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/ICharterSelectable.html b/docs/funkin/editors/charter/ICharterSelectable.html index acea30a..bb6b8e2 100644 --- a/docs/funkin/editors/charter/ICharterSelectable.html +++ b/docs/funkin/editors/charter/ICharterSelectable.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Variables

hovered:Bool

step:Float

x:Float

y:Float

Methods

handleDrag(change:FlxPoint):Void

handleSelection(selectionBox:UISliceSprite):Bool

\ No newline at end of file +

Variables

ID:Int

hovered:Bool

step:Float

x:Float

y:Float

Methods

handleDrag(change:FlxPoint):Void

handleSelection(selectionBox:UISliceSprite):Bool

\ No newline at end of file diff --git a/docs/funkin/editors/charter/MetaDataScreen.html b/docs/funkin/editors/charter/MetaDataScreen.html index e615ef8..313b457 100644 --- a/docs/funkin/editors/charter/MetaDataScreen.html +++ b/docs/funkin/editors/charter/MetaDataScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(metadata:ChartMetaData)

Variables

Methods

saveMeta():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(metadata:ChartMetaData)

Variables

Methods

saveMeta():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/NoteSustainChange.html b/docs/funkin/editors/charter/NoteSustainChange.html index 60d6a74..f3c9415 100644 --- a/docs/funkin/editors/charter/NoteSustainChange.html +++ b/docs/funkin/editors/charter/NoteSustainChange.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

\ No newline at end of file +

Fields

\ No newline at end of file diff --git a/docs/funkin/editors/charter/NoteTypeButton.html b/docs/funkin/editors/charter/NoteTypeButton.html new file mode 100644 index 0000000..6797147 --- /dev/null +++ b/docs/funkin/editors/charter/NoteTypeButton.html @@ -0,0 +1,10 @@ + + + +funkin.editors.charter.NoteTypeButton

Constructor

new(x:Float, y:Float, name:String, noteID:Int, suggestList:Array<String>, parent:UIButtonList<NoteTypeButton>)

Variables

Methods

updateNote(notetype:String):Void

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/PlaytestInfo.html b/docs/funkin/editors/charter/PlaytestInfo.html new file mode 100644 index 0000000..f8df0ef --- /dev/null +++ b/docs/funkin/editors/charter/PlaytestInfo.html @@ -0,0 +1,10 @@ + + + +funkin.editors.charter.PlaytestInfo
\ No newline at end of file diff --git a/docs/funkin/editors/charter/Selection.html b/docs/funkin/editors/charter/Selection.html index d929190..747c064 100644 --- a/docs/funkin/editors/charter/Selection.html +++ b/docs/funkin/editors/charter/Selection.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

@:value({ draggableOnly : true })staticinlineloop(this:Array<ICharterSelectable>, onNote:CharterNote ‑> Void, ?onEvent:CharterEvent ‑> Void, draggableOnly:Bool = true):Void

\ No newline at end of file +

Static methods

@:value({ draggableOnly : true })staticinlineloop(this:Array<ICharterSelectable>, onNote:CharterNote ‑> Void, ?onEvent:CharterEvent ‑> Void, draggableOnly:Bool = true):Void

\ No newline at end of file diff --git a/docs/funkin/editors/charter/SelectionDragChange.html b/docs/funkin/editors/charter/SelectionDragChange.html index 7b5103b..2a9a362 100644 --- a/docs/funkin/editors/charter/SelectionDragChange.html +++ b/docs/funkin/editors/charter/SelectionDragChange.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/editors/charter/SongCreationData.html b/docs/funkin/editors/charter/SongCreationData.html index 5a9cbce..26d8b19 100644 --- a/docs/funkin/editors/charter/SongCreationData.html +++ b/docs/funkin/editors/charter/SongCreationData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/editors/charter/SongCreationScreen.html b/docs/funkin/editors/charter/SongCreationScreen.html index 31fde3e..a7476d5 100644 --- a/docs/funkin/editors/charter/SongCreationScreen.html +++ b/docs/funkin/editors/charter/SongCreationScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?onSave:SongCreationData ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?onSave:SongCreationData ‑> Void)

Variables

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by UISubstateWindow

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/charter/StrumLineButton.html b/docs/funkin/editors/charter/StrumLineButton.html new file mode 100644 index 0000000..33a9004 --- /dev/null +++ b/docs/funkin/editors/charter/StrumLineButton.html @@ -0,0 +1,10 @@ + + + +funkin.editors.charter.StrumLineButton

Constructor

new(id:Int, strumLine:ChartStrumLine, parent:UIButtonList<StrumLineButton>)

Variables

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/charter/index.html b/docs/funkin/editors/charter/index.html index 5e3640d..de8c38d 100644 --- a/docs/funkin/editors/charter/index.html +++ b/docs/funkin/editors/charter/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/editors/extra/PropertyButton.html b/docs/funkin/editors/extra/PropertyButton.html new file mode 100644 index 0000000..1bcfdc0 --- /dev/null +++ b/docs/funkin/editors/extra/PropertyButton.html @@ -0,0 +1,10 @@ + + + +funkin.editors.extra.PropertyButton

Constructor

new(property:String, value:String, parent:{remove:PropertyButton ‑> Void})

Variables

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/extra/index.html b/docs/funkin/editors/extra/index.html new file mode 100644 index 0000000..e3de8ff --- /dev/null +++ b/docs/funkin/editors/extra/index.html @@ -0,0 +1,10 @@ + + + +funkin.editors.extra

funkin.editors.extra

..
PropertyButton

\ No newline at end of file diff --git a/docs/funkin/editors/index.html b/docs/funkin/editors/index.html index 85a4818..e098195 100644 --- a/docs/funkin/editors/index.html +++ b/docs/funkin/editors/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/editors/ui/IUIFocusable.html b/docs/funkin/editors/ui/IUIFocusable.html index a963d99..8df9b5f 100644 --- a/docs/funkin/editors/ui/IUIFocusable.html +++ b/docs/funkin/editors/ui/IUIFocusable.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Methods

onKeyDown(e:KeyCode, modifier:KeyModifier):Void

onKeyUp(e:KeyCode, modifier:KeyModifier):Void

onTextEdit(text:String, start:Int, end:Int):Void

onTextInput(text:String):Void

\ No newline at end of file +

Methods

onKeyDown(e:KeyCode, modifier:KeyModifier):Void

onKeyUp(e:KeyCode, modifier:KeyModifier):Void

onTextEdit(text:String, start:Int, end:Int):Void

onTextInput(text:String):Void

\ No newline at end of file diff --git a/docs/funkin/editors/ui/SliderSegement.html b/docs/funkin/editors/ui/SliderSegement.html index 51bdef4..37c81c9 100644 --- a/docs/funkin/editors/ui/SliderSegement.html +++ b/docs/funkin/editors/ui/SliderSegement.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

start:Float

size:Float

end:Float

\ No newline at end of file +

Fields

start:Float

size:Float

end:Float

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIAudioPlayer.html b/docs/funkin/editors/ui/UIAudioPlayer.html index 4daf11e..5575bdb 100644 --- a/docs/funkin/editors/ui/UIAudioPlayer.html +++ b/docs/funkin/editors/ui/UIAudioPlayer.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, bytes:Bytes)

Variables

bytes:Bytes

@:value(null)draggingObj:FlxBar = null

@:value(0x440364)nextPlayerColor:FlxColor = 0x440364

playingSprite:FlxSprite

sound:FlxSound

timeBar:FlxBar

timeBarPlayer:FlxSprite

volumeBar:FlxBar

volumeIcon:FlxSprite

@:value(false)wasPlaying:Bool = false

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file +

Constructor

new(x:Float, y:Float, bytes:Bytes)

Variables

bytes:Bytes

@:value(null)draggingObj:FlxBar = null

@:value(0x440364)nextPlayerColor:FlxColor = 0x440364

playingSprite:FlxSprite

sound:FlxSound

timeBar:FlxBar

timeBarPlayer:FlxSprite

volumeBar:FlxBar

volumeIcon:FlxSprite

@:value(false)wasPlaying:Bool = false

Methods

Inherited Variables

Defined by UIButton

@:value(null)callback:() ‑> Void = null

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UIButton

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIAutoCompleteTextBox.html b/docs/funkin/editors/ui/UIAutoCompleteTextBox.html index a22b955..541eed5 100644 --- a/docs/funkin/editors/ui/UIAutoCompleteTextBox.html +++ b/docs/funkin/editors/ui/UIAutoCompleteTextBox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ multiline : false, height : 32, width : 320, text : "" })new(x:Float, y:Float, text:String = "", width:Int = 320, height:Int = 32, multiline:Bool = false)

Variables

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

Methods

@:value({ refreshSuggestions : true })updateSuggestion(refreshSuggestions:Bool = true):Void

Inherited Variables

Defined by UITextBox

caretSpr:FlxSprite

@:value(false)multiline:Bool = false

onChange:String ‑> Void

@:value(0)position:Int = 0

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UITextBox

changeSelection(change:Int):Void

onKeyUp(e:KeyCode, modifier:KeyModifier):Void

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

@:value({ multiline : false, height : 32, width : 320, text : "" })new(x:Float, y:Float, text:String = "", width:Int = 320, height:Int = 32, multiline:Bool = false)

Variables

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

Methods

@:value({ refreshSuggestions : true })updateSuggestion(refreshSuggestions:Bool = true):Void

Inherited Variables

Defined by UITextBox

caretSpr:FlxSprite

@:value(false)multiline:Bool = false

onChange:String ‑> Void

@:value(0)position:Int = 0

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UITextBox

changeSelection(change:Int):Void

onKeyUp(e:KeyCode, modifier:KeyModifier):Void

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIBackdrop.html b/docs/funkin/editors/ui/UIBackdrop.html index 5fd891f..f6e13b5 100644 --- a/docs/funkin/editors/ui/UIBackdrop.html +++ b/docs/funkin/editors/ui/UIBackdrop.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Methods

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Methods

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIButton.html b/docs/funkin/editors/ui/UIButton.html index dec89f4..b8edb25 100644 --- a/docs/funkin/editors/ui/UIButton.html +++ b/docs/funkin/editors/ui/UIButton.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ h : 32, w : 120 })new(x:Float, y:Float, text:String, callback:() ‑> Void, w:Int = 120, h:Int = 32)

Variables

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

@:value(null)callback:() ‑> Void = null

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file +

Constructor

@:value({ h : 32, w : 120 })new(x:Float, y:Float, text:String, callback:() ‑> Void, w:Int = 120, h:Int = 32)

Variables

@:value(false)hasBeenPressed:Bool = false

@:value(true)shouldPress:Bool = true

@:value(null)callback:() ‑> Void = null

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIButtonList.html b/docs/funkin/editors/ui/UIButtonList.html index 3b0e400..fa8ac1b 100644 --- a/docs/funkin/editors/ui/UIButtonList.html +++ b/docs/funkin/editors/ui/UIButtonList.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, width:Int, height:Int, windowName:String, buttonSize:FlxPoint, ?buttonOffset:FlxPoint, ?buttonSpacing:Float)

Variables

addIcon:FlxSprite

buttonCameras:FlxCamera

@:value(FlxPoint.get())buttonOffset:FlxPoint = FlxPoint.get()

@:value(FlxPoint.get())buttonSize:FlxPoint = FlxPoint.get()

@:value(16)buttonSpacing:Float = 16

@:value(new FlxTypedGroup<T>())buttons:FlxTypedGroup<T> = new FlxTypedGroup<T>()

@:value(30)cameraSpacing:Int = 30

@:value(false)dragging:Bool = false

Methods

inlineadd(button:T):Void

inlineinsert(button:T, position:Int):Void

inlineremove(button:T):Void

inlineupdateButtonsPos(elapsed:Float):Void

Inherited Variables

Defined by UIWindow

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(x:Float, y:Float, width:Int, height:Int, windowName:String, buttonSize:FlxPoint, ?buttonOffset:FlxPoint, ?buttonSpacing:Float)

Variables

addIcon:FlxSprite

buttonCameras:FlxCamera

@:value(FlxPoint.get())buttonOffset:FlxPoint = FlxPoint.get()

@:value(FlxPoint.get())buttonSize:FlxPoint = FlxPoint.get()

@:value(16)buttonSpacing:Float = 16

@:value(new FlxTypedGroup<T>())buttons:FlxTypedGroup<T> = new FlxTypedGroup<T>()

@:value(30)cameraSpacing:Int = 30

@:value(false)dragging:Bool = false

dragCallback:(T, Int, Int) ‑> Void

Methods

inlineadd(button:T):Void

inlineinsert(button:T, position:Int):Void

inlineremove(button:T):Void

inlineupdateButtonsPos(elapsed:Float):Void

Inherited Variables

Defined by UIWindow

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UICheckbox.html b/docs/funkin/editors/ui/UICheckbox.html index 4e78d77..33b5d4f 100644 --- a/docs/funkin/editors/ui/UICheckbox.html +++ b/docs/funkin/editors/ui/UICheckbox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ w : 0, checked : false })new(x:Float, y:Float, text:String, checked:Bool = false, w:Int = 0)

Variables

check:FlxSprite

@:value(false)checked:Bool = false

@:value(null)onChecked:Bool ‑> Void = null

Methods

inlineupdatePositions():Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

\ No newline at end of file +

Constructor

@:value({ w : 0, checked : false })new(x:Float, y:Float, text:String, checked:Bool = false, w:Int = 0)

Variables

check:FlxSprite

@:value(false)checked:Bool = false

@:value(null)onChecked:Bool ‑> Void = null

Methods

inlineupdatePositions():Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIColorWheelSelector.html b/docs/funkin/editors/ui/UIColorWheelSelector.html index 8592ecd..c42071a 100644 --- a/docs/funkin/editors/ui/UIColorWheelSelector.html +++ b/docs/funkin/editors/ui/UIColorWheelSelector.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, ?color:Int)

Variables

colorCircle:FlxSprite

@:value(FlxColor.WHITE)curColor:FlxColor = FlxColor.WHITE

selector:FlxSprite

Methods

\ No newline at end of file +

Constructor

new(x:Float, y:Float, ?color:Int)

Variables

colorCircle:FlxSprite

@:value(FlxColor.WHITE)curColor:FlxColor = FlxColor.WHITE

selector:FlxSprite

Methods

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIColorwheel.html b/docs/funkin/editors/ui/UIColorwheel.html index 09e8cce..c9c4b64 100644 --- a/docs/funkin/editors/ui/UIColorwheel.html +++ b/docs/funkin/editors/ui/UIColorwheel.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, ?color:Int)

Variables

@:value(false)colorChanged:Bool = false

curColor:Null<FlxColor>

@:value("#FFFFFF")curColorString:String = "#FFFFFF"

hue:Float

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(x:Float, y:Float, ?color:Int)

Variables

@:value(false)colorChanged:Bool = false

curColor:Null<FlxColor>

@:value("#FFFFFF")curColorString:String = "#FFFFFF"

hue:Float

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIContextMenu.html b/docs/funkin/editors/ui/UIContextMenu.html index c2319b2..56a383d 100644 --- a/docs/funkin/editors/ui/UIContextMenu.html +++ b/docs/funkin/editors/ui/UIContextMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(options:Array<UIContextMenuOption>, callback:UIContextMenuCallback, x:Float, y:Float)

Variables

@:value([])separators:Array<FlxSprite> = []

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(options:Array<UIContextMenuOption>, callback:UIContextMenuCallback, x:Float, y:Float)

Variables

@:value([])separators:Array<FlxSprite> = []

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIContextMenuCallback.html b/docs/funkin/editors/ui/UIContextMenuCallback.html index e53590c..4d909bc 100644 --- a/docs/funkin/editors/ui/UIContextMenuCallback.html +++ b/docs/funkin/editors/ui/UIContextMenuCallback.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIContextMenuOption.html b/docs/funkin/editors/ui/UIContextMenuOption.html index e2c5714..15aa4d6 100644 --- a/docs/funkin/editors/ui/UIContextMenuOption.html +++ b/docs/funkin/editors/ui/UIContextMenuOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionalonSelect:Null<UIContextMenuOption ‑> Void>

label:String

@:optionaloptionalkeybinds:Null<Array<Array<FlxKey>>>

@:optionaloptionalkeybindText:Null<String>

@:optionaloptionalkeybind:Null<Array<FlxKey>>

@:optionaloptionalicon:Null<Int>

@:optionaloptionalcolor:Null<Int>

@:optionaloptionalchilds:Null<Array<UIContextMenuOption>>

\ No newline at end of file +

Fields

@:optionaloptionalonSelect:Null<UIContextMenuOption ‑> Void>

@:optionaloptionalonCreate:Null<UIContextMenuOptionSpr ‑> Void>

label:String

@:optionaloptionalkeybinds:Null<Array<Array<FlxKey>>>

@:optionaloptionalkeybindText:Null<String>

@:optionaloptionalkeybind:Null<Array<FlxKey>>

@:optionaloptionalicon:Null<Int>

@:optionaloptionalcolor:Null<FlxColor>

@:optionaloptionalcloseOnSelect:Null<Bool>

@:optionaloptionalchilds:Null<Array<UIContextMenuOption>>

@:optionaloptionalbutton:Null<UIContextMenuOptionSpr>

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIContextMenuOptionSpr.html b/docs/funkin/editors/ui/UIContextMenuOptionSpr.html index a40d4ce..300a77c 100644 --- a/docs/funkin/editors/ui/UIContextMenuOptionSpr.html +++ b/docs/funkin/editors/ui/UIContextMenuOptionSpr.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, option:UIContextMenuOption, parent:UIContextMenu)

Variables

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file +

Constructor

new(x:Float, y:Float, option:UIContextMenuOption, parent:UIContextMenu)

Variables

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIDropDown.html b/docs/funkin/editors/ui/UIDropDown.html index 51c38e9..cc57005 100644 --- a/docs/funkin/editors/ui/UIDropDown.html +++ b/docs/funkin/editors/ui/UIDropDown.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ index : 0, height : 32, width : 320 })new(x:Float, y:Float, width:Int = 320, height:Int = 32, options:Array<String>, index:Int = 0)

Variables

@:value(0)index:Int = 0

options:Array<String>

onChange:Int ‑> Void

Methods

setOption(newIndex:Int):Void

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

@:value({ index : 0, height : 32, width : 320 })new(x:Float, y:Float, width:Int = 320, height:Int = 32, options:Array<String>, index:Int = 0)

Variables

@:value(0)index:Int = 0

options:Array<String>

onChange:Int ‑> Void

Methods

setOption(newIndex:Int):Void

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIFileExplorer.html b/docs/funkin/editors/ui/UIFileExplorer.html index fbc89c3..f6d1976 100644 --- a/docs/funkin/editors/ui/UIFileExplorer.html +++ b/docs/funkin/editors/ui/UIFileExplorer.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ fileType : "txt" })new(x:Float, y:Float, fileType:String = "txt", ?onFile:Bytes ‑> Void)

Variables

deleteIcon:FlxSprite

@:value(null)file:Bytes = null

uploadIcon:FlxSprite

onFile:Bytes ‑> Void

Methods

removeFile():Void

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

@:value({ fileType : "txt" })new(x:Float, y:Float, ?w:Int, ?h:Int, fileType:String = "txt", ?onFile:Bytes ‑> Void)

Variables

deleteIcon:FlxSprite

@:value(null)file:Bytes = null

uploadIcon:FlxSprite

onFile:Bytes ‑> Void

Methods

removeFile():Void

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UINumericStepper.html b/docs/funkin/editors/ui/UINumericStepper.html index 1273f00..0a6d5d0 100644 --- a/docs/funkin/editors/ui/UINumericStepper.html +++ b/docs/funkin/editors/ui/UINumericStepper.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ h : 32, w : 180, precision : 0, step : 1, value : 0 })new(x:Float, y:Float, value:Float = 0, step:Float = 1, precision:Int = 0, ?min:Float, ?max:Float, w:Int = 180, h:Int = 32)

Variables

@:value(null)max:Null<Float> = null

@:value(null)min:Null<Float> = null

@:value(0)precision:Int = 0

@:value(1)step:Float = 1

value:Float

Inherited Variables

Defined by UITextBox

caretSpr:FlxSprite

@:value(false)multiline:Bool = false

onChange:String ‑> Void

@:value(0)position:Int = 0

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UITextBox

changeSelection(change:Int):Void

onKeyDown(e:KeyCode, modifier:KeyModifier):Void

onKeyUp(e:KeyCode, modifier:KeyModifier):Void

onTextEdit(text:String, start:Int, end:Int):Void

onTextInput(text:String):Void

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

@:value({ h : 32, w : 180, precision : 0, step : 1, value : 0 })new(x:Float, y:Float, value:Float = 0, step:Float = 1, precision:Int = 0, ?min:Float, ?max:Float, w:Int = 180, h:Int = 32)

Variables

@:value(null)max:Null<Float> = null

@:value(null)min:Null<Float> = null

@:value(0)precision:Int = 0

@:value(1)step:Float = 1

value:Float

Inherited Variables

Defined by UITextBox

caretSpr:FlxSprite

@:value(false)multiline:Bool = false

onChange:String ‑> Void

@:value(0)position:Int = 0

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UITextBox

changeSelection(change:Int):Void

onKeyDown(e:KeyCode, modifier:KeyModifier):Void

onKeyUp(e:KeyCode, modifier:KeyModifier):Void

onTextEdit(text:String, start:Int, end:Int):Void

onTextInput(text:String):Void

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIScrollBar.html b/docs/funkin/editors/ui/UIScrollBar.html index 910fcf1..b4c0813 100644 --- a/docs/funkin/editors/ui/UIScrollBar.html +++ b/docs/funkin/editors/ui/UIScrollBar.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ w : 20 })new(x:Float, y:Float, length:Float, start:Float, size:Float, w:Int = 20, ?h:Int)

Variables

length:Float

size:Float

start:Float

thumbIcon:FlxSprite

value:Float

onChange:Float ‑> Void

Methods

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

@:value({ w : 20 })new(x:Float, y:Float, length:Float, start:Float, size:Float, w:Int = 20, ?h:Int)

Variables

length:Float

size:Float

start:Float

thumbIcon:FlxSprite

value:Float

onChange:Float ‑> Void

Methods

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UISliceSprite.html b/docs/funkin/editors/ui/UISliceSprite.html index 9aa682d..ccb9298 100644 --- a/docs/funkin/editors/ui/UISliceSprite.html +++ b/docs/funkin/editors/ui/UISliceSprite.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, w:Int, h:Int, path:String)

Variables

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Methods

resize(w:Int, h:Int):Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(x:Float, y:Float, w:Int, h:Int, path:String)

Variables

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Methods

resize(w:Int, h:Int):Void

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UISlider.html b/docs/funkin/editors/ui/UISlider.html index d834088..43695d3 100644 --- a/docs/funkin/editors/ui/UISlider.html +++ b/docs/funkin/editors/ui/UISlider.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ width : 120 })new(x:Float, y:Float, width:Int = 120, segments:Array<SliderSegement>)

Variables

barEndSpr:FlxSprite

@:value([])barSegements:Map<{size:Float, segment:Float}, UISprite> = []

barStartSpr:FlxSprite

@:value(120)barWidth:Int = 120

@:value([])segments:Array<SliderSegement> = []

Methods

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

@:value({ width : 120 })new(x:Float, y:Float, width:Int = 120, value:Float, segments:Array<SliderSegement>, centered:Bool)

Variables

Methods

set_value(newVal:Float):Float

Inherited Variables

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UISprite.html b/docs/funkin/editors/ui/UISprite.html index 8d2f869..0f83b63 100644 --- a/docs/funkin/editors/ui/UISprite.html +++ b/docs/funkin/editors/ui/UISprite.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

@:value(null)hoverCallback:() ‑> Void = null

Methods

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

@:value(null)hoverCallback:() ‑> Void = null

Methods

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIState.html b/docs/funkin/editors/ui/UIState.html index 82588c9..5e7c9bd 100644 --- a/docs/funkin/editors/ui/UIState.html +++ b/docs/funkin/editors/ui/UIState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

staticread onlystate:UIState

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(null)curContextMenu:UIContextMenu = null

@:value(ARROW)currentCursor:MouseCursor = ARROW

@:value(null)currentFocus:IUIFocusable = null

@:value(null)hoveredSprite:UISprite = null

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

Methods

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

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

staticread onlystate:UIState

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(null)curContextMenu:UIContextMenu = null

@:value(ARROW)currentCursor:MouseCursor = ARROW

@:value(null)currentFocus:IUIFocusable = null

@:value(null)hoveredSprite:UISprite = null

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

Methods

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

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UISubstateWindow.html b/docs/funkin/editors/ui/UISubstateWindow.html index 7ba03c5..e6ca7bd 100644 --- a/docs/funkin/editors/ui/UISubstateWindow.html +++ b/docs/funkin/editors/ui/UISubstateWindow.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIText.html b/docs/funkin/editors/ui/UIText.html index 1d3b8cf..0335183 100644 --- a/docs/funkin/editors/ui/UIText.html +++ b/docs/funkin/editors/ui/UIText.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ color : 0xFFFFFFFF, size : 15 })new(x:Float, y:Float, w:Float, text:Null<String>, size:Int = 15, color:FlxColor = 0xFFFFFFFF)

Inherited Variables

Inherited Methods

\ No newline at end of file +

Constructor

@:value({ outline : true, color : 0xFFFFFFFF, size : 15 })new(x:Float, y:Float, w:Float, text:Null<String>, size:Int = 15, color:FlxColor = 0xFFFFFFFF, outline:Bool = true)

Variables

@:value(false)optimized:Bool = false

Methods

Inherited Variables

Inherited Methods

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UITextBox.html b/docs/funkin/editors/ui/UITextBox.html index dd2dda7..b1164a6 100644 --- a/docs/funkin/editors/ui/UITextBox.html +++ b/docs/funkin/editors/ui/UITextBox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ multiline : false, height : 32, width : 320, text : "" })new(x:Float, y:Float, text:String = "", width:Int = 320, height:Int = 32, multiline:Bool = false)

Variables

caretSpr:FlxSprite

@:value(false)multiline:Bool = false

@:value(0)position:Int = 0

onChange:String ‑> Void

Methods

changeSelection(change:Int):Void

onKeyDown(e:KeyCode, modifier:KeyModifier):Void

onKeyUp(e:KeyCode, modifier:KeyModifier):Void

onTextEdit(text:String, start:Int, end:Int):Void

onTextInput(text:String):Void

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

@:value({ multiline : false, height : 32, width : 320, text : "" })new(x:Float, y:Float, text:String = "", width:Int = 320, height:Int = 32, multiline:Bool = false)

Variables

caretSpr:FlxSprite

@:value(false)multiline:Bool = false

@:value(0)position:Int = 0

onChange:String ‑> Void

Methods

changeSelection(change:Int):Void

onKeyDown(e:KeyCode, modifier:KeyModifier):Void

onKeyUp(e:KeyCode, modifier:KeyModifier):Void

onTextEdit(text:String, start:Int, end:Int):Void

onTextInput(text:String):Void

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UITopButton.html b/docs/funkin/editors/ui/UITopButton.html new file mode 100644 index 0000000..e49ebd8 --- /dev/null +++ b/docs/funkin/editors/ui/UITopButton.html @@ -0,0 +1,10 @@ + + + +funkin.editors.ui.UITopButton

Constructor

new(x:Float, y:Float, name:String)

Variables

onClick:() ‑> Void

Methods

Inherited Variables

Defined by UITopMenuButton

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UITopMenuButton

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UITopMenu.html b/docs/funkin/editors/ui/UITopMenu.html index dc0a3fb..ddad811 100644 --- a/docs/funkin/editors/ui/UITopMenu.html +++ b/docs/funkin/editors/ui/UITopMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(options:Array<UIContextMenuOption>)

Variables

@:value(false)anyMenuOpened:Bool = false

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(options:Array<UIContextMenuOption>)

Variables

@:value(false)anyMenuOpened:Bool = false

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UITopMenuButton.html b/docs/funkin/editors/ui/UITopMenuButton.html index 9b88281..bff9a00 100644 --- a/docs/funkin/editors/ui/UITopMenuButton.html +++ b/docs/funkin/editors/ui/UITopMenuButton.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, parent:UITopMenu, label:String, contextMenu:Array<UIContextMenuOption>)

Variables

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file +

Constructor

new(x:Float, y:Float, parent:UITopMenu, label:String, contextMenu:Array<UIContextMenuOption>)

Variables

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIUtil.html b/docs/funkin/editors/ui/UIUtil.html index 485c421..ee10ad7 100644 --- a/docs/funkin/editors/ui/UIUtil.html +++ b/docs/funkin/editors/ui/UIUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticcontextMenuOpened(contextMenu:UIContextMenu):Bool

@:value({ y : 0, x : 0 })staticfollow(spr:FlxSprite, target:FlxSprite, x:Float = 0, y:Float = 0):Void

staticinlineprettify(str:String):String

staticprocessShortcuts(topMenuOptions:Array<UIContextMenuOption>):Bool

Process all options with shortcuts present in a Array<UIContextMenuOption>. Also checks childrens.

Parameters:

null

topMenuOptions

statictoUIString(key:FlxKey):String

\ No newline at end of file +

Static methods

staticcontextMenuOpened(contextMenu:UIContextMenu):Bool

@:value({ y : 0, x : 0 })staticfollow(spr:FlxSprite, target:FlxSprite, x:Float = 0, y:Float = 0):Void

staticinlineprettify(str:String):String

staticprocessShortcuts(topMenuOptions:Array<UIContextMenuOption>):Bool

Process all options with shortcuts present in a Array<UIContextMenuOption>. Also checks childrens.

Parameters:

null

topMenuOptions

statictoUIString(key:FlxKey):String

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIWarningSubstate.html b/docs/funkin/editors/ui/UIWarningSubstate.html index ae5e25e..4c2373a 100644 --- a/docs/funkin/editors/ui/UIWarningSubstate.html +++ b/docs/funkin/editors/ui/UIWarningSubstate.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ isError : true })new(title:String, message:String, buttons:Array<WarningButton>, isError:Bool = true)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

@:value({ isError : true })new(title:String, message:String, buttons:Array<WarningButton>, isError:Bool = true)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/editors/ui/UIWindow.html b/docs/funkin/editors/ui/UIWindow.html index 0e1b7cc..4e64a54 100644 --- a/docs/funkin/editors/ui/UIWindow.html +++ b/docs/funkin/editors/ui/UIWindow.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, w:Int, h:Int, title:String)

Variables

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file +

Constructor

new(x:Float, y:Float, w:Int, h:Int, title:String)

Variables

Methods

Inherited Variables

Defined by UISliceSprite

@:value(20)bHeight:Int = 20

@:value(120)bWidth:Int = 120

@:value(true)drawBottom:Bool = true

@:value(true)drawMiddle:Bool = true

@:value(true)drawTop:Bool = true

@:value(0)framesOffset:Int = 0

@:value(false)incorporeal:Bool = false

Defined by UISprite

@:value(true)autoAlpha:Bool = true

@:value(true)canBeHovered:Bool = true

@:value(ARROW)cursor:MouseCursor = ARROW

focused:Bool

@:value(null)hoverCallback:() ‑> Void = null

@:value(false)hovered:Bool = false

@:value(false)hoveredByChild:Bool = false

@:value([])members:Array<FlxBasic> = []

@:value(false)pressed:Bool = false

@:value(true)selectable:Bool = true

Inherited Methods

Defined by UISliceSprite

resize(w:Int, h:Int):Void

Defined by UISprite

drawSuper():Void

onHovered():Void

Called whenever the sprite is being hovered by the mouse.

\ No newline at end of file diff --git a/docs/funkin/editors/ui/WarningButton.html b/docs/funkin/editors/ui/WarningButton.html index d8af001..d24eefb 100644 --- a/docs/funkin/editors/ui/WarningButton.html +++ b/docs/funkin/editors/ui/WarningButton.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

label:String

@:optionaloptionalcolor:Null<Int>

\ No newline at end of file +

Fields

label:String

@:optionaloptionalcolor:Null<Int>

\ No newline at end of file diff --git a/docs/funkin/editors/ui/index.html b/docs/funkin/editors/ui/index.html index 23cc9da..ba6a2c1 100644 --- a/docs/funkin/editors/ui/index.html +++ b/docs/funkin/editors/ui/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/game/Character.html b/docs/funkin/game/Character.html index 88f62fb..aa0775b 100644 --- a/docs/funkin/game/Character.html +++ b/docs/funkin/game/Character.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticgetIconFromCharName(?curCharacter:String):String

@:value({ mods : false })staticgetList(mods:Bool = false):Array<String>

Constructor

@:value({ switchAnims : true, isPlayer : false, character : "bf" })new(x:Float, y:Float, character:String = "bf", isPlayer:Bool = false, switchAnims:Bool = true)

Variables

@:value(new FlxPoint(0, 0))cameraOffset:FlxPoint = new FlxPoint(0, 0)

@:value("bf")curCharacter:String = "bf"

@:value(1)danceInterval:Int = 1

Interval at which the character will dance (higher number = slower dance)

@:value(true)danceOnBeat:Bool = true

Whenever the character should dance on beat or not. Set to false for gf, since the dance animation is automatically handled by PlayState.

@:value([])extra:Map<String, Dynamic> = []

@:value("bf-dead")gameOverCharacter:String = "bf-dead"

@:value(new FlxPoint(0, 0))globalOffset:FlxPoint = new FlxPoint(0, 0)

@:value(4)holdTime:Float = 4

@:value(null)icon:String = null

@:value(null)iconColor:Null<FlxColor> = null

@:value(false)isGF:Bool = false

@:value(false)isPlayer:Bool = false

@:value(Math.NEGATIVE_INFINITY)lastHit:Float = Math.NEGATIVE_INFINITY

@:value(false)playerOffsets:Bool = false

@:value("bf")sprite:String = "bf"

@:value(false)stunned:Bool = false

xml:Access

Methods

applyXML(xml:Access):Void

buildXML(?animsOrder:Array<String>):Xml

dance():Void

FOR GF DANCING SHIT

@:value({ switchAnims : false })fixChar(switchAnims:Bool = false):Void

getAnimOrder():Array<String>

inlinegetCameraPosition():FlxPoint

inlinegetIcon():String

@:value({ Frame : 0, Reversed : false, Force : true, Context : SING, suffix : "" })playSingAnim(direction:Int, suffix:String = "", Context:PlayAnimContext = SING, Force:Bool = true, Reversed:Bool = false, Frame:Int = 0):Void

tryDance():Void

Inherited Variables

Defined by FunkinSprite

@:value([])animDatas:Map<String, AnimData> = []

@:value(new Map<String,FlxPoint>())animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

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

@:value(false)debugMode:Bool = false

@:value(1)initialZoom:Float = 1

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

name:String

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Inherited Methods

Defined by FunkinSprite

@:value({ y : 0, x : 0 })addOffset(name:String, x:Float = 0, y:Float = 0):Void

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnimation(AnimName:String):Bool

inlineisAnimFinished():Bool

@:value({ Key : null, Unique : false })loadSprite(path:String, Unique:Bool = false, ?Key:String):Void

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

inlineremoveAnimation(name:String):Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

\ No newline at end of file +

Static methods

staticgetIconFromCharName(?curCharacter:String):String

@:value({ mods : false })staticgetList(mods:Bool = false):Array<String>

Constructor

@:value({ switchAnims : true, isPlayer : false, character : "bf" })new(x:Float, y:Float, character:String = "bf", isPlayer:Bool = false, switchAnims:Bool = true)

Variables

@:value(new FlxPoint(0, 0))cameraOffset:FlxPoint = new FlxPoint(0, 0)

@:value("bf")curCharacter:String = "bf"

@:value(1)danceInterval:Int = 1

Interval at which the character will dance (higher number = slower dance)

@:value(true)danceOnBeat:Bool = true

Whenever the character should dance on beat or not. Set to false for gf, since the dance animation is automatically handled by PlayState.

@:value([])extra:Map<String, String> = []

@:value("bf-dead")gameOverCharacter:String = "bf-dead"

@:value(new FlxPoint(0, 0))globalOffset:FlxPoint = new FlxPoint(0, 0)

@:value(4)holdTime:Float = 4

@:value(null)icon:String = null

@:value(null)iconColor:Null<FlxColor> = null

@:value("")idleSuffix:String = ""

@:value(false)isGF:Bool = false

@:value(false)isPlayer:Bool = false

@:value(Math.NEGATIVE_INFINITY)lastHit:Float = Math.NEGATIVE_INFINITY

@:value(false)playerOffsets:Bool = false

@:value("bf")sprite:String = "bf"

@:value(false)stunned:Bool = false

xml:Access

Methods

applyXML(xml:Access):Void

buildXML(?animsOrder:Array<String>):Xml

dance():Void

FOR GF DANCING SHIT

@:value({ switchAnims : false })fixChar(switchAnims:Bool = false):Void

getAnimOrder():Array<String>

inlinegetCameraPosition():FlxPoint

inlinegetIcon():String

@:value({ Frame : 0, Reversed : false, Force : true, Context : SING, suffix : "" })playSingAnim(direction:Int, suffix:String = "", Context:PlayAnimContext = SING, Force:Bool = true, Reversed:Bool = false, Frame:Int = 0):Void

tryDance():Void

Inherited Variables

Defined by FunkinSprite

@:value([])animDatas:Map<String, AnimData> = []

@:value(new Map<String,FlxPoint>())animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

@:value([])beatAnims:Array<BeatAnim> = []

@:value(1)beatInterval:Int = 1

@:value(0)beatOffset:Int = 0

@:value(false)debugMode:Bool = false

@:value(1)initialZoom:Float = 1

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

name:String

@:value(false)skipNegativeBeats:Bool = false

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Inherited Methods

Defined by FunkinSprite

@:value({ y : 0, x : 0 })addOffset(name:String, x:Float = 0, y:Float = 0):Void

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnimation(AnimName:String):Bool

inlineisAnimFinished():Bool

@:value({ Key : null, Unique : false })loadSprite(path:String, Unique:Bool = false, ?Key:String):Void

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

inlineremoveAnimation(name:String):Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

\ No newline at end of file diff --git a/docs/funkin/game/CharacterShadowFrame.html b/docs/funkin/game/CharacterShadowFrame.html index 3357cfd..e9b3b72 100644 --- a/docs/funkin/game/CharacterShadowFrame.html +++ b/docs/funkin/game/CharacterShadowFrame.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

frame:FlxFrame

anim:String

\ No newline at end of file +

Fields

frame:FlxFrame

anim:String

\ No newline at end of file diff --git a/docs/funkin/game/ComboRating.html b/docs/funkin/game/ComboRating.html index 468b2d8..2bcf400 100644 --- a/docs/funkin/game/ComboRating.html +++ b/docs/funkin/game/ComboRating.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(percent:Float, rating:String, color:FlxColor)

Variables

color:FlxColor

percent:Float

rating:String

\ No newline at end of file +

Constructor

new(percent:Float, rating:String, color:FlxColor)

Variables

color:FlxColor

percent:Float

rating:String

\ No newline at end of file diff --git a/docs/funkin/game/GameOverSubstate.html b/docs/funkin/game/GameOverSubstate.html index 1a40f14..142c81c 100644 --- a/docs/funkin/game/GameOverSubstate.html +++ b/docs/funkin/game/GameOverSubstate.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ retrySFX : "gameOverEnd", lossSFX : "gameOverSFX", gameOverSong : "gameOver", player : true, character : "bf-dead" })new(x:Float, y:Float, character:String = "bf-dead", player:Bool = true, gameOverSong:String = "gameOver", lossSFX:String = "gameOverSFX", retrySFX:String = "gameOverEnd")

Variables

lossSFX:FlxSound

player:Bool

retrySFX:String

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

@:value("")staticscript:String = ""

Constructor

@:value({ retrySFX : "gameOverEnd", lossSFX : "gameOverSFX", gameOverSong : "gameOver", player : true, character : "bf-dead" })new(x:Float, y:Float, character:String = "bf-dead", player:Bool = true, gameOverSong:String = "gameOver", lossSFX:String = "gameOverSFX", retrySFX:String = "gameOverEnd")

Variables

@:value(PlayState.instance)game:PlayState = PlayState.instance

lossSFX:FlxSound

player:Bool

retrySFX:String

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/game/HealthIcon.html b/docs/funkin/game/HealthIcon.html index 77a1aa1..6e3b428 100644 --- a/docs/funkin/game/HealthIcon.html +++ b/docs/funkin/game/HealthIcon.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

Constructor

@:value({ isPlayer : false, char : "bf" })new(char:String = "bf", isPlayer:Bool = false)

Variables

@:value([0 => 1, 20 => 0])healthSteps:Map<Int, Int> = [0 => 1, 20 => 0]

Health steps in this format: -Min Percentage => Frame Index

sprTracker:FlxSprite

Used for FreeplayState! If you use it elsewhere, prob gonna annoying

Methods

setHealthSteps(steps:Array<Array<Int>>):Void

Helper for HScript who can't make maps

Parameters:

steps

Something like this: [[0, 1], [20, 0]]

\ No newline at end of file +Min Percentage => Frame Index

sprTracker:FlxSprite

Used for FreeplayState! If you use it elsewhere, prob gonna annoying

Methods

setHealthSteps(steps:Array<Array<Int>>):Void

Helper for HScript who can't make maps

Parameters:

steps

Something like this: [[0, 1], [20, 0]]

\ No newline at end of file diff --git a/docs/funkin/game/HudCamera.html b/docs/funkin/game/HudCamera.html index 3e52785..7a47cc2 100644 --- a/docs/funkin/game/HudCamera.html +++ b/docs/funkin/game/HudCamera.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?X:Int, ?Y:Int, ?Width:Int, ?Height:Int, ?Zoom:Float)

Variables

@:value(false)downscroll:Bool = false

Methods

\ No newline at end of file +

Constructor

new(?X:Int, ?Y:Int, ?Width:Int, ?Height:Int, ?Zoom:Float)

Variables

@:value(false)downscroll:Bool = false

Methods

\ No newline at end of file diff --git a/docs/funkin/game/Note.html b/docs/funkin/game/Note.html index 91bc182..aba2739 100644 --- a/docs/funkin/game/Note.html +++ b/docs/funkin/game/Note.html @@ -7,5 +7,5 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(160 * 0.7)staticswagWidth:Float = 160 * 0.7

Constructor

@:value({ sustainOffset : 0, sustainLength : 0, sustain : false })new(strumLine:StrumLine, noteData:ChartNote, sustain:Bool = false, sustainLength:Float = 0, sustainOffset:Float = 0, ?prev:Note)

Variables

@:value(true)angleOffsets:Bool = true

@:value(null)animSuffix:String = null

@:value(false)avoid:Bool = false

Whenever that note should be avoided by Botplay.

@:value(false)canBeHit:Bool = false

@:value(0.5)earlyPressWindow:Float = 0.5

@:value([])extra:Map<String, Dynamic> = []

@:value(true)flipSustain:Bool = true

@:value(false)isSustainNote:Bool = false

@:value(null)lastScrollSpeed:Null<Float> = null

@:value(1)latePressWindow:Float = 1

read onlymustPress:Bool

nextNote:Note

The note that comes after this one (sustain and not)

nextSustain:Note

The next sustain after this one

@:value(null)noteAngle:Null<Float> = null

@:value(0)noteData:Int = 0

read onlynoteType:String

@:value(0)noteTypeID:Int = 0

prevNote:Note

The note that comes before this one (sustain and not)

@:value(null)scrollSpeed:Null<Float> = null

@:value("default")splash:String = "default"

Name of the splash.

read onlystrumID:Int

@:value(true)strumRelativePos:Bool = true

Whenever the position of the note should be relative to the strum position or not. -For example, if this is true, a note at the position 0; 0 will be on the strum, instead of at the top left of the screen.

@:value(0)strumTime:Float = 0

@:value(0)sustainLength:Float = 0

@:value(false)tooLate:Bool = false

@:value(false)useAntialiasingFix:Bool = false

@:value(false)wasGoodHit:Bool = false

Methods

setClipRect(rect:FlxRect):Void

updateSustain(strum:Strum):Void

\ No newline at end of file +

Static variables

@:value(160 * 0.7)staticswagWidth:Float = 160 * 0.7

Constructor

@:value({ sustainOffset : 0, sustainLength : 0, sustain : false })new(strumLine:StrumLine, noteData:ChartNote, sustain:Bool = false, sustainLength:Float = 0, sustainOffset:Float = 0, ?prev:Note)

Variables

@:value(true)angleOffsets:Bool = true

@:value(null)animSuffix:String = null

@:value(false)avoid:Bool = false

Whenever that note should be avoided by Botplay.

@:value(false)canBeHit:Bool = false

@:value(0.5)earlyPressWindow:Float = 0.5

@:value([])extra:Map<String, Dynamic> = []

@:value(true)flipSustain:Bool = true

@:value(0)gapFix:Single = 0

@:value(false)isSustainNote:Bool = false

@:value(null)lastScrollSpeed:Null<Float> = null

@:value(1)latePressWindow:Float = 1

read onlymustPress:Bool

nextNote:Note

The note that comes after this one (sustain and not)

nextSustain:Note

The next sustain after this one

@:value(null)noteAngle:Null<Float> = null

@:value(0)noteData:Int = 0

read onlynoteType:String

@:value(0)noteTypeID:Int = 0

prevNote:Note

The note that comes before this one (sustain and not)

@:value(null)scrollSpeed:Null<Float> = null

@:value("default")splash:String = "default"

Name of the splash.

read onlystrumID:Int

@:value(true)strumRelativePos:Bool = true

Whenever the position of the note should be relative to the strum position or not. +For example, if this is true, a note at the position 0; 0 will be on the strum, instead of at the top left of the screen.

@:value(0)strumTime:Float = 0

@:value(0)sustainLength:Float = 0

@:value(false)tooLate:Bool = false

@:value(false)wasGoodHit:Bool = false

Methods

setClipRect(rect:FlxRect):Void

updateSustain(strum:Strum):Void

\ No newline at end of file diff --git a/docs/funkin/game/NoteGroup.html b/docs/funkin/game/NoteGroup.html index 1067ab6..d64ac89 100644 --- a/docs/funkin/game/NoteGroup.html +++ b/docs/funkin/game/NoteGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?MaxSize:Int)

Variables

@:value(1500)limit:Float = 1500

How many ms it should show a note before it should be hit

Methods

inlineaddNotes(notes:Array<Note>):Void

inlinepreallocate(len:Int):Void

Preallocates the members array with nulls, but if theres anything in the array already it clears it

inlinesortNotes():Void

\ No newline at end of file +

Constructor

new(?MaxSize:Int)

Variables

@:value(1500)limit:Float = 1500

How many ms it should show a note before it should be hit

Methods

inlineaddNotes(notes:Array<Note>):Void

get(id:Int):Note

Gets the correct order of notes

inlinepreallocate(len:Int):Void

Preallocates the members array with nulls, but if theres anything in the array already it clears it

inlinesortNotes():Void

\ No newline at end of file diff --git a/docs/funkin/game/PlayState.html b/docs/funkin/game/PlayState.html index 41d3078..9ff2469 100644 --- a/docs/funkin/game/PlayState.html +++ b/docs/funkin/game/PlayState.html @@ -7,8 +7,8 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

staticSONG:ChartData

SONG DATA (Chart, Metadata)

staticread onlycampaignAccuracy:Float

Accuracy for the current week

@:value(0)staticcampaignAccuracyCount:Float = 0

@:value(0)staticcampaignAccuracyTotal:Float = 0

@:value(0)staticcampaignMisses:Int = 0

Misses for the current week.

@:value(0)staticcampaignScore:Int = 0

Score for the current week.

@:value(false)staticchartingMode:Bool = false

Whenever Charting Mode has been enabled for this song.

@:value(false)staticcoopMode:Bool = false

// * Whenever the song has been started with co-op mode on.

@:value(6)staticdaPixelZoom:Float = 6

Zoom for the pixel assets.

@:value("normal")staticdifficulty:String = "normal"

The selected difficulty name

@:value(false)staticfromMods:Bool = false

Whenever the week is coming from the mods folder or not.

@:value(null)staticinstance:PlayState = null

Current PlayState instance.

@:value(false)staticisStoryMode:Bool = false

Whenever the song is being played in Story Mode.

@:value(false)staticopponentMode:Bool = false

Whenever the song has been started with opponent mode on.

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

The remaining songs in the Story Mode playlist.

@:value(null)staticstoryWeek:WeekData = null

The week data of the current week

Static methods

static__loadSong(name:String, difficulty:String):Void

(INTERNAL) Loads a song without resetting story mode/opponent mode/coop mode values.

Parameters:

name

Song name

difficulty

Song difficulty

@:value({ coopMode : false, opponentMode : false, difficulty : "normal" })staticloadSong(name:String, difficulty:String = "normal", opponentMode:Bool = false, coopMode:Bool = false):Void

Loads a song into PlayState

Parameters:

name

Song name

difficulty

Chart difficulty (if invalid, will load an empty chart)

opponentMode

Whenever opponent mode is on

coopMode

Whenever co-op mode is on.

@:value({ difficulty : "normal" })staticloadWeek(weekData:WeekData, difficulty:String = "normal"):Void

Load a week into PlayState.

Parameters:

weekData

Week Data

difficulty

Week Difficulty

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(new FlxTextFormat(0xFF888888, false, false, 0))accFormat:FlxTextFormat = new FlxTextFormat(0xFF888888, false, false, 0)

Format for the accuracy rating.

accuracy:Float

The player's accuracy (shortcut to accuracyPressedNotes / totalAccuracyAmount).

@:value(0)accuracyPressedNotes:Float = 0

The number of pressed notes.

accuracyTxt:FunkinText

FunkinText that shows your accuracy.

boyfriend:Character

Boyfriend character

camFollow:FlxObject

Object defining the camera follow target.

camGame:FlxCamera

Camera for the game (stages, characters)

camHUD:HudCamera

Camera for the HUD (notes, misses).

@:value(false)camZooming:Bool = false

Whenever cam zooming is enabled, enables on a note hit if not cancelled.

@:value(4)camZoomingInterval:Int = 4

Interval of cam zooming (beats). +

Static variables

staticSONG:ChartData

SONG DATA (Chart, Metadata)

staticread onlycampaignAccuracy:Float

Accuracy for the current week

@:value(0)staticcampaignAccuracyCount:Float = 0

@:value(0)staticcampaignAccuracyTotal:Float = 0

@:value(0)staticcampaignMisses:Int = 0

Misses for the current week.

@:value(0)staticcampaignScore:Int = 0

Score for the current week.

@:value(false)staticchartingMode:Bool = false

Whenever Charting Mode has been enabled for this song.

@:value(false)staticcoopMode:Bool = false

Whenever the song has been started with co-op mode on.

@:value(6)staticdaPixelZoom:Float = 6

Zoom for the pixel assets.

@:value(0)staticdeathCounter:Int = 0

Death counter on current week (or song if from freeplay).

@:value("normal")staticdifficulty:String = "normal"

The selected difficulty name

@:value(false)staticfromMods:Bool = false

Whenever the week is coming from the mods folder or not.

@:value(null)staticinstance:PlayState = null

Current PlayState instance.

@:value(false)staticisStoryMode:Bool = false

Whenever the song is being played in Story Mode.

@:value(false)staticopponentMode:Bool = false

Whenever the song has been started with opponent mode on.

@:value(false)staticseenCutscene:Bool = false

Whenever the game has already played a specific cutscene for the current song. Check startCutscene for more details.

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

The remaining songs in the Story Mode playlist.

@:value(null)staticstoryWeek:WeekData = null

The week data of the current week

Static methods

static__loadSong(name:String, difficulty:String):Void

(INTERNAL) Loads a song without resetting story mode/opponent mode/coop mode values.

Parameters:

name

Song name

difficulty

Song difficulty

@:value({ coopMode : false, opponentMode : false, difficulty : "normal" })staticloadSong(name:String, difficulty:String = "normal", opponentMode:Bool = false, coopMode:Bool = false):Void

Loads a song into PlayState

Parameters:

name

Song name

difficulty

Chart difficulty (if invalid, will load an empty chart)

opponentMode

Whenever opponent mode is on

coopMode

Whenever co-op mode is on.

@:value({ difficulty : "normal" })staticloadWeek(weekData:WeekData, difficulty:String = "normal"):Void

Load a week into PlayState.

Parameters:

weekData

Week Data

difficulty

Week Difficulty

staticresetSongInfos():Void

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(new FlxTextFormat(0xFF888888, false, false, 0))accFormat:FlxTextFormat = new FlxTextFormat(0xFF888888, false, false, 0)

Format for the accuracy rating.

accuracy:Float

The player's accuracy (shortcut to accuracyPressedNotes / totalAccuracyAmount).

@:value(0)accuracyPressedNotes:Float = 0

The number of pressed notes.

accuracyTxt:FunkinText

FunkinText that shows your accuracy.

@:value(true)allowGitaroo:Bool = true

Wether or not to show the secret gitaroo pause.

boyfriend:Character

Boyfriend character

camFollow:FlxObject

Object defining the camera follow target.

camGame:FlxCamera

Camera for the game (stages, characters)

camHUD:HudCamera

Camera for the HUD (notes, misses).

@:value(false)camZooming:Bool = false

Whenever cam zooming is enabled, enables on a note hit if not cancelled.

@:value(4)camZoomingInterval:Int = 4

Interval of cam zooming (beats). For example: if set to 4, the camera will zoom every 4 beats.

@:value(1)camZoomingStrength:Float = 1

How strong the cam zooms should be (defaults to 1)

@:value(true)canAccessDebugMenus:Bool = true

Whenever the player can press 7, 8 or 9 to access the debug menus.

@:value(opponentMode && !coopMode)canDadDie:Bool = opponentMode && !coopMode

Whenever the opponent can die.

@:value(!opponentMode && !coopMode)canDie:Bool = !opponentMode && !coopMode

Whenever the player can die.

@:value(true)canPause:Bool = true

Whenever the game can be paused or not.

@:value(0)combo:Int = 0

Current combo.

@:value(!Options.ghostTapping)comboBreaks:Bool = !Options.ghostTapping

Whenever the misses should show "Combo Breaks" instead of "Misses"

comboGroup:RotatingSpriteGroup

Group containing all of the combo sprites.

@:value([new ComboRating(0, "F", 0xFFFF4444), new ComboRating(0.5, "E", 0xFFFF8844), new ComboRating(0.7, "D", 0xFFFFAA44), new ComboRating(0.8, "C", 0xFFFFFF44), new ComboRating(0.85, "B", 0xFFAAFF44), new ComboRating(0.9, "A", 0xFF88FF44), new ComboRating(0.95, "S", 0xFF44FFFF), new ComboRating(1, "S++", 0xFF44FFFF)])comboRatings:Array<ComboRating> = [new ComboRating(0, "F", 0xFFFF4444), new ComboRating(0.5, "E", 0xFFFF8844), new ComboRating(0.7, "D", 0xFFFFAA44), new ComboRating(0.8, "C", 0xFFFFFF44), new ComboRating(0.85, "B", 0xFFAAFF44), new ComboRating(0.9, "A", 0xFF88FF44), new ComboRating(0.95, "S", 0xFF44FFFF), new ComboRating(1, "S++", 0xFF44FFFF)]

All combo ratings.

cpu:StrumLine

Shortcut to cpuStrums.

read onlycpuStrums:StrumLine

CPU strums.

@:value(0)curCameraTarget:Int = 0

Current camera target. -1 means no automatic camera targetting.

curRating:ComboRating

Last rating (may be null)

@:value("")curSong:String = ""

Current song name (lowercase)

@:value("")curStage:String = ""

Current stage name

@:value(null)cutscene:String = null

Cutscene script path.

dad:Character

Dad character

@:value(1.05)defaultCamZoom:Float = 1.05

Camera zoom at which the game lerps to.

@:value(1.0)defaultHudZoom:Float = 1.0

Camera zoom at which the hud lerps to.

@:value("")detailsPausedText:String = ""

@:value("")detailsText:String = ""

downscroll:Bool

Whenever the game is in downscroll or not. (Can be set)

@:value(null)endCutscene:String = null

End cutscene script path.

@:value(false)endingSong:Bool = false

Whenever the song is ending or not.

@:value([])events:Array<ChartEvent> = []

Remaining events

@:value("gameOver")gameOverSong:String = "gameOver"

Game Over Song. (assets/music/gameOver.ogg)

@:value(false)generatedMusic:Bool = false

Whenever the music has been generated.

gf:Character

Girlfriend character

gfSpeed:Int

Interval at which Girlfriend dances.

@:value(Options.ghostTapping)ghostTapping:Bool = Options.ghostTapping

Whenever Ghost Tapping is enabled.

@:value(1)health:Float = 1

Current health. Goes from 0 to maxHealth (defaults to 2)

healthBar:FlxBar

Health bar.

healthBarBG:FlxSprite

Health bar background.

@:value(Options.hitWindow)hitWindow:Float = Options.hitWindow

Hit window, in milliseconds. Defaults to 250ms unless changed in options. Base game hit window is 175ms.

iconP1:HealthIcon

Player's icon

iconP2:HealthIcon

Opponent's icon

@:value(false)inCutscene:Bool = false

Whenever the game is currently in a cutscene or not.

inst:FlxSound

Instrumental sound (Inst.ogg).

@:value(5)introLength:Int = 5

Length of the intro countdown.

@:value(["intro3", "intro2", "intro1", "introGo"])introSounds:Array<String> = ["intro3", "intro2", "intro1", "introGo"]

Array of sounds for the intro.

@:value([null, "game/ready", "game/set", "game/go"])introSprites:Array<String> = [null, "game/ready", "game/set", "game/go"]

Array of sprites for the intro.

@:value("gameOverSFX")lossSFX:String = "gameOverSFX"

Game Over Song. (assets/sounds/gameOverSFX.ogg)

@:value(1.35)maxCamZoom:Float = 1.35

Maximum amount of zoom for the camera.

@:value(2)@:isVarmaxHealth:Float = 2

Maximum health the player can have. Defaults to 2.

@:value(0)misses:Int = 0

The player's amount of misses.

missesTxt:FunkinText

FunkinText that shows your amount of misses.

@:value(true)muteVocalsOnMiss:Bool = true

Whenever the vocals should be muted when a note is missed.

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

Array containing all of the note types names.

@:value(false)paused:Bool = false

Whenever the game is paused or not.

@:value(isStoryMode)playCutscenes:Bool = isStoryMode

Whenever the game should play the cutscenes. Defaults to whenever the game is currently in Story Mode or not.

player:StrumLine

Shortcut to playerStrums.

read onlyplayerStrums:StrumLine

Player strums.

@:value(0)ratingNum:Int = 0

Number of ratings.

@:value("gameOverEnd")retrySFX:String = "gameOverEnd"

Game Over End SFX, used when retrying. (assets/sounds/gameOverEnd.ogg)

scoreTxt:FunkinText

FunkinText that shows your score.

scripts:ScriptPack

Script Pack of all the scripts being ran.

@:value(0)scrollSpeed:Float = 0

Current scroll speed for all strums. -To set a scroll speed for a specific strum, use strum.scrollSpeed.

@:value(0)songScore:Int = 0

The player's current score.

splashHandler:SplashHandler

Note splashes container

stage:Stage

Current Stage.

startTimer:FlxTimer

Timer for the start countdown

@:value(false)startedCountdown:Bool = false

Whenever the countdown has started or not.

@:value(false)startingSong:Bool = false

Whenever the song is currently being started.

strumLine:FlxObject

Strum line position

@:value(new FlxTypedGroup<StrumLine>())strumLines:FlxTypedGroup<StrumLine> = new FlxTypedGroup<StrumLine>()

Array of all the players in the stage.

@:value(0)totalAccuracyAmount:Float = 0

The total accuracy amount.

@:value(true)validScore:Bool = true

Whenever the score will save when you beat the song.

vocals:FlxSound

Vocals sound (Vocals.ogg).

Methods

addScript(file:String):Void

countdown(swagCounter:Int):Void

Creates a fake countdown.

inlinedeleteNote(note:Note):Void

@:value({ evt : null })displayCombo(?evt:NoteHitEvent):Void

@:value({ evt : null })displayRating(myRating:String, ?evt:NoteHitEvent):Void

endSong():Void

Ends the song.

gameOver(?character:Character, ?deathCharID:String, ?gameOverSong:String, ?lossSFX:String, ?retrySFX:String):Void

Forces a game over.

Parameters:

character

Character which died. Default to boyfriend.

deathCharID

Character ID (name) for game over. Default to whatever is specified in the character's XML.

gameOverSong

Song for the game over screen. Default to this.gameOverSong (gameOver)

lossSFX

SFX at the beginning of the game over (Mic drop). Default to this.lossSFX (gameOverSFX)

retrySFX

SFX played whenever the player retries. Defaults to retrySFX (gameOverEnd)

inlinegetIconRPC():String

Returns the Discord RPC icon.

goodNoteHit(strumLine:StrumLine, note:Note):Void

Hits a note

Parameters:

note

Note to hit.

nextSong():Void

Immediately switches to the next song, or goes back to the Story/Freeplay menu.

noteMiss(strumLine:StrumLine, note:Note, ?direction:Int, ?player:Int):Void

Misses a note

Parameters:

strumLine

The strumline the miss happened on.

note

Note to miss.

direction

Specify a custom direction in case note is null.

player

Specify a custom player in case note is null.

pauseGame():Void

Pauses the game.

@:value({ prefix : "" })startCutscene(prefix:String = "", ?cutsceneScriptPath:String, ?callback:() ‑> Void):Void

Starts a cutscene.

Parameters:

prefix

Custom prefix. Using midsong- will require you to for example rename your video cutscene to songs/song/midsong-cutscene.mp4 instead of songs/song/cutscene.mp4

cutsceneScriptPath

Optional: Custom script path.

callback

Callback called after the cutscene ended. If equals to null, startCountdown will be called.

dynamicupdateDiscordPresence():Void

Function used to update Discord Presence. -This function is dynamic, which means you can do updateDiscordPresence = function() {} in scripts.

updateRating():Void

Updates the rating.

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +To set a scroll speed for a specific strum, use strum.scrollSpeed.

@:value(null)scrollSpeedTween:FlxTween = null

@:value(0)songScore:Int = 0

The player's current score.

splashHandler:SplashHandler

Note splashes container

stage:Stage

Current Stage.

startTimer:FlxTimer

Timer for the start countdown

@:value(false)startedCountdown:Bool = false

Whenever the countdown has started or not.

@:value(false)startingSong:Bool = false

Whenever the song is currently being started.

strumLine:FlxObject

Strum line position

@:value(new FlxTypedGroup<StrumLine>())strumLines:FlxTypedGroup<StrumLine> = new FlxTypedGroup<StrumLine>()

Array of all the players in the stage.

@:value(0)totalAccuracyAmount:Float = 0

The total accuracy amount.

@:value(true)validScore:Bool = true

Whenever the score will save when you beat the song.

vocals:FlxSound

Vocals sound (Vocals.ogg).

Methods

addScript(file:String):Void

countdown(swagCounter:Int):Void

Creates a fake countdown.

inlinedeleteNote(note:Note):Void

@:value({ evt : null })displayCombo(?evt:NoteHitEvent):Void

@:value({ evt : null })displayRating(myRating:String, ?evt:NoteHitEvent):Void

endSong():Void

Ends the song.

gameOver(?character:Character, ?deathCharID:String, ?gameOverSong:String, ?lossSFX:String, ?retrySFX:String):Void

Forces a game over.

Parameters:

character

Character which died. Default to boyfriend.

deathCharID

Character ID (name) for game over. Default to whatever is specified in the character's XML.

gameOverSong

Song for the game over screen. Default to this.gameOverSong (gameOver)

lossSFX

SFX at the beginning of the game over (Mic drop). Default to this.lossSFX (gameOverSFX)

retrySFX

SFX played whenever the player retries. Defaults to retrySFX (gameOverEnd)

inlinegetIconRPC():String

Returns the Discord RPC icon.

goodNoteHit(strumLine:StrumLine, note:Note):Void

Hits a note

Parameters:

note

Note to hit.

nextSong():Void

Immediately switches to the next song, or goes back to the Story/Freeplay menu.

noteMiss(strumLine:StrumLine, note:Note, ?direction:Int, ?player:Int):Void

Misses a note

Parameters:

strumLine

The strumline the miss happened on.

note

Note to miss.

direction

Specify a custom direction in case note is null.

player

Specify a custom player in case note is null.

pauseGame():Void

Pauses the game.

@:value({ closingWindow : true })saveWarn(closingWindow:Bool = true):Void

@:value({ checkSeen : false, prefix : "" })startCutscene(prefix:String = "", ?cutsceneScriptPath:String, ?callback:() ‑> Void, checkSeen:Bool = false):Void

Starts a cutscene.

Parameters:

prefix

Custom prefix. Using midsong- will require you to for example rename your video cutscene to songs/song/midsong-cutscene.mp4 instead of songs/song/cutscene.mp4

cutsceneScriptPath

Optional: Custom script path.

callback

Callback called after the cutscene ended. If equals to null, startCountdown will be called.

checkSeen

Bool that by default is false, if true and seenCutscene is also true, it won't play the cutscene but directly call callback (PS: seenCutscene becomes true if the cutscene gets played and checkSeen was true)

dynamicupdateDiscordPresence():Void

Function used to update Discord Presence. +This function is dynamic, which means you can do updateDiscordPresence = function() {} in scripts.

updateRating():Void

Updates the rating.

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/game/PlayStateTransitionData.html b/docs/funkin/game/PlayStateTransitionData.html index 3560a53..b380f19 100644 --- a/docs/funkin/game/PlayStateTransitionData.html +++ b/docs/funkin/game/PlayStateTransitionData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

stage:String

camZoom:Float

camY:Float

camX:Float

\ No newline at end of file +

Fields

stage:String

camZoom:Float

camY:Float

camX:Float

\ No newline at end of file diff --git a/docs/funkin/game/SplashGroup.html b/docs/funkin/game/SplashGroup.html index 4898a01..708b1a5 100644 --- a/docs/funkin/game/SplashGroup.html +++ b/docs/funkin/game/SplashGroup.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

Constructor

new(path:String)

Creates a new Splash group

Parameters:

path

Path to the splash data (xml)

Variables

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

Animation names sorted by strum IDs. -Use getSplashAnim to get one.

@:value(true)valid:Bool = true

Whenever the splash group has successfully loaded or not.

xml:Access

XML data for the note splashes.

Methods

\ No newline at end of file +Use getSplashAnim to get one.

@:value(true)valid:Bool = true

Whenever the splash group has successfully loaded or not.

xml:Access

XML data for the note splashes.

Methods

getSplashAnim(id:Int):String

showOnStrum(strum:Strum):FunkinSprite

\ No newline at end of file diff --git a/docs/funkin/game/SplashHandler.html b/docs/funkin/game/SplashHandler.html index 6073461..0fc1c9f 100644 --- a/docs/funkin/game/SplashHandler.html +++ b/docs/funkin/game/SplashHandler.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

@:value([])grpMap:Map<String, SplashGroup> = []

Map containing all of the splashes group.

Methods

getSplashGroup(name:String):Null<SplashGroup>

Returns a group of splashes, and creates it if it doesn't exist.

Parameters:

path

Path to the splashes XML (Paths.xml('splashes/splash'))

showSplash(name:String, strum:Strum):Void

\ No newline at end of file +

Constructor

new()

Variables

@:value([])grpMap:Map<String, SplashGroup> = []

Map containing all of the splashes group.

Methods

getSplashGroup(name:String):Null<SplashGroup>

Returns a group of splashes, and creates it if it doesn't exist.

Parameters:

path

Path to the splashes XML (Paths.xml('splashes/splash'))

showSplash(name:String, strum:Strum):Void

\ No newline at end of file diff --git a/docs/funkin/game/Stage.html b/docs/funkin/game/Stage.html index 0f25658..7eaa264 100644 --- a/docs/funkin/game/Stage.html +++ b/docs/funkin/game/Stage.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

@:value({ mods : false })staticgetList(mods:Bool = false):Array<String>

Constructor

new(stage:String, ?state:FlxState)

Variables

@:value([])characterPoses:Map<String, StageCharPos> = []

stagePath:String

@:value([])stageSprites:Map<String, FlxSprite> = []

stageXML:Access

state:FlxState

Methods

addCharPos(name:String, node:Access, ?nonXMLInfo:StageCharPosInfo):StageCharPos

@:value({ id : 0 })applyCharStuff(char:Character, posName:String, id:Float = 0):Void

beatHit(curBeat:Int):Void

getSprite(name:String):Null<FlxSprite>

@:value({ def : false })inlineisCharFlipped(posName:String, def:Bool = false):Bool

measureHit(curMeasure:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file +

Static methods

@:value({ mods : false })staticgetList(mods:Bool = false):Array<String>

Constructor

new(stage:String, ?state:FlxState)

Variables

@:value([])characterPoses:Map<String, StageCharPos> = []

stagePath:String

@:value([])stageSprites:Map<String, FlxSprite> = []

stageXML:Access

state:FlxState

Methods

addCharPos(name:String, node:Access, ?nonXMLInfo:StageCharPosInfo):StageCharPos

@:value({ id : 0 })applyCharStuff(char:Character, posName:String, id:Float = 0):Void

beatHit(curBeat:Int):Void

getSprite(name:String):Null<FlxSprite>

@:value({ def : false })inlineisCharFlipped(posName:String, def:Bool = false):Bool

measureHit(curMeasure:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file diff --git a/docs/funkin/game/StageCharPos.html b/docs/funkin/game/StageCharPos.html index 7faa8ba..56eb532 100644 --- a/docs/funkin/game/StageCharPos.html +++ b/docs/funkin/game/StageCharPos.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

@:value(1)alpha:Float = 1

@:value(0)camxoffset:Float = 0

@:value(0)camyoffset:Float = 0

@:value(20)charSpacingX:Float = 20

@:value(0)charSpacingY:Float = 0

@:value(false)flipX:Bool = false

@:value(FlxPoint.get(1, 1))scale:FlxPoint = FlxPoint.get(1, 1)

@:value(0)skewX:Float = 0

@:value(0)skewY:Float = 0

Methods

@:value({ id : 0 })prepareCharacter(char:Character, id:Float = 0):Void

\ No newline at end of file +

Constructor

new()

Variables

@:value(1)alpha:Float = 1

@:value(0)camxoffset:Float = 0

@:value(0)camyoffset:Float = 0

@:value(20)charSpacingX:Float = 20

@:value(0)charSpacingY:Float = 0

@:value(false)flipX:Bool = false

@:value(FlxPoint.get(1, 1))scale:FlxPoint = FlxPoint.get(1, 1)

@:value(0)skewX:Float = 0

@:value(0)skewY:Float = 0

Methods

@:value({ id : 0 })prepareCharacter(char:Character, id:Float = 0):Void

\ No newline at end of file diff --git a/docs/funkin/game/StageCharPosInfo.html b/docs/funkin/game/StageCharPosInfo.html index 1f7397e..8a3d330 100644 --- a/docs/funkin/game/StageCharPosInfo.html +++ b/docs/funkin/game/StageCharPosInfo.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

y:Float

x:Float

scroll:Float

flip:Bool

\ No newline at end of file +

Fields

y:Float

x:Float

scroll:Float

flip:Bool

\ No newline at end of file diff --git a/docs/funkin/game/Strum.html b/docs/funkin/game/Strum.html index 8002419..eda2339 100644 --- a/docs/funkin/game/Strum.html +++ b/docs/funkin/game/Strum.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

@:value("")animSuffix:String = ""

Which animation suffix on characters that should be used when hitting notes.

@:value(false)cpu:Bool = false

@:value([])extra:Map<String, Dynamic> = []

@:value([])read onlylastDrawCameras:Array<FlxCamera> = []

@:value(-5000)lastHit:Float = -5000

@:value(null)noteAngle:Null<Float> = null

@:value(null)scrollSpeed:Null<Float> = null

@:value(null)getJustPressed:StrumLine ‑> Bool = null

@:value(null)getJustReleased:StrumLine ‑> Bool = null

@:value(null)getPressed:StrumLine ‑> Bool = null

Methods

inline__getJustPressed(strumLine:StrumLine):Bool

inline__getJustReleased(strumLine:StrumLine):Bool

inline__getPressed(strumLine:StrumLine):Bool

getAnim():Null<String>

inlinegetNotesAngle(?note:Note):Float

inlinegetScrollSpeed(?note:Note):Float

@:value({ force : true })playAnim(anim:String, force:Bool = true):Void

inlinepress(time:Float):Void

updatePlayerInput(pressed:Bool, justPressed:Bool, justReleased:Bool):Void

inlineupdateSustain(daNote:Note):Void

\ No newline at end of file +

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

@:value("")animSuffix:String = ""

Which animation suffix on characters that should be used when hitting notes.

@:value(false)cpu:Bool = false

@:value([])extra:Map<String, Dynamic> = []

@:value([])read onlylastDrawCameras:Array<FlxCamera> = []

@:value(-5000)lastHit:Float = -5000

@:value(null)noteAngle:Null<Float> = null

@:value(null)scrollSpeed:Null<Float> = null

@:value(null)getJustPressed:StrumLine ‑> Bool = null

@:value(null)getJustReleased:StrumLine ‑> Bool = null

@:value(null)getPressed:StrumLine ‑> Bool = null

Methods

inline__getJustPressed(strumLine:StrumLine):Bool

inline__getJustReleased(strumLine:StrumLine):Bool

inline__getPressed(strumLine:StrumLine):Bool

getAnim():String

inlinegetNotesAngle(?note:Note):Float

inlinegetScrollSpeed(?note:Note):Float

@:value({ force : true })playAnim(anim:String, force:Bool = true):Void

inlinepress(time:Float):Void

updatePlayerInput(pressed:Bool, justPressed:Bool, justReleased:Bool):Void

inlineupdateSustain(daNote:Note):Void

\ No newline at end of file diff --git a/docs/funkin/game/StrumLine.html b/docs/funkin/game/StrumLine.html index a6ff88a..72bae17 100644 --- a/docs/funkin/game/StrumLine.html +++ b/docs/funkin/game/StrumLine.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ opponentSide : true, cpu : false })new(characters:Array<Character>, startingPos:FlxPoint, strumScale:Float, cpu:Bool = false, opponentSide:Bool = true, ?controls:Controls)

Variables

altAnim:Bool

Whenever alt animation is enabled on this strumline.

@:value("")animSuffix:String = ""

Which animation suffix on characters that should be used when hitting notes.

characters:Array<Character>

Array containing all of the characters "attached" to those strums.

@:value(null)controls:Controls = null

Controls assigned to this strumline.

@:value(false)cpu:Bool = false

Whenever this strumline is controlled by cpu or not.

@:value(null)data:ChartStrumLine = null

Chart JSON data assigned to this StrumLine (Codename format)

@:value([])extra:Map<String, Dynamic> = []

@:value(null)@:isVarghostTapping:Null<Bool> = null

Whenever Ghost Tapping is enabled.

notes:NoteGroup

Group of all of the notes in this strumline. Using forEach on this group will only loop through the first notes for performance reasons.

@:value(new FlxTypedSignal<NoteHitEvent>())onHit:FlxTypedSignal<NoteHitEvent ‑> Void> = new FlxTypedSignal<NoteHitEvent>()

Signal that triggers whenever a note is hit. Similar to onPlayerHit and onDadHit, except strumline specific. +

Constructor

@:value({ vocalPrefix : "", opponentSide : true, cpu : false })new(characters:Array<Character>, startingPos:FlxPoint, strumScale:Float, cpu:Bool = false, opponentSide:Bool = true, ?controls:Controls, vocalPrefix:String = "")

Variables

altAnim:Bool

Whenever alt animation is enabled on this strumline.

@:value("")animSuffix:String = ""

Which animation suffix on characters that should be used when hitting notes.

characters:Array<Character>

Array containing all of the characters "attached" to those strums.

@:value(null)controls:Controls = null

Controls assigned to this strumline.

@:value(false)cpu:Bool = false

Whenever this strumline is controlled by cpu or not.

@:value(null)data:ChartStrumLine = null

Chart JSON data assigned to this StrumLine (Codename format)

@:value([])extra:Map<String, Dynamic> = []

@:value(null)@:isVarghostTapping:Null<Bool> = null

Whenever Ghost Tapping is enabled.

notes:NoteGroup

Group of all of the notes in this strumline. Using forEach on this group will only loop through the first notes for performance reasons.

@:value(new FlxTypedSignal<NoteHitEvent>())onHit:FlxTypedSignal<NoteHitEvent ‑> Void> = new FlxTypedSignal<NoteHitEvent>()

Signal that triggers whenever a note is hit. Similar to onPlayerHit and onDadHit, except strumline specific. To add a listener, do strumLine.onHit.add(function(e:NoteHitEvent) {});

@:value(new FlxTypedSignal<NoteMissEvent>())onMiss:FlxTypedSignal<NoteMissEvent ‑> Void> = new FlxTypedSignal<NoteMissEvent>()

Signal that triggers whenever a note is missed. Similar to onPlayerMiss, except strumline specific. To add a listener, do @@ -15,4 +15,4 @@ To add a listener, do strumLine.onNoteUpdate.add(function(e:NoteUpdateEvent) {});

@:value(new FlxTypedSignal<NoteUpdateEvent>())onNoteUpdate:FlxTypedSignal<NoteUpdateEvent ‑> Void> = new FlxTypedSignal<NoteUpdateEvent>()

Signal that triggers whenever a note is being updated. Similar to onNoteUpdate, except strumline specific. To add a listener, do -strumLine.onNoteUpdate.add(function(e:NoteUpdateEvent) {});

@:value(false)opponentSide:Bool = false

Whenever this strumline is from the opponent side or the player side.

@:value(["left", "down", "up", "right"])strumAnimPrefix:Array<String> = ["left", "down", "up", "right"]

TODO: Write documention about this being a variable that can help when making multi key

Methods

inlineaddHealth(health:Float):Void

createStrum(i:Int, ?animPrefix:String):Strum

Creates a strum and returns the created strum (needs to be added manually).

Parameters:

i

Index of the strum

animPrefix

(Optional) Animation prefix (left = arrowLEFT, left press, left confirm).

deleteNote(note:Note):Void

Deletes a note from this strumline.

Parameters:

note

Note to delete

generate(strumLine:ChartStrumLine, ?startTime:Float):Void

@:value({ amount : 4 })inlinegenerateStrums(amount:Int = 4):Void

@:value({ id : 0 })updateInput(id:Int = 0):Void

updateNote(daNote:Note):Void

inlineupdateNotes():Void

\ No newline at end of file +strumLine.onNoteUpdate.add(function(e:NoteUpdateEvent) {});

@:value(false)opponentSide:Bool = false

Whenever this strumline is from the opponent side or the player side.

@:value(["left", "down", "up", "right"])strumAnimPrefix:Array<String> = ["left", "down", "up", "right"]

TODO: Write documention about this being a variable that can help when making multi key

vocals:FlxSound

Vocals sound (Vocals.ogg). Used for individual vocals per strumline.

Methods

inlineaddHealth(health:Float):Void

createStrum(i:Int, ?animPrefix:String):Strum

Creates a strum and returns the created strum (needs to be added manually).

Parameters:

i

Index of the strum

animPrefix

(Optional) Animation prefix (left = arrowLEFT, left press, left confirm).

deleteNote(note:Note):Void

Deletes a note from this strumline.

Parameters:

note

Note to delete

generate(strumLine:ChartStrumLine, ?startTime:Float):Void

@:value({ amount : 4 })inlinegenerateStrums(amount:Int = 4):Void

@:value({ id : 0 })updateInput(id:Int = 0):Void

updateNote(daNote:Note):Void

inlineupdateNotes():Void

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/Cutscene.html b/docs/funkin/game/cutscenes/Cutscene.html index 52b1e9e..961c9dd 100644 --- a/docs/funkin/game/cutscenes/Cutscene.html +++ b/docs/funkin/game/cutscenes/Cutscene.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Substate made for cutscenes.

Constructor

new(callback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Substate made for cutscenes.

Constructor

new(callback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/CutsceneSubtitle.html b/docs/funkin/game/cutscenes/CutsceneSubtitle.html index b10d639..5670f3c 100644 --- a/docs/funkin/game/cutscenes/CutsceneSubtitle.html +++ b/docs/funkin/game/cutscenes/CutsceneSubtitle.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

time:Float

subtitle:String

color:FlxColor

\ No newline at end of file +

Fields

time:Float

subtitle:String

color:FlxColor

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/DialogueCutscene.html b/docs/funkin/game/cutscenes/DialogueCutscene.html index 8d76335..89a8337 100644 --- a/docs/funkin/game/cutscenes/DialogueCutscene.html +++ b/docs/funkin/game/cutscenes/DialogueCutscene.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Substate made for dialogue cutscenes. To use it in a scripted cutscene, call startDialogue.

Constructor

new(dialoguePath:String, callback:() ‑> Void)

Variables

@:value([])charMap:Map<String, DialogueCharacter> = []

@:value(null)curLine:DialogueLine = null

dialogueCamera:FlxCamera

@:value([])dialogueLines:Array<DialogueLine> = []

nextSFX:FlxSound

Methods

next():Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by Cutscene

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Substate made for dialogue cutscenes. To use it in a scripted cutscene, call startDialogue.

Static variables

Constructor

new(dialoguePath:String, callback:() ‑> Void)

Variables

@:value(true)canProceed:Bool = true

Use this to cancel next!

@:value([])charMap:Map<String, DialogueCharacter> = []

@:value(null)curLine:DialogueLine = null

@:value(null)curMusic:FlxSound = null

dialogueCamera:FlxCamera

@:value([])dialogueLines:Array<DialogueLine> = []

@:value(null)lastLine:DialogueLine = null

Methods

@:value({ playFirst : false })next(playFirst:Bool = false):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/DialogueLine.html b/docs/funkin/game/cutscenes/DialogueLine.html index d707790..42cedfc 100644 --- a/docs/funkin/game/cutscenes/DialogueLine.html +++ b/docs/funkin/game/cutscenes/DialogueLine.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

text:String

speed:Float

char:String

callback:String

bubble:String

\ No newline at end of file +

Fields

textSound:FlxSound

text:String

speed:Float

playSound:FlxSound

nextSound:FlxSound

musicVolume:Null<Float>

char:String

changeMusic:FlxSound

callback:String

bubble:String

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/ScriptedCutscene.html b/docs/funkin/game/cutscenes/ScriptedCutscene.html index d413321..f5ac646 100644 --- a/docs/funkin/game/cutscenes/ScriptedCutscene.html +++ b/docs/funkin/game/cutscenes/ScriptedCutscene.html @@ -9,4 +9,4 @@ text-shadow: 0 0 0 transparent; }

Substate made for scripted cutscenes. -To add cutscenes to your songs, add a cutscene.hx file in your song's directory (ex: songs/song/cutscene.hx)

Constructor

new(scriptPath:String, callback:() ‑> Void)

Variables

read onlyisDialoguePlaying:Bool

read onlyisVideoPlaying:Bool

Methods

startDialogue(path:String, ?callback:() ‑> Void):Void

startVideo(path:String, ?callback:() ‑> Void):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by Cutscene

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +To add cutscenes to your songs, add a cutscene.hx file in your song's directory (ex: songs/song/cutscene.hx)

Constructor

new(scriptPath:String, callback:() ‑> Void)

Variables

read onlyisDialoguePlaying:Bool

read onlyisVideoPlaying:Bool

Methods

startDialogue(path:String, ?callback:() ‑> Void):Void

startVideo(path:String, ?callback:() ‑> Void):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by Cutscene

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/VideoCutscene.html b/docs/funkin/game/cutscenes/VideoCutscene.html index 62f3ce5..28b0b66 100644 --- a/docs/funkin/game/cutscenes/VideoCutscene.html +++ b/docs/funkin/game/cutscenes/VideoCutscene.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Substate made for video cutscenes. To use it in a scripted cutscene, call startVideo.

Static methods

staticsplitTime(str:String):Float

Constructor

new(path:String, callback:() ‑> Void)

Variables

@:value(true)skippable:Bool = true

@:value([])subtitles:Array<CutsceneSubtitle> = []

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by Cutscene

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Substate made for video cutscenes. To use it in a scripted cutscene, call startVideo.

Static methods

staticsplitTime(str:String):Float

Constructor

new(path:String, callback:() ‑> Void)

Variables

@:value(true)skippable:Bool = true

@:value([])subtitles:Array<CutsceneSubtitle> = []

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by Cutscene

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/dialogue/CharPosDef.html b/docs/funkin/game/cutscenes/dialogue/CharPosDef.html index de0b06f..915eb26 100644 --- a/docs/funkin/game/cutscenes/dialogue/CharPosDef.html +++ b/docs/funkin/game/cutscenes/dialogue/CharPosDef.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

y:Float

x:Float

\ No newline at end of file +

Fields

y:Float

x:Float

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/dialogue/DialogueBox.html b/docs/funkin/game/cutscenes/dialogue/DialogueBox.html index 729c812..d71e099 100644 --- a/docs/funkin/game/cutscenes/dialogue/DialogueBox.html +++ b/docs/funkin/game/cutscenes/dialogue/DialogueBox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(name:String)

Variables

@:value(Paths.sound("dialogue/next"))nextSFX:String = Paths.sound("dialogue/next")

@:value([])positions:Map<String, CharPosDef> = []

text:FlxTypeText

@:value(Paths.sound("dialogue/text"))textTypeSFX:String = Paths.sound("dialogue/text")

Methods

@:value({ speed : 0.05 })playBubbleAnim(bubble:String, text:String, speed:Float = 0.05):Void

@:value({ speed : 0.02 })setText(text:String, speed:Float = 0.02):Void

Inherited Variables

Defined by FunkinSprite

@:value([])animDatas:Map<String, AnimData> = []

@:value(new Map<String,FlxPoint>())animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

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

@:value(false)debugMode:Bool = false

@:value(1)initialZoom:Float = 1

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

name:String

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Inherited Methods

Defined by FunkinSprite

@:value({ y : 0, x : 0 })addOffset(name:String, x:Float = 0, y:Float = 0):Void

beatHit(curBeat:Int):Void

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnimation(AnimName:String):Bool

inlineisAnimFinished():Bool

@:value({ Key : null, Unique : false })loadSprite(path:String, Unique:Bool = false, ?Key:String):Void

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

@:value({ Frame : 0, Reversed : false, Context : NONE, Force : false })playAnim(AnimName:String, Force:Bool = false, Context:PlayAnimContext = NONE, Reversed:Bool = false, Frame:Int = 0):Void

inlineremoveAnimation(name:String):Void

stepHit(curBeat:Int):Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

\ No newline at end of file +

Constructor

new(name:String)

Variables

@:value(DialogueCutscene.cutscene)cutscene:DialogueCutscene = DialogueCutscene.cutscene

@:value("dialogue/boxes/")defPath:String = "dialogue/boxes/"

defaultTextTypeSFX:Array<FlxSound>

@:value(false)dialogueEnded:Bool = false

@:value(Paths.sound("dialogue/next"))nextSFX:String = Paths.sound("dialogue/next")

@:value([])positions:Map<String, CharPosDef> = []

text:FlxTypeText

Methods

@:value({ allowDefault : true, setTextAfter : false, speed : 0.05, text : "", suffix : "" })playBubbleAnim(bubble:String, suffix:String = "", text:String = "", ?format:Array<TextFormat>, speed:Float = 0.05, ?customSFX:FlxSound, ?customTypeSFX:Array<FlxSound>, setTextAfter:Bool = false, allowDefault:Bool = true):Void

@:value({ force : false })popupChar(char:DialogueCharacter, force:Bool = false):Void

@:value({ text : "" })resetText(text:String = "", ?formats:Array<TextFormat>, ?event:DialogueBoxSetTextEvent):Void

@:value({ speed : 0.05, text : "" })startText(text:String = "", ?format:Array<TextFormat>, speed:Float = 0.05, ?customTypeSFX:Array<FlxSound>):Void

Inherited Variables

Defined by FunkinSprite

@:value([])animDatas:Map<String, AnimData> = []

@:value(new Map<String,FlxPoint>())animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

@:value([])beatAnims:Array<BeatAnim> = []

@:value(1)beatInterval:Int = 1

@:value(0)beatOffset:Int = 0

@:value(false)debugMode:Bool = false

@:value(1)initialZoom:Float = 1

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

name:String

@:value(false)skipNegativeBeats:Bool = false

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Inherited Methods

Defined by FunkinSprite

@:value({ y : 0, x : 0 })addOffset(name:String, x:Float = 0, y:Float = 0):Void

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnimation(AnimName:String):Bool

inlineisAnimFinished():Bool

@:value({ Key : null, Unique : false })loadSprite(path:String, Unique:Bool = false, ?Key:String):Void

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

inlineremoveAnimation(name:String):Void

stepHit(curBeat:Int):Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/dialogue/DialogueCharAnimContext.html b/docs/funkin/game/cutscenes/dialogue/DialogueCharAnimContext.html new file mode 100644 index 0000000..3593987 --- /dev/null +++ b/docs/funkin/game/cutscenes/dialogue/DialogueCharAnimContext.html @@ -0,0 +1,10 @@ + + + +funkin.game.cutscenes.dialogue.DialogueCharAnimContext

Variables

@:value(cast -1)@:impl@:enuminlineread onlyNONE:DialogueCharAnimContext = -1

@:value(cast 0)@:impl@:enuminlineread onlyPOPIN:DialogueCharAnimContext = 0

@:value(cast 1)@:impl@:enuminlineread onlyPOPOUT:DialogueCharAnimContext = 1

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/dialogue/DialogueCharacter.html b/docs/funkin/game/cutscenes/dialogue/DialogueCharacter.html index cf7c81e..02254dd 100644 --- a/docs/funkin/game/cutscenes/dialogue/DialogueCharacter.html +++ b/docs/funkin/game/cutscenes/dialogue/DialogueCharacter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(name:String, position:String)

Variables

Methods

hide():Void

show(x:Float, y:Float):Void

Inherited Variables

Defined by FunkinSprite

@:value([])animDatas:Map<String, AnimData> = []

@:value(new Map<String,FlxPoint>())animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

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

@:value(false)debugMode:Bool = false

@:value(1)initialZoom:Float = 1

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

name:String

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Inherited Methods

Defined by FunkinSprite

@:value({ y : 0, x : 0 })addOffset(name:String, x:Float = 0, y:Float = 0):Void

beatHit(curBeat:Int):Void

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnimation(AnimName:String):Bool

inlineisAnimFinished():Bool

@:value({ Key : null, Unique : false })loadSprite(path:String, Unique:Bool = false, ?Key:String):Void

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

@:value({ Frame : 0, Reversed : false, Context : NONE, Force : false })playAnim(AnimName:String, Force:Bool = false, Context:PlayAnimContext = NONE, Reversed:Bool = false, Frame:Int = 0):Void

inlineremoveAnimation(name:String):Void

stepHit(curBeat:Int):Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

\ No newline at end of file +

Constructor

new(name:String, position:String)

Variables

charData:Access

curTween:FlxTween

@:value(DialogueCutscene.cutscene)cutscene:DialogueCutscene = DialogueCutscene.cutscene

@:value("dialogue/characters/")defPath:String = "dialogue/characters/"

@:value("normal")defaultAnim:String = "normal"

@:value(null)finishAnimCallback:String ‑> Void = null

Methods

@:value({ force : false })hide(?animation:String, force:Bool = false):Void

@:value({ force : false })show(x:Float, y:Float, ?animation:String, force:Bool = false):Void

Inherited Variables

Defined by FunkinSprite

@:value([])animDatas:Map<String, AnimData> = []

@:value(new Map<String,FlxPoint>())animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

@:value([])beatAnims:Array<BeatAnim> = []

@:value(1)beatInterval:Int = 1

@:value(0)beatOffset:Int = 0

@:value(false)debugMode:Bool = false

@:value(1)initialZoom:Float = 1

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

name:String

@:value(false)skipNegativeBeats:Bool = false

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Inherited Methods

Defined by FunkinSprite

@:value({ y : 0, x : 0 })addOffset(name:String, x:Float = 0, y:Float = 0):Void

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnimation(AnimName:String):Bool

inlineisAnimFinished():Bool

@:value({ Key : null, Unique : false })loadSprite(path:String, Unique:Bool = false, ?Key:String):Void

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

inlineremoveAnimation(name:String):Void

stepHit(curBeat:Int):Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/dialogue/index.html b/docs/funkin/game/cutscenes/dialogue/index.html index 6c9012d..b0e8725 100644 --- a/docs/funkin/game/cutscenes/dialogue/index.html +++ b/docs/funkin/game/cutscenes/dialogue/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/game/cutscenes/index.html b/docs/funkin/game/cutscenes/index.html index 5786f44..0113d6b 100644 --- a/docs/funkin/game/cutscenes/index.html +++ b/docs/funkin/game/cutscenes/index.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

funkin.game.cutscenes

..
dialogue
Cutscene

Substate made for cutscenes.

CutsceneSubtitle

DialogueCutscene

Substate made for dialogue cutscenes. To use it in a scripted cutscene, call startDialogue.

DialogueLine

ScriptedCutscene

Substate made for scripted cutscenes. -To add cutscenes to your songs, add a cutscene.hx file in your song's directory (ex: songs/song/cutscene.hx)

VideoCutscene

Substate made for video cutscenes. To use it in a scripted cutscene, call startVideo.

\ No newline at end of file +To add cutscenes to your songs, add a cutscene.hx file in your song's directory (ex: songs/song/cutscene.hx)

VideoCutscene

Substate made for video cutscenes. To use it in a scripted cutscene, call startVideo.

\ No newline at end of file diff --git a/docs/funkin/game/index.html b/docs/funkin/game/index.html index 842be7f..b4f0833 100644 --- a/docs/funkin/game/index.html +++ b/docs/funkin/game/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/index.html b/docs/funkin/index.html index 31da0e1..e2aa81b 100644 --- a/docs/funkin/index.html +++ b/docs/funkin/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/menus/BetaWarningState.html b/docs/funkin/menus/BetaWarningState.html index d871062..15476b2 100644 --- a/docs/funkin/menus/BetaWarningState.html +++ b/docs/funkin/menus/BetaWarningState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Methods

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Methods

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/FreeplaySonglist.html b/docs/funkin/menus/FreeplaySonglist.html index f5bc21c..19727df 100644 --- a/docs/funkin/menus/FreeplaySonglist.html +++ b/docs/funkin/menus/FreeplaySonglist.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

@:value({ useTxt : true })staticget(useTxt:Bool = true):FreeplaySonglist

Constructor

new()

Variables

@:value([])songs:Array<ChartMetaData> = []

Methods

@:value({ useTxt : true })getSongsFromSource(source:AssetSource, useTxt:Bool = true):Bool

\ No newline at end of file +

Static methods

@:value({ useTxt : true })staticget(useTxt:Bool = true):FreeplaySonglist

Constructor

new()

Variables

@:value([])songs:Array<ChartMetaData> = []

Methods

@:value({ useTxt : true })getSongsFromSource(source:AssetSource, useTxt:Bool = true):Bool

\ No newline at end of file diff --git a/docs/funkin/menus/FreeplayState.html b/docs/funkin/menus/FreeplayState.html index e1e4b46..0c6f460 100644 --- a/docs/funkin/menus/FreeplayState.html +++ b/docs/funkin/menus/FreeplayState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(0)autoplayElapsed:Float = 0

Time elapsed since last autoplay. If this time exceeds timeUntilAutoplay, the currently selected song will play.

bg:FlxSprite

Background.

@:value(true)canSelect:Bool = true

Whenever the player can navigate and select

@:value(["[TAB] Solo", "[TAB] Opponent Mode", "[TAB] Co-Op Mode", "[TAB] Co-Op Mode (Switched)"])coopLabels:Array<String> = ["[TAB] Solo", "[TAB] Opponent Mode", "[TAB] Co-Op Mode", "[TAB] Co-Op Mode (Switched)"]

Array containing all labels for Co-Op / Opponent modes.

coopText:FlxText

Text containing the current coop/opponent mode ([TAB] Co-Op mode)

@:value(0)curCoopMode:Int = 0

Currently selected coop/opponent mode

@:value(1)curDifficulty:Int = 1

Currently selected difficulty

@:value(false)curPlaying:Bool = false

Whenever the currently selected song is playing.

@:value(null)curPlayingInst:String = null

Path to the currently playing song instrumental.

@:value(0)curSelected:Int = 0

Currently selected song

diffText:FlxText

Text containing the current difficulty (< HARD >)

@:value(false)disableAsyncLoading:Bool = false

Whenever the autoplayed song gets async loaded.

@:value(false)disableAutoPlay:Bool = false

Whenever the song autoplays when hovered over.

grpSongs:FlxTypedGroup<Alphabet>

Group containing all of the alphabets

@:value([])iconArray:Array<HealthIcon> = []

Array containing all of the icons.

@:value(0)intendedScore:Int = 0

Destination for the currently lerped score.

interpColor:FlxInterpolateColor

FlxInterpolateColor object for smooth transition between Freeplay colors.

@:value(0)lerpScore:Int = 0

Currently lerped score. Is updated to go towards intendedScore.

scoreBG:FlxSprite

Black background around the score, the difficulty text and the co-op text.

scoreText:FlxText

Text containing the score info (PERSONAL BEST: 0)

@:value(true)songInstPlaying:Bool = true

Whenever the currently selected song instrumental is playing.

songList:FreeplaySonglist

Assigned FreeplaySonglist item.

@:value([])songs:Array<ChartMetaData> = []

Array containing all of the songs metadatas

@:value(1)timeUntilAutoplay:Float = 1

How much time a song stays selected until it autoplays.

Methods

@:value({ force : false, change : 0 })changeCoopMode(change:Int = 0, force:Bool = false):Void

Change the current coop mode context.

Parameters:

change

How much to change

force

Force the change, even if change is equal to 0.

@:value({ force : false, change : 0 })changeDiff(change:Int = 0, force:Bool = false):Void

Changes the current difficulty

Parameters:

change

How much to change.

force

Force the change if change is equal to 0

@:value({ force : false, change : 0 })changeSelection(change:Int = 0, force:Bool = false):Void

Change the current selection.

Parameters:

change

How much to change

force

Force the change, even if change is equal to 0.

select():Void

Selects the current song.

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(0)autoplayElapsed:Float = 0

Time elapsed since last autoplay. If this time exceeds timeUntilAutoplay, the currently selected song will play.

bg:FlxSprite

Background.

@:value(true)canSelect:Bool = true

Whenever the player can navigate and select

@:value(["[TAB] Solo", "[TAB] Opponent Mode", "[TAB] Co-Op Mode", "[TAB] Co-Op Mode (Switched)"])coopLabels:Array<String> = ["[TAB] Solo", "[TAB] Opponent Mode", "[TAB] Co-Op Mode", "[TAB] Co-Op Mode (Switched)"]

Array containing all labels for Co-Op / Opponent modes.

coopText:FlxText

Text containing the current coop/opponent mode ([TAB] Co-Op mode)

@:value(0)curCoopMode:Int = 0

Currently selected coop/opponent mode

@:value(1)curDifficulty:Int = 1

Currently selected difficulty

@:value(false)curPlaying:Bool = false

Whenever the currently selected song is playing.

@:value(null)curPlayingInst:String = null

Path to the currently playing song instrumental.

@:value(0)curSelected:Int = 0

Currently selected song

diffText:FlxText

Text containing the current difficulty (< HARD >)

@:value(false)disableAsyncLoading:Bool = false

Whenever the autoplayed song gets async loaded.

@:value(false)disableAutoPlay:Bool = false

Whenever the song autoplays when hovered over.

grpSongs:FlxTypedGroup<Alphabet>

Group containing all of the alphabets

@:value([])iconArray:Array<HealthIcon> = []

Array containing all of the icons.

@:value(0)intendedScore:Int = 0

Destination for the currently lerped score.

interpColor:FlxInterpolateColor

FlxInterpolateColor object for smooth transition between Freeplay colors.

@:value(0)lerpScore:Int = 0

Currently lerped score. Is updated to go towards intendedScore.

scoreBG:FlxSprite

Black background around the score, the difficulty text and the co-op text.

scoreText:FlxText

Text containing the score info (PERSONAL BEST: 0)

@:value(true)songInstPlaying:Bool = true

Whenever the currently selected song instrumental is playing.

songList:FreeplaySonglist

Assigned FreeplaySonglist item.

@:value([])songs:Array<ChartMetaData> = []

Array containing all of the songs metadatas

@:value(1)timeUntilAutoplay:Float = 1

How much time a song stays selected until it autoplays.

Methods

@:value({ force : false, change : 0 })changeCoopMode(change:Int = 0, force:Bool = false):Void

Change the current coop mode context.

Parameters:

change

How much to change

force

Force the change, even if change is equal to 0.

@:value({ force : false, change : 0 })changeDiff(change:Int = 0, force:Bool = false):Void

Changes the current difficulty

Parameters:

change

How much to change.

force

Force the change if change is equal to 0

@:value({ force : false, change : 0 })changeSelection(change:Int = 0, force:Bool = false):Void

Change the current selection.

Parameters:

change

How much to change

force

Force the change, even if change is equal to 0.

select():Void

Selects the current song.

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/GitarooPause.html b/docs/funkin/menus/GitarooPause.html index c3cd72f..b2e110f 100644 --- a/docs/funkin/menus/GitarooPause.html +++ b/docs/funkin/menus/GitarooPause.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new()

Methods

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/IntroText.html b/docs/funkin/menus/IntroText.html index dcc18eb..17d5ce4 100644 --- a/docs/funkin/menus/IntroText.html +++ b/docs/funkin/menus/IntroText.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?lines:Array<OneOfTwo<String, TitleStateImage>>)

Variables

@:value([])lines:Array<OneOfTwo<String, TitleStateImage>> = []

Methods

show():Void

\ No newline at end of file +

Constructor

new(?lines:Array<OneOfTwo<String, TitleStateImage>>)

Variables

@:value([])lines:Array<OneOfTwo<String, TitleStateImage>> = []

Methods

show():Void

\ No newline at end of file diff --git a/docs/funkin/menus/MainMenuState.html b/docs/funkin/menus/MainMenuState.html index d1c83e2..7b21abf 100644 --- a/docs/funkin/menus/MainMenuState.html +++ b/docs/funkin/menus/MainMenuState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(true)canAccessDebugMenus:Bool = true

Methods

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(true)canAccessDebugMenus:Bool = true

Methods

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/MenuCharacter.html b/docs/funkin/menus/MenuCharacter.html index 8dde810..fe10153 100644 --- a/docs/funkin/menus/MenuCharacter.html +++ b/docs/funkin/menus/MenuCharacter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

xml:Access

spritePath:String

scale:Float

offset:FlxPoint

\ No newline at end of file +

Fields

xml:Access

spritePath:String

scale:Float

offset:FlxPoint

\ No newline at end of file diff --git a/docs/funkin/menus/MenuCharacterSprite.html b/docs/funkin/menus/MenuCharacterSprite.html index 4a1e4bc..5d0043d 100644 --- a/docs/funkin/menus/MenuCharacterSprite.html +++ b/docs/funkin/menus/MenuCharacterSprite.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(pos:Int)

Variables

character:String

@:value(null)oldChar:MenuCharacter = null

Methods

\ No newline at end of file +

Constructor

new(pos:Int)

Variables

character:String

@:value(null)oldChar:MenuCharacter = null

Methods

\ No newline at end of file diff --git a/docs/funkin/menus/MenuItem.html b/docs/funkin/menus/MenuItem.html index 418ddc2..bbb29e4 100644 --- a/docs/funkin/menus/MenuItem.html +++ b/docs/funkin/menus/MenuItem.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, path:String)

Variables

@:value(0)targetY:Float = 0

Methods

\ No newline at end of file +

Constructor

new(x:Float, y:Float, path:String)

Variables

@:value(0)targetY:Float = 0

Methods

\ No newline at end of file diff --git a/docs/funkin/menus/ModSwitchMenu.html b/docs/funkin/menus/ModSwitchMenu.html index f0fb479..16f9539 100644 --- a/docs/funkin/menus/ModSwitchMenu.html +++ b/docs/funkin/menus/ModSwitchMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Methods

@:value({ force : false })changeSelection(change:Int, force:Bool = false):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Methods

@:value({ force : false })changeSelection(change:Int, force:Bool = false):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/PauseSubState.html b/docs/funkin/menus/PauseSubState.html index 9e1b85c..f08afce 100644 --- a/docs/funkin/menus/PauseSubState.html +++ b/docs/funkin/menus/PauseSubState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value("")staticscript:String = ""

Constructor

@:value({ y : 0, x : 0 })new(x:Float = 0, y:Float = 0)

Variables

@:value(PlayState.instance)game:PlayState = PlayState.instance

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

@:value("")staticscript:String = ""

Constructor

@:value({ y : 0, x : 0 })new(x:Float = 0, y:Float = 0)

Variables

@:value(PlayState.instance)game:PlayState = PlayState.instance

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/PlaytestingWarningSubstate.html b/docs/funkin/menus/PlaytestingWarningSubstate.html new file mode 100644 index 0000000..594b344 --- /dev/null +++ b/docs/funkin/menus/PlaytestingWarningSubstate.html @@ -0,0 +1,10 @@ + + + +funkin.menus.PlaytestingWarningSubstate

Constructor

new(closingWindow:Bool, buttons:Array<WarningButton>)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/StoryMenuState.html b/docs/funkin/menus/StoryMenuState.html index 5bd1102..805fd74 100644 --- a/docs/funkin/menus/StoryMenuState.html +++ b/docs/funkin/menus/StoryMenuState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

blackBar:FlxSprite

@:value(true)canSelect:Bool = true

@:value([])charFrames:Map<String, FlxFramesCollection> = []

@:value([])characters:Map<String, MenuCharacter> = []

@:value(0)curDifficulty:Int = 0

@:value(0)curWeek:Int = 0

@:value([])difficultySprites:Map<String, FlxSprite> = []

@:value(0)intendedScore:Int = 0

leftArrow:FlxSprite

@:value(0)lerpScore:Float = 0

rightArrow:FlxSprite

scoreText:FlxText

tracklist:FlxText

weekBG:FlxSprite

weekSprites:FlxTypedGroup<MenuItem>

weekTitle:FlxText

@:value([])weeks:Array<WeekData> = []

Methods

addCharacter(charName:String):Void

@:value({ force : false })changeDifficulty(change:Int, force:Bool = false):Void

@:value({ force : false })changeWeek(change:Int, force:Bool = false):Void

getWeeksFromSource(weeks:Array<String>, source:AssetSource):Bool

goBack():Void

loadXMLs():Void

selectWeek():Void

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

blackBar:FlxSprite

@:value(true)canSelect:Bool = true

@:value([])charFrames:Map<String, FlxFramesCollection> = []

@:value([])characters:Map<String, MenuCharacter> = []

@:value(0)curDifficulty:Int = 0

@:value(0)curWeek:Int = 0

@:value([])difficultySprites:Map<String, FlxSprite> = []

@:value(0)intendedScore:Int = 0

leftArrow:FlxSprite

@:value(0)lerpScore:Float = 0

rightArrow:FlxSprite

scoreText:FlxText

tracklist:FlxText

weekBG:FlxSprite

weekSprites:FlxTypedGroup<MenuItem>

weekTitle:FlxText

@:value([])weeks:Array<WeekData> = []

Methods

addCharacter(charName:String):Void

@:value({ force : false })changeDifficulty(change:Int, force:Bool = false):Void

@:value({ force : false })changeWeek(change:Int, force:Bool = false):Void

getWeeksFromSource(weeks:Array<String>, source:AssetSource):Bool

goBack():Void

loadXMLs():Void

selectWeek():Void

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/TitleState.html b/docs/funkin/menus/TitleState.html index b3f27ca..d043ef5 100644 --- a/docs/funkin/menus/TitleState.html +++ b/docs/funkin/menus/TitleState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

blackScreen:FlxSprite

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

ngSpr:FlxSprite

textGroup:FlxGroup

@:value(16)titleLength:Int = 16

@:value([1 => new IntroText(["ninjamuffin99", "phantomArcade", "kawaisprite", "evilsk8er"]), 3 => new IntroText(["ninjamuffin99", "phantomArcade", "kawaisprite", "evilsk8er", "present"]), 4 => new IntroText(), 5 => new IntroText(["In association", "with"]), 7 => new IntroText(["In association", "with", "newgrounds", { name : "newgroundsLogo", path : "menus/titlescreen/newgrounds_logo", scale : 0.8 }]), 8 => new IntroText(), 9 => new IntroText(["{introText1}"]), 11 => new IntroText(["{introText1}", "{introText2}"]), 12 => new IntroText(), 13 => new IntroText(["Friday"]), 14 => new IntroText(["Friday", "Night"]), 15 => new IntroText(["Friday", "Night", "Funkin'"])])titleLines:Map<Int, IntroText> = [1 => new IntroText(["ninjamuffin99", "phantomArcade", "kawaisprite", "evilsk8er"]), 3 => new IntroText(["ninjamuffin99", "phantomArcade", "kawaisprite", "evilsk8er", "present"]), 4 => new IntroText(), 5 => new IntroText(["In association", "with"]), 7 => new IntroText(["In association", "with", "newgrounds", { name : "newgroundsLogo", path : "menus/titlescreen/newgrounds_logo", scale : 0.8 }]), 8 => new IntroText(), 9 => new IntroText(["{introText1}"]), 11 => new IntroText(["{introText1}", "{introText2}"]), 12 => new IntroText(), 13 => new IntroText(["Friday"]), 14 => new IntroText(["Friday", "Night"]), 15 => new IntroText(["Friday", "Night", "Funkin'"])]

wackyImage:FlxSprite

xml:Access

Methods

addMoreText(text:String):Void

createCoolText(textArray:Array<String>):Void

getIntroTextShit():Array<Array<String>>

loadXML():Void

pressEnter():Void

skipIntro():Void

Inherited Variables

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

stateScript:Script

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

blackScreen:FlxSprite

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

ngSpr:FlxSprite

textGroup:FlxGroup

@:value(16)titleLength:Int = 16

@:value([1 => new IntroText(["ninjamuffin99", "phantomArcade", "kawaisprite", "evilsk8er"]), 3 => new IntroText(["ninjamuffin99", "phantomArcade", "kawaisprite", "evilsk8er", "present"]), 4 => new IntroText(), 5 => new IntroText(["In association", "with"]), 7 => new IntroText(["In association", "with", "newgrounds", { name : "newgroundsLogo", path : "menus/titlescreen/newgrounds_logo", scale : 0.8 }]), 8 => new IntroText(), 9 => new IntroText(["{introText1}"]), 11 => new IntroText(["{introText1}", "{introText2}"]), 12 => new IntroText(), 13 => new IntroText(["Friday"]), 14 => new IntroText(["Friday", "Night"]), 15 => new IntroText(["Friday", "Night", "Funkin'"])])titleLines:Map<Int, IntroText> = [1 => new IntroText(["ninjamuffin99", "phantomArcade", "kawaisprite", "evilsk8er"]), 3 => new IntroText(["ninjamuffin99", "phantomArcade", "kawaisprite", "evilsk8er", "present"]), 4 => new IntroText(), 5 => new IntroText(["In association", "with"]), 7 => new IntroText(["In association", "with", "newgrounds", { name : "newgroundsLogo", path : "menus/titlescreen/newgrounds_logo", scale : 0.8 }]), 8 => new IntroText(), 9 => new IntroText(["{introText1}"]), 11 => new IntroText(["{introText1}", "{introText2}"]), 12 => new IntroText(), 13 => new IntroText(["Friday"]), 14 => new IntroText(["Friday", "Night"]), 15 => new IntroText(["Friday", "Night", "Funkin'"])]

wackyImage:FlxSprite

xml:Access

Methods

addMoreText(text:String):Void

createCoolText(textArray:Array<String>):Void

getIntroTextShit():Array<Array<String>>

loadXML():Void

pressEnter():Void

skipIntro():Void

Inherited Variables

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 MusicBeatState

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/TitleStateImage.html b/docs/funkin/menus/TitleStateImage.html index f7fdbe4..2c96d06 100644 --- a/docs/funkin/menus/TitleStateImage.html +++ b/docs/funkin/menus/TitleStateImage.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionalscale:Null<Float>

path:String

name:String

@:optionaloptionalflipY:Null<Bool>

@:optionaloptionalflipX:Null<Bool>

\ No newline at end of file +

Fields

@:optionaloptionalscale:Null<Float>

path:String

name:String

@:optionaloptionalflipY:Null<Bool>

@:optionaloptionalflipX:Null<Bool>

\ No newline at end of file diff --git a/docs/funkin/menus/WeekData.html b/docs/funkin/menus/WeekData.html index 3139dbd..ae4666b 100644 --- a/docs/funkin/menus/WeekData.html +++ b/docs/funkin/menus/WeekData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

sprite:String

name:String

id:String

difficulties:Array<String>

chars:Array<String>

\ No newline at end of file +

Fields

sprite:String

name:String

id:String

difficulties:Array<String>

chars:Array<String>

\ No newline at end of file diff --git a/docs/funkin/menus/WeekSong.html b/docs/funkin/menus/WeekSong.html index 191f8fd..4c87e39 100644 --- a/docs/funkin/menus/WeekSong.html +++ b/docs/funkin/menus/WeekSong.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

name:String

hide:Bool

\ No newline at end of file +

Fields

name:String

hide:Bool

\ No newline at end of file diff --git a/docs/funkin/menus/credits/CreditsCodename.html b/docs/funkin/menus/credits/CreditsCodename.html index 8068fa0..1cdff41 100644 --- a/docs/funkin/menus/credits/CreditsCodename.html +++ b/docs/funkin/menus/credits/CreditsCodename.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file +

Constructor

new()

Variables

@:value("FNF-CNE-Devs")author:String = "FNF-CNE-Devs"

@:value(false)error:Bool = false

Methods

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

\ No newline at end of file diff --git a/docs/funkin/menus/credits/CreditsMain.html b/docs/funkin/menus/credits/CreditsMain.html index 4bc8af7..5929029 100644 --- a/docs/funkin/menus/credits/CreditsMain.html +++ b/docs/funkin/menus/credits/CreditsMain.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

parseCreditsFromXML(xml:Access, source:Bool):Array<OptionType>

XML STUFF

Inherited Variables

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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

stateScript:Script

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 TreeMenu

exit():Void

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new()

Methods

parseCreditsFromXML(xml:Access, source:Bool):Array<OptionType>

XML STUFF

Inherited Variables

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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 TreeMenu

exit():Void

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/menus/credits/index.html b/docs/funkin/menus/credits/index.html index 93c2d4f..8e11ae8 100644 --- a/docs/funkin/menus/credits/index.html +++ b/docs/funkin/menus/credits/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.menus.credits

..
CreditsCodename

CreditsMain

\ No newline at end of file +

funkin.menus.credits

..
CreditsCodename

CreditsMain

\ No newline at end of file diff --git a/docs/funkin/menus/index.html b/docs/funkin/menus/index.html index 0e0c885..28e6af3 100644 --- a/docs/funkin/menus/index.html +++ b/docs/funkin/menus/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/menus/ui/AlphaCharacter.html b/docs/funkin/menus/ui/AlphaCharacter.html index 305311e..fc9079a 100644 --- a/docs/funkin/menus/ui/AlphaCharacter.html +++ b/docs/funkin/menus/ui/AlphaCharacter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

staticboldAlphabetPath:String

@:value([])staticboldAnims:Map<String, String> = []

staticletterAlphabetPath:String

@:value([])staticletterAnims:Map<String, String> = []

Constructor

new(x:Float, y:Float)

Variables

@:value(0)row:Int = 0

Methods

createBold(letter:String):Void

createLetter(letter:String):Void

setColor(c:FlxColor, isBold:Bool):Void

\ No newline at end of file +

Static variables

staticboldAlphabetPath:String

@:value([])staticboldAnims:Map<String, String> = []

staticletterAlphabetPath:String

@:value([])staticletterAnims:Map<String, String> = []

Constructor

new(x:Float, y:Float)

Variables

@:value(0)row:Int = 0

Methods

createBold(letter:String):Void

createLetter(letter:String):Void

setColor(c:FlxColor, isBold:Bool):Void

\ No newline at end of file diff --git a/docs/funkin/menus/ui/Alphabet.html b/docs/funkin/menus/ui/Alphabet.html index e9f7d1a..23c2fb8 100644 --- a/docs/funkin/menus/ui/Alphabet.html +++ b/docs/funkin/menus/ui/Alphabet.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Loosely based on FlxTypeText lolol

Constructor

@:value({ typed : false, bold : false, text : "" })new(x:Float, y:Float, text:String = "", bold:Bool = false, typed:Bool = false)

Variables

@:value(0.05)delay:Float = 0.05

@:value(false)isMenuItem:Bool = false

@:value(false)paused:Bool = false

@:value("gf")personTalking:String = "gf"

@:value(0)targetY:Float = 0

@:value("")text:String = ""

@:value(FlxG.width)widthOfWords:Float = FlxG.width

Methods

addText():Void

refreshAlphabetXML(path:String):Void

\ No newline at end of file +

Loosely based on FlxTypeText lolol

Constructor

@:value({ typed : false, bold : false, text : "" })new(x:Float, y:Float, text:String = "", bold:Bool = false, typed:Bool = false)

Variables

@:value(0.05)delay:Float = 0.05

@:value(false)isMenuItem:Bool = false

@:value(false)paused:Bool = false

@:value(0)targetY:Float = 0

@:value("")text:String = ""

Methods

addText():Void

refreshAlphabetXML(path:String):Void

\ No newline at end of file diff --git a/docs/funkin/menus/ui/index.html b/docs/funkin/menus/ui/index.html index 069064b..e130d6a 100644 --- a/docs/funkin/menus/ui/index.html +++ b/docs/funkin/menus/ui/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.menus.ui

..
AlphaCharacter

Alphabet

Loosely based on FlxTypeText lolol

\ No newline at end of file +

funkin.menus.ui

..
AlphaCharacter

Alphabet

Loosely based on FlxTypeText lolol

\ No newline at end of file diff --git a/docs/funkin/options/OptionCategory.html b/docs/funkin/options/OptionCategory.html index d872c05..349b9b8 100644 --- a/docs/funkin/options/OptionCategory.html +++ b/docs/funkin/options/OptionCategory.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

@:optionaloptionalsubstate:Null<OneOfTwo<MusicBeatSubstate, Class<MusicBeatSubstate>>>

name:String

desc:String

\ No newline at end of file +

Fields

@:optionaloptionalsubstate:Null<OneOfTwo<MusicBeatSubstate, Class<MusicBeatSubstate>>>

name:String

desc:String

\ No newline at end of file diff --git a/docs/funkin/options/OptionTypeDef.html b/docs/funkin/options/OptionTypeDef.html index e0c898d..d2bbbac 100644 --- a/docs/funkin/options/OptionTypeDef.html +++ b/docs/funkin/options/OptionTypeDef.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

args:Array<Dynamic>

\ No newline at end of file +

Fields

args:Array<Dynamic>

\ No newline at end of file diff --git a/docs/funkin/options/Options.html b/docs/funkin/options/Options.html index 97d8318..80ac63f 100644 --- a/docs/funkin/options/Options.html +++ b/docs/funkin/options/Options.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value([ENTER])staticP1_ACCEPT:Array<FlxKey> = [ENTER]

@:value([BACKSPACE])staticP1_BACK:Array<FlxKey> = [BACKSPACE]

@:value([S])staticP1_DOWN:Array<FlxKey> = [S]

@:value([A])staticP1_LEFT:Array<FlxKey> = [A]

@:value([S])staticP1_NOTE_DOWN:Array<FlxKey> = [S]

@:value([A])staticP1_NOTE_LEFT:Array<FlxKey> = [A]

PLAYER 1 CONTROLS

@:value([D])staticP1_NOTE_RIGHT:Array<FlxKey> = [D]

@:value([W])staticP1_NOTE_UP:Array<FlxKey> = [W]

@:value([ENTER])staticP1_PAUSE:Array<FlxKey> = [ENTER]

@:value([R])staticP1_RESET:Array<FlxKey> = [R]

@:value([D])staticP1_RIGHT:Array<FlxKey> = [D]

@:value([TAB])staticP1_SWITCHMOD:Array<FlxKey> = [TAB]

@:value([W])staticP1_UP:Array<FlxKey> = [W]

@:value([SPACE])staticP2_ACCEPT:Array<FlxKey> = [SPACE]

@:value([ESCAPE])staticP2_BACK:Array<FlxKey> = [ESCAPE]

@:value([DOWN])staticP2_DOWN:Array<FlxKey> = [DOWN]

@:value([LEFT])staticP2_LEFT:Array<FlxKey> = [LEFT]

@:value([DOWN])staticP2_NOTE_DOWN:Array<FlxKey> = [DOWN]

@:value([LEFT])staticP2_NOTE_LEFT:Array<FlxKey> = [LEFT]

PLAYER 2 CONTROLS (ALT)

@:value([RIGHT])staticP2_NOTE_RIGHT:Array<FlxKey> = [RIGHT]

@:value([UP])staticP2_NOTE_UP:Array<FlxKey> = [UP]

@:value([ESCAPE])staticP2_PAUSE:Array<FlxKey> = [ESCAPE]

@:value([])staticP2_RESET:Array<FlxKey> = []

@:value([RIGHT])staticP2_RIGHT:Array<FlxKey> = [RIGHT]

@:value([])staticP2_SWITCHMOD:Array<FlxKey> = []

@:value([UP])staticP2_UP:Array<FlxKey> = [UP]

staticread onlySOLO_ACCEPT:Array<FlxKey>

staticread onlySOLO_BACK:Array<FlxKey>

staticread onlySOLO_DOWN:Array<FlxKey>

staticread onlySOLO_LEFT:Array<FlxKey>

staticread onlySOLO_NOTE_DOWN:Array<FlxKey>

staticread onlySOLO_NOTE_LEFT:Array<FlxKey>

SOLO GETTERS

staticread onlySOLO_NOTE_RIGHT:Array<FlxKey>

staticread onlySOLO_NOTE_UP:Array<FlxKey>

staticread onlySOLO_PAUSE:Array<FlxKey>

staticread onlySOLO_RESET:Array<FlxKey>

staticread onlySOLO_RIGHT:Array<FlxKey>

staticread onlySOLO_SWITCHMOD:Array<FlxKey>

staticread onlySOLO_UP:Array<FlxKey>

@:value(true)staticantialiasing:Bool = true

@:value(true)staticautoPause:Bool = true

@:value(false)staticbetaUpdates:Bool = false

@:value(true)staticcamZoomOnBeat:Bool = true

@:value(true)staticcharterEnablePlaytestScripts:Bool = true

@:value(false)staticcharterMetronomeEnabled:Bool = false

@:value(true)staticcharterShowBeats:Bool = true

@:value(true)staticcharterShowSections:Bool = true

@:value(true)staticcolorHealthBar:Bool = true

@:value([])staticcontributors:Array<GitHubContributor> = []

@:value(false)staticdownscroll:Bool = false

@:value(true)staticeditorSFX:Bool = true

@:value(true)staticflashingMenu:Bool = true

@:value(true)staticfpsCounter:Bool = true

@:value(120)staticframerate:Int = 120

@:value("normal")staticfreeplayLastDifficulty:String = "normal"

@:value(null)staticfreeplayLastSong:String = null

QOL FEATURES

@:value(true)staticghostTapping:Bool = true

@:value(true)staticgpuOnlyBitmaps:Bool = true

@:value(250)statichitWindow:Float = 250

@:value(true)staticintensiveBlur:Bool = true

EDITORS SETTINGS

@:value(null)staticlastLoadedMod:String = null

staticlastUpdated:Null<Float>

@:value(false)staticlowMemoryMode:Bool = false

@:value(120)staticmaxUndos:Int = 120

@:value(true)staticnaughtyness:Bool = true

SETTINGS

@:value(true)staticresizableEditors:Bool = true

@:value(0)staticsongOffset:Float = 0

@:value(true)staticsplashesEnabled:Bool = true

@:value(1)staticvolume:Float = 1

@:value(true)staticweek6PixelPerfect:Bool = true

Static methods

static__flush():Void

static__load():Void

staticapplyKeybinds():Void

staticapplySettings():Void

staticload():Void

staticsave():Void

\ No newline at end of file +

Static variables

@:value([ENTER])staticP1_ACCEPT:Array<FlxKey> = [ENTER]

@:value([BACKSPACE])staticP1_BACK:Array<FlxKey> = [BACKSPACE]

@:value([S])staticP1_DOWN:Array<FlxKey> = [S]

@:value([A])staticP1_LEFT:Array<FlxKey> = [A]

@:value([S])staticP1_NOTE_DOWN:Array<FlxKey> = [S]

@:value([A])staticP1_NOTE_LEFT:Array<FlxKey> = [A]

PLAYER 1 CONTROLS

@:value([D])staticP1_NOTE_RIGHT:Array<FlxKey> = [D]

@:value([W])staticP1_NOTE_UP:Array<FlxKey> = [W]

@:value([ENTER])staticP1_PAUSE:Array<FlxKey> = [ENTER]

@:value([R])staticP1_RESET:Array<FlxKey> = [R]

@:value([D])staticP1_RIGHT:Array<FlxKey> = [D]

@:value([TAB])staticP1_SWITCHMOD:Array<FlxKey> = [TAB]

@:value([W])staticP1_UP:Array<FlxKey> = [W]

@:value([SPACE])staticP2_ACCEPT:Array<FlxKey> = [SPACE]

@:value([ESCAPE])staticP2_BACK:Array<FlxKey> = [ESCAPE]

@:value([DOWN])staticP2_DOWN:Array<FlxKey> = [DOWN]

@:value([LEFT])staticP2_LEFT:Array<FlxKey> = [LEFT]

@:value([DOWN])staticP2_NOTE_DOWN:Array<FlxKey> = [DOWN]

@:value([LEFT])staticP2_NOTE_LEFT:Array<FlxKey> = [LEFT]

PLAYER 2 CONTROLS (ALT)

@:value([RIGHT])staticP2_NOTE_RIGHT:Array<FlxKey> = [RIGHT]

@:value([UP])staticP2_NOTE_UP:Array<FlxKey> = [UP]

@:value([ESCAPE])staticP2_PAUSE:Array<FlxKey> = [ESCAPE]

@:value([])staticP2_RESET:Array<FlxKey> = []

@:value([RIGHT])staticP2_RIGHT:Array<FlxKey> = [RIGHT]

@:value([])staticP2_SWITCHMOD:Array<FlxKey> = []

@:value([UP])staticP2_UP:Array<FlxKey> = [UP]

staticread onlySOLO_ACCEPT:Array<FlxKey>

staticread onlySOLO_BACK:Array<FlxKey>

staticread onlySOLO_DOWN:Array<FlxKey>

staticread onlySOLO_LEFT:Array<FlxKey>

staticread onlySOLO_NOTE_DOWN:Array<FlxKey>

staticread onlySOLO_NOTE_LEFT:Array<FlxKey>

SOLO GETTERS

staticread onlySOLO_NOTE_RIGHT:Array<FlxKey>

staticread onlySOLO_NOTE_UP:Array<FlxKey>

staticread onlySOLO_PAUSE:Array<FlxKey>

staticread onlySOLO_RESET:Array<FlxKey>

staticread onlySOLO_RIGHT:Array<FlxKey>

staticread onlySOLO_SWITCHMOD:Array<FlxKey>

staticread onlySOLO_UP:Array<FlxKey>

@:value(true)staticantialiasing:Bool = true

@:value(true)staticautoPause:Bool = true

@:value(false)staticbetaUpdates:Bool = false

@:value(true)staticcamZoomOnBeat:Bool = true

@:value(true)staticcharterEnablePlaytestScripts:Bool = true

@:value(false)staticcharterMetronomeEnabled:Bool = false

CHARTER

@:value(true)staticcharterShowBeats:Bool = true

@:value(true)staticcharterShowSections:Bool = true

@:value(true)staticcolorHealthBar:Bool = true

@:value([])staticcontributors:Array<GitHubContributor> = []

@:value(false)staticdownscroll:Bool = false

@:value(true)staticeditorSFX:Bool = true

@:value(true)staticflashingMenu:Bool = true

@:value(true)staticfpsCounter:Bool = true

@:value(120)staticframerate:Int = 120

@:value("normal")staticfreeplayLastDifficulty:String = "normal"

@:value(null)staticfreeplayLastSong:String = null

QOL FEATURES

@:value(true)staticgameplayShaders:Bool = true

@:value(true)staticghostTapping:Bool = true

@:value(true)staticgpuOnlyBitmaps:Bool = true

@:value(250)statichitWindow:Float = 250

@:value(true)staticintensiveBlur:Bool = true

EDITORS SETTINGS

@:value(null)staticlastLoadedMod:String = null

staticlastUpdated:Null<Float>

@:value(false)staticlowMemoryMode:Bool = false

@:value([])staticmainDevs:Array<Int> = []

@:value(120)staticmaxUndos:Int = 120

@:value(true)staticnaughtyness:Bool = true

SETTINGS

@:value(true)staticresizableEditors:Bool = true

@:value(0)staticsongOffset:Float = 0

@:value(true)staticsplashesEnabled:Bool = true

@:value(1)staticvolume:Float = 1

@:value(true)staticweek6PixelPerfect:Bool = true

Static methods

static__flush():Void

static__load():Void

staticapplyKeybinds():Void

staticapplySettings():Void

staticload():Void

staticsave():Void

\ No newline at end of file diff --git a/docs/funkin/options/OptionsMenu.html b/docs/funkin/options/OptionsMenu.html index fb1138b..456886c 100644 --- a/docs/funkin/options/OptionsMenu.html +++ b/docs/funkin/options/OptionsMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value([{ 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 }])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

new()

Methods

parseOptionsFromXML(xml:Access):Array<OptionType>

XML STUFF

Inherited Variables

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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

stateScript:Script

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 TreeMenu

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

@:value([{ 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 }])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

new()

Methods

parseOptionsFromXML(xml:Access):Array<OptionType>

XML STUFF

Inherited Variables

Defined by TreeMenu

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

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 TreeMenu

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):Void

Defined by UIState

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/options/OptionsScreen.html b/docs/funkin/options/OptionsScreen.html index da80258..6946edd 100644 --- a/docs/funkin/options/OptionsScreen.html +++ b/docs/funkin/options/OptionsScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(120)staticoptionHeight:Float = 120

Constructor

new(name:String, desc:String, ?options:Array<OptionType>)

Variables

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Methods

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file +

Static variables

@:value(120)staticoptionHeight:Float = 120

Constructor

new(name:String, desc:String, ?options:Array<OptionType>)

Variables

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Methods

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file diff --git a/docs/funkin/options/OptionsTree.html b/docs/funkin/options/OptionsTree.html index a034235..37aa961 100644 --- a/docs/funkin/options/OptionsTree.html +++ b/docs/funkin/options/OptionsTree.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Variables

Methods

dynamiconMenuChange():Void

dynamiconMenuClose(m:OptionsScreen):Void

\ No newline at end of file +

Constructor

new()

Variables

Methods

dynamiconMenuChange():Void

dynamiconMenuClose(m:OptionsScreen):Void

\ No newline at end of file diff --git a/docs/funkin/options/PlayerSettings.html b/docs/funkin/options/PlayerSettings.html index 115fbfe..f0f8f64 100644 --- a/docs/funkin/options/PlayerSettings.html +++ b/docs/funkin/options/PlayerSettings.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

@:value(0)staticread onlynumAvatars:Int = 0

@:value(0)staticread onlynumPlayers:Int = 0

@:value(new FlxTypedSignal<PlayerSettings>())staticfinalread onlyonAvatarAdd:FlxTypedSignal<PlayerSettings ‑> Void> = new FlxTypedSignal<PlayerSettings>()

@:value(new FlxTypedSignal<PlayerSettings>())staticfinalread onlyonAvatarRemove:FlxTypedSignal<PlayerSettings ‑> Void> = new FlxTypedSignal<PlayerSettings>()

staticread onlyplayer1:PlayerSettings

staticread onlyplayer2:PlayerSettings

staticread onlysolo:PlayerSettings

Static methods

staticinit():Void

staticreset():Void

Variables

read onlyid:Int

Methods

\ No newline at end of file +

Static variables

@:value(0)staticread onlynumAvatars:Int = 0

@:value(0)staticread onlynumPlayers:Int = 0

@:value(new FlxTypedSignal<PlayerSettings>())staticfinalread onlyonAvatarAdd:FlxTypedSignal<PlayerSettings ‑> Void> = new FlxTypedSignal<PlayerSettings>()

@:value(new FlxTypedSignal<PlayerSettings>())staticfinalread onlyonAvatarRemove:FlxTypedSignal<PlayerSettings ‑> Void> = new FlxTypedSignal<PlayerSettings>()

staticread onlyplayer1:PlayerSettings

staticread onlyplayer2:PlayerSettings

staticread onlysolo:PlayerSettings

Static methods

staticinit():Void

staticreset():Void

Variables

read onlyid:Int

Methods

\ No newline at end of file diff --git a/docs/funkin/options/TreeMenu.html b/docs/funkin/options/TreeMenu.html index a5b2eae..6bc2b68 100644 --- a/docs/funkin/options/TreeMenu.html +++ b/docs/funkin/options/TreeMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static methods

staticinlinemenuTransitionEase(e:Float):Float

Constructor

new()

Variables

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

Methods

exit():Void

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):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).

stateScript:Script

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static methods

staticinlinemenuTransitionEase(e:Float):Float

Constructor

new()

Variables

@:value(Type.getClass(FlxG.state))lastState:Class<FlxState> = Type.getClass(FlxG.state)

pathBG:FlxSprite

Methods

exit():Void

@:value({ moreTxt : "" })updateDesc(moreTxt:String = ""):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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/options/categories/AppearanceOptions.html b/docs/funkin/options/categories/AppearanceOptions.html index ea476e5..a3fbfdd 100644 --- a/docs/funkin/options/categories/AppearanceOptions.html +++ b/docs/funkin/options/categories/AppearanceOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file +

Constructor

new()

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file diff --git a/docs/funkin/options/categories/GameplayOptions.html b/docs/funkin/options/categories/GameplayOptions.html index c54d5d5..f8fa2a3 100644 --- a/docs/funkin/options/categories/GameplayOptions.html +++ b/docs/funkin/options/categories/GameplayOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file +

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file diff --git a/docs/funkin/options/categories/MiscOptions.html b/docs/funkin/options/categories/MiscOptions.html index 49bbaef..8cf6aa8 100644 --- a/docs/funkin/options/categories/MiscOptions.html +++ b/docs/funkin/options/categories/MiscOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new()

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file +

Constructor

new()

Inherited Variables

Defined by OptionsScreen

@:value(0)curSelected:Int = 0

desc:String

@:value(0)id:Int = 0

name:String

Inherited Methods

Defined by OptionsScreen

@:value({ force : false })changeSelection(sel:Int, force:Bool = false):Void

close():Void

dynamiconClose(o:OptionsScreen):Void

updateMenuDesc(?customTxt:String):Void

\ No newline at end of file diff --git a/docs/funkin/options/categories/index.html b/docs/funkin/options/categories/index.html index 8290a2e..e9a424e 100644 --- a/docs/funkin/options/categories/index.html +++ b/docs/funkin/options/categories/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/options/index.html b/docs/funkin/options/index.html index 262ff2b..8aaabf2 100644 --- a/docs/funkin/options/index.html +++ b/docs/funkin/options/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/options/keybinds/ChangeKeybindSubState.html b/docs/funkin/options/keybinds/ChangeKeybindSubState.html index 1519b9d..efe292e 100644 --- a/docs/funkin/options/keybinds/ChangeKeybindSubState.html +++ b/docs/funkin/options/keybinds/ChangeKeybindSubState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(callback:FlxKey ‑> Void, cancelCallback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Constructor

new(callback:FlxKey ‑> Void, cancelCallback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/options/keybinds/KeybindSetting.html b/docs/funkin/options/keybinds/KeybindSetting.html index 92c06f0..5c54dab 100644 --- a/docs/funkin/options/keybinds/KeybindSetting.html +++ b/docs/funkin/options/keybinds/KeybindSetting.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(x:Float, y:Float, name:String, value:String, ?sparrowIcon:String, ?sparrowAnim:String)

Variables

@:value(-1)changingKeybind:Int = -1

icon:FlxSprite

option1:Null<FlxKey>

option2:Null<FlxKey>

@:value(false)p2Selected:Bool = false

value:String

Methods

@:value({ p2 : false })changeKeybind(callback:() ‑> Void, cancelCallback:() ‑> Void, p2:Bool = false):Void

updateText():Void

\ No newline at end of file +

Constructor

new(x:Float, y:Float, name:String, value:String, ?sparrowIcon:String, ?sparrowAnim:String)

Variables

@:value(-1)changingKeybind:Int = -1

icon:FlxSprite

option1:Null<FlxKey>

option2:Null<FlxKey>

@:value(false)p2Selected:Bool = false

value:String

Methods

@:value({ p2 : false })changeKeybind(callback:() ‑> Void, cancelCallback:() ‑> Void, p2:Bool = false):Void

updateText():Void

\ No newline at end of file diff --git a/docs/funkin/options/keybinds/KeybindsOptions.html b/docs/funkin/options/keybinds/KeybindsOptions.html index dba804e..03fb92a 100644 --- a/docs/funkin/options/keybinds/KeybindsOptions.html +++ b/docs/funkin/options/keybinds/KeybindsOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Static variables

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

alphabets:FlxTypedGroup<KeybindSetting>

bg:FlxSprite

@:value(new FlxObject(0, 0, 2, 2))camFollow:FlxObject = new FlxObject(0, 0, 2, 2)

@:value(true)canSelect:Bool = true

@:value([{ name : "Notes", settings : [{ name : "{noteLeft}", control : "NOTE_LEFT" }, { name : "{noteDown}", control : "NOTE_DOWN" }, { name : "{noteUp}", control : "NOTE_UP" }, { name : "{noteRight}", control : "NOTE_RIGHT" }] }, { name : "UI", settings : [{ name : "Left", control : "LEFT" }, { name : "Down", control : "DOWN" }, { name : "Up", control : "UP" }, { name : "Right", control : "RIGHT" }, { name : "Accept", control : "ACCEPT" }, { name : "Back", control : "BACK" }, { name : "Reset", control : "RESET" }, { name : "Pause", control : "PAUSE" }] }, { name : "Engine", settings : [{ name : "Switch Mod", control : "SWITCHMOD" }] }])categories:Array<{settings:Array<{name:String, control:String}>, name:String}> = [{ name : "Notes", settings : [{ name : "{noteLeft}", control : "NOTE_LEFT" }, { name : "{noteDown}", control : "NOTE_DOWN" }, { name : "{noteUp}", control : "NOTE_UP" }, { name : "{noteRight}", control : "NOTE_RIGHT" }] }, { name : "UI", settings : [{ name : "Left", control : "LEFT" }, { name : "Down", control : "DOWN" }, { name : "Up", control : "UP" }, { name : "Right", control : "RIGHT" }, { name : "Accept", control : "ACCEPT" }, { name : "Back", control : "BACK" }, { name : "Reset", control : "RESET" }, { name : "Pause", control : "PAUSE" }] }, { name : "Engine", settings : [{ name : "Switch Mod", control : "SWITCHMOD" }] }]

coloredBG:FlxSprite

@:value(0)curSelected:Int = 0

@:value([0xFFC24B99, 0xFF00FFFF, 0xFF12FA05, 0xFFF9393F])noteColors:Array<FlxColor> = [0xFFC24B99, 0xFF00FFFF, 0xFF12FA05, 0xFFF9393F]

@:value(false)p2Selected:Bool = false

settingCam:FlxCamera

Methods

changeSelection(change:Int):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@:value(null)scriptName:String = null

@:value(true)scriptsAllowed:Bool = true

read onlysongPos:Float

Current song position (in milliseconds).

stateScript:Script

Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: "data/states/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

Static variables

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

alphabets:FlxTypedGroup<KeybindSetting>

bg:FlxSprite

@:value(new FlxObject(0, 0, 2, 2))camFollow:FlxObject = new FlxObject(0, 0, 2, 2)

@:value(true)canSelect:Bool = true

@:value([{ name : "Notes", settings : [{ name : "{noteLeft}", control : "NOTE_LEFT" }, { name : "{noteDown}", control : "NOTE_DOWN" }, { name : "{noteUp}", control : "NOTE_UP" }, { name : "{noteRight}", control : "NOTE_RIGHT" }] }, { name : "UI", settings : [{ name : "Left", control : "LEFT" }, { name : "Down", control : "DOWN" }, { name : "Up", control : "UP" }, { name : "Right", control : "RIGHT" }, { name : "Accept", control : "ACCEPT" }, { name : "Back", control : "BACK" }, { name : "Reset", control : "RESET" }, { name : "Pause", control : "PAUSE" }] }, { name : "Engine", settings : [{ name : "Switch Mod", control : "SWITCHMOD" }] }])categories:Array<{settings:Array<{name:String, control:String}>, name:String}> = [{ name : "Notes", settings : [{ name : "{noteLeft}", control : "NOTE_LEFT" }, { name : "{noteDown}", control : "NOTE_DOWN" }, { name : "{noteUp}", control : "NOTE_UP" }, { name : "{noteRight}", control : "NOTE_RIGHT" }] }, { name : "UI", settings : [{ name : "Left", control : "LEFT" }, { name : "Down", control : "DOWN" }, { name : "Up", control : "UP" }, { name : "Right", control : "RIGHT" }, { name : "Accept", control : "ACCEPT" }, { name : "Back", control : "BACK" }, { name : "Reset", control : "RESET" }, { name : "Pause", control : "PAUSE" }] }, { name : "Engine", settings : [{ name : "Switch Mod", control : "SWITCHMOD" }] }]

coloredBG:FlxSprite

@:value(0)curSelected:Int = 0

@:value([0xFFC24B99, 0xFF00FFFF, 0xFF12FA05, 0xFFF9393F])noteColors:Array<FlxColor> = [0xFFC24B99, 0xFF00FFFF, 0xFF12FA05, 0xFFF9393F]

@:value(false)p2Selected:Bool = false

settingCam:FlxCamera

Methods

changeSelection(change:Int):Void

Inherited Variables

Defined by MusicBeatSubstate

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)

parent:FlxState

@: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/PauseMenuSubstate.hx")

Inherited Methods

Defined by MusicBeatSubstate

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

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

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

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/docs/funkin/options/keybinds/index.html b/docs/funkin/options/keybinds/index.html index 081b6ad..d2ca6dd 100644 --- a/docs/funkin/options/keybinds/index.html +++ b/docs/funkin/options/keybinds/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/options/type/ArrayOption.html b/docs/funkin/options/type/ArrayOption.html new file mode 100644 index 0000000..f9fa2ff --- /dev/null +++ b/docs/funkin/options/type/ArrayOption.html @@ -0,0 +1,10 @@ + + + +funkin.options.type.ArrayOption

Constructor

@:value({ selectCallback : null })new(text:String, desc:String, options:Array<Dynamic>, displayOptions:Array<String>, optionName:String, ?selectCallback:String ‑> Void, ?parent:Dynamic)

Variables

displayOptions:Array<String>

options:Array<Dynamic>

parent:Dynamic

text:String

selectCallback:String ‑> Void

Methods

Inherited Variables

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by OptionType

onSelect():Void

\ No newline at end of file diff --git a/docs/funkin/options/type/Checkbox.html b/docs/funkin/options/type/Checkbox.html index 7fc96ab..741f092 100644 --- a/docs/funkin/options/type/Checkbox.html +++ b/docs/funkin/options/type/Checkbox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(text:String, desc:String, optionName:String, ?parent:Dynamic)

Variables

checkbox:FlxSprite

checked:Bool

optionName:String

parent:Dynamic

Methods

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file +

Constructor

new(text:String, desc:String, optionName:String, ?parent:Dynamic)

Variables

checkbox:FlxSprite

checked:Bool

optionName:String

parent:Dynamic

Methods

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file diff --git a/docs/funkin/options/type/EditorIconOption.html b/docs/funkin/options/type/EditorIconOption.html index a024ec5..f7300e5 100644 --- a/docs/funkin/options/type/EditorIconOption.html +++ b/docs/funkin/options/type/EditorIconOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ flashColor : 0 })new(name:String, desc:String, icon:String, callback:() ‑> Void, flashColor:FlxColor = 0)

Variables

flashColor:FlxColor

Inherited Variables

Defined by IconOption

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file +

Constructor

@:value({ flashColor : 0 })new(name:String, desc:String, icon:String, callback:() ‑> Void, flashColor:FlxColor = 0)

Variables

flashColor:FlxColor

Inherited Variables

Defined by IconOption

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file diff --git a/docs/funkin/options/type/GithubIconOption.html b/docs/funkin/options/type/GithubIconOption.html new file mode 100644 index 0000000..a842595 --- /dev/null +++ b/docs/funkin/options/type/GithubIconOption.html @@ -0,0 +1,10 @@ + + + +funkin.options.type.GithubIconOption

Constructor

@:value({ usePortrait : true, size : 96 })new(user:Dynamic, desc:String, ?callback:() ‑> Void, ?customName:String, size:Int = 96, usePortrait:Bool = true)

Variables

@:value(null)icon:GithubUserIcon = null

@:value(true)usePortrait:Bool = true

read onlyuser:Dynamic

Methods

set_usePortrait(value:Bool):Bool

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file diff --git a/docs/funkin/options/type/GithubUserIcon.html b/docs/funkin/options/type/GithubUserIcon.html new file mode 100644 index 0000000..3a40dad --- /dev/null +++ b/docs/funkin/options/type/GithubUserIcon.html @@ -0,0 +1,10 @@ + + + +funkin.options.type.GithubUserIcon

Constructor

@:value({ size : 96 })new(user:Dynamic, size:Int = 96)

Methods

inlineupdateDaFunni(graphic:FlxGraphic):Void

\ No newline at end of file diff --git a/docs/funkin/options/type/IconOption.html b/docs/funkin/options/type/IconOption.html index ff07342..e34a7a9 100644 --- a/docs/funkin/options/type/IconOption.html +++ b/docs/funkin/options/type/IconOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(name:String, desc:String, icon:String, callback:() ‑> Void)

Variables

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file +

Constructor

new(name:String, desc:String, icon:String, callback:() ‑> Void)

Variables

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file diff --git a/docs/funkin/options/type/NewOption.html b/docs/funkin/options/type/NewOption.html index 9cf8fea..ceea3c2 100644 --- a/docs/funkin/options/type/NewOption.html +++ b/docs/funkin/options/type/NewOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(name:String, desc:String, callback:() ‑> Void)

Variables

iconSpr:FlxSprite

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file +

Constructor

new(name:String, desc:String, callback:() ‑> Void)

Variables

iconSpr:FlxSprite

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file diff --git a/docs/funkin/options/type/NumOption.html b/docs/funkin/options/type/NumOption.html index c617d07..de8491e 100644 --- a/docs/funkin/options/type/NumOption.html +++ b/docs/funkin/options/type/NumOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ selectCallback : null })new(text:String, desc:String, min:Float, max:Float, changeVal:Float, optionName:String, ?selectCallback:Float ‑> Void, ?parent:Dynamic)

Variables

changeVal:Float

max:Float

min:Float

parent:Dynamic

text:String

selectCallback:Float ‑> Void

Methods

Inherited Variables

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by OptionType

onSelect():Void

\ No newline at end of file +

Constructor

@:value({ selectCallback : null })new(text:String, desc:String, min:Float, max:Float, changeVal:Float, optionName:String, ?selectCallback:Float ‑> Void, ?parent:Dynamic)

Variables

changeVal:Float

max:Float

min:Float

parent:Dynamic

text:String

selectCallback:Float ‑> Void

Methods

Inherited Variables

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by OptionType

onSelect():Void

\ No newline at end of file diff --git a/docs/funkin/options/type/OptionType.html b/docs/funkin/options/type/OptionType.html index b1d1396..5178c5e 100644 --- a/docs/funkin/options/type/OptionType.html +++ b/docs/funkin/options/type/OptionType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(desc:String)

Variables

desc:String

@:value(false)selected:Bool = false

Methods

onChangeSelection(change:Float):Void

onSelect():Void

\ No newline at end of file +

Constructor

new(desc:String)

Variables

desc:String

@:value(false)selected:Bool = false

Methods

onChangeSelection(change:Float):Void

onSelect():Void

\ No newline at end of file diff --git a/docs/funkin/options/type/PortraitOption.html b/docs/funkin/options/type/PortraitOption.html index 2e17cf8..00279df 100644 --- a/docs/funkin/options/type/PortraitOption.html +++ b/docs/funkin/options/type/PortraitOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ size : 96 })new(name:String, desc:String, callback:() ‑> Void, ?graphic:FlxGraphic, size:Int = 96)

Variables

@:value(null)portrait:FlxSprite = null

Methods

@:value({ size : 96 })addPortrait(graphic:FlxGraphic, size:Int = 96):Void

@:value({ size : 96 })loadFromGithub(user:GitHubContributor, size:Int = 96):Void

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file +

Constructor

@:value({ usePortrait : true, size : 96 })new(name:String, desc:String, callback:() ‑> Void, ?graphic:FlxGraphic, size:Int = 96, usePortrait:Bool = true)

Variables

@:value(null)portrait:FlxSprite = null

Methods

@:value({ usePortrait : true, size : 96 })addPortrait(graphic:FlxGraphic, size:Int = 96, usePortrait:Bool = true):Void

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by TextOption

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file diff --git a/docs/funkin/options/type/TextOption.html b/docs/funkin/options/type/TextOption.html index f211e59..f63ffe6 100644 --- a/docs/funkin/options/type/TextOption.html +++ b/docs/funkin/options/type/TextOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

new(text:String, desc:String, selectCallback:() ‑> Void)

Variables

text:String

selectCallback:() ‑> Void

Methods

Inherited Variables

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file +

Constructor

new(text:String, desc:String, selectCallback:() ‑> Void)

Variables

text:String

selectCallback:() ‑> Void

Methods

Inherited Variables

Defined by OptionType

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by OptionType

onChangeSelection(change:Float):Void

\ No newline at end of file diff --git a/docs/funkin/options/type/index.html b/docs/funkin/options/type/index.html index d7a6629..e28c7b1 100644 --- a/docs/funkin/options/type/index.html +++ b/docs/funkin/options/type/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/savedata/FunkinSave.html b/docs/funkin/savedata/FunkinSave.html index 2088c05..4b534d7 100644 --- a/docs/funkin/savedata/FunkinSave.html +++ b/docs/funkin/savedata/FunkinSave.html @@ -11,4 +11,4 @@ }

Class used for saves WITHOUT going through the struggle of type checks Just add your save variables the way you would do in the Options.hx file. -The macro will automatically generate the flush and load functions.

Static variables

@:value([])statichighscores:Map<HighscoreEntry, SongScore> = []

@:doNotSavestaticsave:FlxSave

Static methods

staticflush():Void

staticinlinegetSongHighscore(name:String, diff:String, ?changes:Array<HighscoreChange>):SongScore

Returns the high-score for a song.

Parameters:

name

Song name

diff

Song difficulty

changes

Changes made to that song in freeplay.

staticinlinegetWeekHighscore(name:String, diff:String):SongScore

staticinit():Void

staticload():Void

staticinlinesetSongHighscore(name:String, diff:String, highscore:SongScore, ?changes:Array<HighscoreChange>):Bool

staticinlinesetWeekHighscore(name:String, diff:String, highscore:SongScore):Bool

\ No newline at end of file +The macro will automatically generate the flush and load functions.

Static variables

@:value([])statichighscores:Map<HighscoreEntry, SongScore> = []

@:doNotSavestaticsave:FlxSave

Static methods

staticflush():Void

staticinlinegetSongHighscore(name:String, diff:String, ?changes:Array<HighscoreChange>):SongScore

Returns the high-score for a song.

Parameters:

name

Song name

diff

Song difficulty

changes

Changes made to that song in freeplay.

staticinlinegetWeekHighscore(name:String, diff:String):SongScore

staticinit():Void

staticload():Void

staticinlinesetSongHighscore(name:String, diff:String, highscore:SongScore, ?changes:Array<HighscoreChange>):Bool

staticinlinesetWeekHighscore(name:String, diff:String, highscore:SongScore):Bool

\ No newline at end of file diff --git a/docs/funkin/savedata/HighscoreChange.html b/docs/funkin/savedata/HighscoreChange.html index 4cbeea2..306135a 100644 --- a/docs/funkin/savedata/HighscoreChange.html +++ b/docs/funkin/savedata/HighscoreChange.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/funkin/savedata/HighscoreEntry.html b/docs/funkin/savedata/HighscoreEntry.html index 84dac37..64b3d33 100644 --- a/docs/funkin/savedata/HighscoreEntry.html +++ b/docs/funkin/savedata/HighscoreEntry.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Values

HWeekEntry(weekName:String, difficulty:String)

HSongEntry(songName:String, difficulty:String, changes:Array<HighscoreChange>)

\ No newline at end of file +

Values

HWeekEntry(weekName:String, difficulty:String)

HSongEntry(songName:String, difficulty:String, changes:Array<HighscoreChange>)

\ No newline at end of file diff --git a/docs/funkin/savedata/SongScore.html b/docs/funkin/savedata/SongScore.html index 7537270..3dd99df 100644 --- a/docs/funkin/savedata/SongScore.html +++ b/docs/funkin/savedata/SongScore.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

Fields

score:Int

misses:Int

hits:Map<String, Int>

date:String

accuracy:Float

\ No newline at end of file +

Fields

score:Int

misses:Int

hits:Map<String, Int>

date:String

accuracy:Float

\ No newline at end of file diff --git a/docs/funkin/savedata/index.html b/docs/funkin/savedata/index.html index c70d304..1a647ec 100644 --- a/docs/funkin/savedata/index.html +++ b/docs/funkin/savedata/index.html @@ -9,4 +9,4 @@ }

funkin.savedata

..
FunkinSave

Class used for saves WITHOUT going through the struggle of type checks Just add your save variables the way you would do in the Options.hx file. -The macro will automatically generate the flush and load functions.

HighscoreChange

HighscoreEntry

SongScore

\ No newline at end of file +The macro will automatically generate the flush and load functions.

HighscoreChange

HighscoreEntry

SongScore

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index df54b6e..4d10b86 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

top level

funkin
\ No newline at end of file +

top level

funkin
\ No newline at end of file diff --git a/docs/nav.js b/docs/nav.js index 5909c35..3a9d4d4 100644 --- a/docs/nav.js +++ b/docs/nav.js @@ -1 +1 @@ -var navContent=''; \ No newline at end of file +var navContent=''; \ No newline at end of file