diff --git a/assets/data/splashes/default.xml b/assets/data/splashes/default.xml new file mode 100644 index 00000000..bd3a5616 --- /dev/null +++ b/assets/data/splashes/default.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/assets/images/game/splashes/default.png b/assets/images/game/splashes/default.png new file mode 100644 index 00000000..d3b03ceb Binary files /dev/null and b/assets/images/game/splashes/default.png differ diff --git a/assets/images/game/splashes/default.xml b/assets/images/game/splashes/default.xml new file mode 100644 index 00000000..d7f90d98 --- /dev/null +++ b/assets/images/game/splashes/default.xml @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/buildnumber.txt b/buildnumber.txt index 6f6e5593..90c86a92 100644 --- a/buildnumber.txt +++ b/buildnumber.txt @@ -1 +1 @@ -2012 \ No newline at end of file +2028 \ No newline at end of file diff --git a/hmm.json b/hmm.json index 32090162..42c522cf 100644 --- a/hmm.json +++ b/hmm.json @@ -5,6 +5,11 @@ "type": "haxelib", "version": null }, + { + "name": "dox", + "type": "haxelib", + "version": null + }, { "name": "flixel-yc29", "type": "git", diff --git a/pages/404.html b/pages/404.html index 7ba6ab14..d14baff1 100644 --- a/pages/404.html +++ b/pages/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/pages/funkin/cutscenes/Cutscene.html b/pages/funkin/cutscenes/Cutscene.html index 2109db93..2679f08d 100644 --- a/pages/funkin/cutscenes/Cutscene.html +++ b/pages/funkin/cutscenes/Cutscene.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Cutscene

package funkin.cutscenes

extends MusicBeatSubstate

extended by ScriptedCutscene, VideoCutscene

@:build(hscript.UsingHandler.build())

Constructor

new(callback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class Cutscene

package funkin.cutscenes

extends MusicBeatSubstate

extended by ScriptedCutscene, VideoCutscene

@:build(hscript.UsingHandler.build())

Constructor

new(callback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/cutscenes/MP4Handler.html b/pages/funkin/cutscenes/MP4Handler.html index 1564bd19..d14b3f9e 100644 --- a/pages/funkin/cutscenes/MP4Handler.html +++ b/pages/funkin/cutscenes/MP4Handler.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MP4Handler

package funkin.cutscenes

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

bitmap:VlcBitmap

@:value(null)canvasHeight:Null<Int> = null

@:value(null)canvasWidth:Null<Int> = null

fillScreen:Bool

@:value(true)skippable:Bool = true

sprite:FlxSprite

stateCallback:FlxState

finishCallback:() ‑> Void

Methods

kill():Void

onVLCComplete():Void

@:value({ midSong : false, isFullscreen : false, isWindow : false, outputTo : null, repeat : false })playMP4(path:String, repeat:Bool = false, ?outputTo:FlxSprite, isWindow:Bool = false, isFullscreen:Bool = false, midSong:Bool = false):Void

\ No newline at end of file +

class MP4Handler

package funkin.cutscenes

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

bitmap:VlcBitmap

@:value(null)canvasHeight:Null<Int> = null

@:value(null)canvasWidth:Null<Int> = null

fillScreen:Bool

@:value(true)skippable:Bool = true

sprite:FlxSprite

stateCallback:FlxState

finishCallback:() ‑> Void

Methods

kill():Void

onVLCComplete():Void

@:value({ midSong : false, isFullscreen : false, isWindow : false, outputTo : null, repeat : false })playMP4(path:String, repeat:Bool = false, ?outputTo:FlxSprite, isWindow:Bool = false, isFullscreen:Bool = false, midSong:Bool = false):Void

\ No newline at end of file diff --git a/pages/funkin/cutscenes/ScriptedCutscene.html b/pages/funkin/cutscenes/ScriptedCutscene.html index 16fae566..2462cb77 100644 --- a/pages/funkin/cutscenes/ScriptedCutscene.html +++ b/pages/funkin/cutscenes/ScriptedCutscene.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ScriptedCutscene

package funkin.cutscenes

extends Cutscene › MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(scriptPath:String, callback:() ‑> Void)

Methods

startVideo(path:String, ?callback:() ‑> Void):Void

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class ScriptedCutscene

package funkin.cutscenes

extends Cutscene › MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(scriptPath:String, callback:() ‑> Void)

Methods

startVideo(path:String, ?callback:() ‑> Void):Void

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/cutscenes/VideoCutscene.html b/pages/funkin/cutscenes/VideoCutscene.html index ad8098e9..96bf7f28 100644 --- a/pages/funkin/cutscenes/VideoCutscene.html +++ b/pages/funkin/cutscenes/VideoCutscene.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class VideoCutscene

package funkin.cutscenes

extends Cutscene › MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(path:String, callback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class VideoCutscene

package funkin.cutscenes

extends Cutscene › MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(path:String, callback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/cutscenes/index.html b/pages/funkin/cutscenes/index.html index f214feed..21a0ef47 100644 --- a/pages/funkin/cutscenes/index.html +++ b/pages/funkin/cutscenes/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.cutscenes

..
Cutscene

MP4Handler

ScriptedCutscene

VideoCutscene

\ No newline at end of file +

funkin.cutscenes

..
Cutscene

MP4Handler

ScriptedCutscene

VideoCutscene

\ No newline at end of file diff --git a/pages/funkin/debug/AnimationDebug.html b/pages/funkin/debug/AnimationDebug.html index 1a04dc70..593a779c 100644 --- a/pages/funkin/debug/AnimationDebug.html +++ b/pages/funkin/debug/AnimationDebug.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class AnimationDebug

package funkin.debug

extends FlxState

@:build(hscript.UsingHandler.build())

DEBUG MODE

Constructor

@:value({ daAnim : "spooky" })new(daAnim:String = "spooky")

Methods

\ No newline at end of file +

class AnimationDebug

package funkin.debug

extends FlxState

@:build(hscript.UsingHandler.build())

DEBUG MODE

Constructor

@:value({ daAnim : "spooky" })new(daAnim:String = "spooky")

Methods

\ No newline at end of file diff --git a/pages/funkin/debug/index.html b/pages/funkin/debug/index.html index 735a5a32..63aaa1c5 100644 --- a/pages/funkin/debug/index.html +++ b/pages/funkin/debug/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.debug

..
AnimationDebug

DEBUG MODE

\ No newline at end of file +

funkin.debug

..
AnimationDebug

DEBUG MODE

\ No newline at end of file diff --git a/pages/funkin/desktop/DesktopMain.html b/pages/funkin/desktop/DesktopMain.html index d0aaa9f4..9bde3f61 100644 --- a/pages/funkin/desktop/DesktopMain.html +++ b/pages/funkin/desktop/DesktopMain.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class DesktopMain

package funkin.desktop

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(null)staticcontextMenu:ContextMenu = null

staticinstance:DesktopMain

staticmouseInput:MouseInput

@:value(null)statictheme:Theme = null

Static methods

staticinit():Void

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

oldScaleMode:BaseScaleMode

screenSize:FlxPoint

wallpaper:FlxSprite

windows:WindowGroup<Window>

Methods

focusWindow(window:Window):Void

layerCameras():Void

openWindow(content:WindowContent):Window

updateScreenRes():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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class DesktopMain

package funkin.desktop

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(null)staticcontextMenu:ContextMenu = null

staticinstance:DesktopMain

staticmouseInput:MouseInput

@:value(null)statictheme:Theme = null

Static methods

staticinit():Void

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

oldScaleMode:BaseScaleMode

screenSize:FlxPoint

wallpaper:FlxSprite

windows:WindowGroup<Window>

Methods

focusWindow(window:Window):Void

layerCameras():Void

openWindow(content:WindowContent):Window

updateScreenRes():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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/desktop/DesktopUtils.html b/pages/funkin/desktop/DesktopUtils.html index 1f1d2a99..21c5afd7 100644 --- a/pages/funkin/desktop/DesktopUtils.html +++ b/pages/funkin/desktop/DesktopUtils.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class DesktopUtils

package funkin.desktop

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticcopyProperties(spr1:FlxObject, spr2:FlxObject):Void

\ No newline at end of file +

class DesktopUtils

package funkin.desktop

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticcopyProperties(spr1:FlxObject, spr2:FlxObject):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/MouseInput.html b/pages/funkin/desktop/MouseInput.html index a8ff9f11..fc6a3fab 100644 --- a/pages/funkin/desktop/MouseInput.html +++ b/pages/funkin/desktop/MouseInput.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MouseInput

package funkin.desktop

import funkin.desktop.DesktopMain

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

@:value(false)justPressed:Bool = false

@:value(false)justPressedRight:Bool = false

@:value(false)justReleased:Bool = false

@:value(false)justReleasedRight:Bool = false

@:value(false)pressed:Bool = false

@:value(false)pressedRight:Bool = false

@:value(null)screenPos:FlxPoint = null

Methods

cancel():Void

overlaps(spr:FlxObject, ?camera:FlxCamera):Bool

overlapsRect(spr:FlxBasic, rect:FlxRect, ?camera:FlxCamera):Bool

set(pressed:Bool, justPressed:Bool, justReleased:Bool, pressedRight:Bool, justPressedRight:Bool, justReleasedRight:Bool):Void

\ No newline at end of file +

class MouseInput

package funkin.desktop

import funkin.desktop.DesktopMain

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

@:value(false)justPressed:Bool = false

@:value(false)justPressedRight:Bool = false

@:value(false)justReleased:Bool = false

@:value(false)justReleasedRight:Bool = false

@:value(false)pressed:Bool = false

@:value(false)pressedRight:Bool = false

@:value(null)screenPos:FlxPoint = null

Methods

cancel():Void

overlaps(spr:FlxObject, ?camera:FlxCamera):Bool

overlapsRect(spr:FlxBasic, rect:FlxRect, ?camera:FlxCamera):Bool

set(pressed:Bool, justPressed:Bool, justReleased:Bool, pressedRight:Bool, justPressedRight:Bool, justReleasedRight:Bool):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/Butt.html b/pages/funkin/desktop/editors/Butt.html index b0b790fa..c4349877 100644 --- a/pages/funkin/desktop/editors/Butt.html +++ b/pages/funkin/desktop/editors/Butt.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef Butt

package funkin.desktop.editors

import funkin.desktop.editors.MessageBox

@:build(hscript.UsingHandler.build())

Fields

label:String

@:optionaloptionalcallback:Null<() ‑> Void>

\ No newline at end of file +

typedef Butt

package funkin.desktop.editors

import funkin.desktop.editors.MessageBox

@:build(hscript.UsingHandler.build())

Fields

label:String

@:optionaloptionalcallback:Null<() ‑> Void>

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/CharacterEditor.html b/pages/funkin/desktop/editors/CharacterEditor.html index 4f01170d..b57d77f5 100644 --- a/pages/funkin/desktop/editors/CharacterEditor.html +++ b/pages/funkin/desktop/editors/CharacterEditor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class CharacterEditor

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(curCharacter:String)

Variables

camFollow:FlxObject

camHUD:FlxCamera

char:Character

curCharacter:String

tabView:TabView

Methods

setupTabView():Void

Inherited Variables

Defined by WindowContent

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowContent

onDesktopSizeChange(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file +

class CharacterEditor

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(curCharacter:String)

Variables

camFollow:FlxObject

camHUD:FlxCamera

char:Character

curCharacter:String

tabView:TabView

Methods

setupTabView():Void

Inherited Variables

Defined by WindowContent

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowContent

onDesktopSizeChange(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/EditorPlayState.html b/pages/funkin/desktop/editors/EditorPlayState.html index 2a6a7b1d..984c3cb2 100644 --- a/pages/funkin/desktop/editors/EditorPlayState.html +++ b/pages/funkin/desktop/editors/EditorPlayState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class EditorPlayState

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

afterStateShit():Void

beforeStateShit():Void

Inherited Variables

Defined by WindowContent

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowContent

onDesktopSizeChange(width:Int, height:Int):Void

onWindowResize(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file +

class EditorPlayState

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

afterStateShit():Void

beforeStateShit():Void

Inherited Variables

Defined by WindowContent

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowContent

onDesktopSizeChange(width:Int, height:Int):Void

onWindowResize(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/HelloWorld.html b/pages/funkin/desktop/editors/HelloWorld.html index 3e95a3a3..81600edc 100644 --- a/pages/funkin/desktop/editors/HelloWorld.html +++ b/pages/funkin/desktop/editors/HelloWorld.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class HelloWorld

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

@:value(false)coolAssMode:Bool = false

@:value(0)time:Float = 0

Methods

Inherited Variables

Defined by WindowContent

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowContent

onDesktopSizeChange(width:Int, height:Int):Void

onWindowResize(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file +

class HelloWorld

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

@:value(false)coolAssMode:Bool = false

@:value(0)time:Float = 0

Methods

Inherited Variables

Defined by WindowContent

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowContent

onDesktopSizeChange(width:Int, height:Int):Void

onWindowResize(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/MessageBox.html b/pages/funkin/desktop/editors/MessageBox.html index 0e06f850..f24cb7fe 100644 --- a/pages/funkin/desktop/editors/MessageBox.html +++ b/pages/funkin/desktop/editors/MessageBox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MessageBox

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(caption:String, message:String, icon:MessageBoxIcon, ?buttons:Array<OneOfTwo<String, Butt>>, ?callback:Int ‑> Void)

Variables

caption:String

message:String

msgIcon:MessageBoxIcon

@:value(null)callback:Int ‑> Void = null

Methods

Inherited Variables

Defined by WindowContent

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowContent

onDesktopSizeChange(width:Int, height:Int):Void

onWindowResize(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file +

class MessageBox

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(caption:String, message:String, icon:MessageBoxIcon, ?buttons:Array<OneOfTwo<String, Butt>>, ?callback:Int ‑> Void)

Variables

caption:String

message:String

msgIcon:MessageBoxIcon

@:value(null)callback:Int ‑> Void = null

Methods

Inherited Variables

Defined by WindowContent

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowContent

onDesktopSizeChange(width:Int, height:Int):Void

onWindowResize(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/MessageBoxIcon.html b/pages/funkin/desktop/editors/MessageBoxIcon.html index b528c286..f39729c8 100644 --- a/pages/funkin/desktop/editors/MessageBoxIcon.html +++ b/pages/funkin/desktop/editors/MessageBoxIcon.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract MessageBoxIcon(Int)

package funkin.desktop.editors

import funkin.desktop.editors.MessageBox

@:build(hscript.UsingHandler.build())@:enum

Variables

@:value(cast 1)@:impl@:enuminlineread onlyALERT:MessageBoxIcon = 1

@:value(cast 0)@:impl@:enuminlineread onlyERROR:MessageBoxIcon = 0

@:value(cast 2)@:impl@:enuminlineread onlyINFORMATION:MessageBoxIcon = 2

@:value(cast 3)@:impl@:enuminlineread onlyQUESTION:MessageBoxIcon = 3

\ No newline at end of file +

enum abstract MessageBoxIcon(Int)

package funkin.desktop.editors

import funkin.desktop.editors.MessageBox

@:build(hscript.UsingHandler.build())@:enum

Variables

@:value(cast 1)@:impl@:enuminlineread onlyALERT:MessageBoxIcon = 1

@:value(cast 0)@:impl@:enuminlineread onlyERROR:MessageBoxIcon = 0

@:value(cast 2)@:impl@:enuminlineread onlyINFORMATION:MessageBoxIcon = 2

@:value(cast 3)@:impl@:enuminlineread onlyQUESTION:MessageBoxIcon = 3

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/index.html b/pages/funkin/desktop/editors/index.html index 4ea655d6..2cfad82f 100644 --- a/pages/funkin/desktop/editors/index.html +++ b/pages/funkin/desktop/editors/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.desktop.editors

..
Butt

CharacterEditor

EditorPlayState

HelloWorld

MessageBox

MessageBoxIcon

\ No newline at end of file +

funkin.desktop.editors

..
Butt

CharacterEditor

EditorPlayState

HelloWorld

MessageBox

MessageBoxIcon

\ No newline at end of file diff --git a/pages/funkin/desktop/index.html b/pages/funkin/desktop/index.html index 8f41a312..efffc020 100644 --- a/pages/funkin/desktop/index.html +++ b/pages/funkin/desktop/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.desktop

..
editors
sprites
theme
windows
DesktopMain

DesktopUtils

MouseInput

\ No newline at end of file +

funkin.desktop

..
editors
sprites
theme
windows
DesktopMain

DesktopUtils

MouseInput

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/Button.html b/pages/funkin/desktop/sprites/Button.html index 7d263ce1..4b7e724c 100644 --- a/pages/funkin/desktop/sprites/Button.html +++ b/pages/funkin/desktop/sprites/Button.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Button

package funkin.desktop.sprites

extends FlxObject

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ text : "" })new(x:Float, y:Float, text:String = "", callback:() ‑> Void, ?normalButton:ThemeData, ?hoverButton:ThemeData, ?pressedButton:ThemeData, ?disabledButton:ThemeData)

Variables

@:value(false)disabled:Bool = false

disabledSprite:SpliceSprite

@:value(0)frame:Int = 0

hoverSprite:SpliceSprite

label:WindowText

normalSprite:SpliceSprite

pressedSprite:SpliceSprite

callback:() ‑> Void

Methods

resize(width:Float, height:Float):Void

\ No newline at end of file +

class Button

package funkin.desktop.sprites

extends FlxObject

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ text : "" })new(x:Float, y:Float, text:String = "", callback:() ‑> Void, ?normalButton:ThemeData, ?hoverButton:ThemeData, ?pressedButton:ThemeData, ?disabledButton:ThemeData)

Variables

@:value(false)disabled:Bool = false

disabledSprite:SpliceSprite

@:value(0)frame:Int = 0

hoverSprite:SpliceSprite

label:WindowText

normalSprite:SpliceSprite

pressedSprite:SpliceSprite

callback:() ‑> Void

Methods

resize(width:Float, height:Float):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/CheckState.html b/pages/funkin/desktop/sprites/CheckState.html index 5cfa4a0e..ebcb6ad7 100644 --- a/pages/funkin/desktop/sprites/CheckState.html +++ b/pages/funkin/desktop/sprites/CheckState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract CheckState(Null<Bool>)

package funkin.desktop.sprites

import funkin.desktop.sprites.Checkbox

@:build(hscript.UsingHandler.build())@:enum

Variables

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

@:value(cast true)@:impl@:enuminlineread onlyCHECKED:CheckState = true

@:value(cast false)@:impl@:enuminlineread onlyUNCHECKED:CheckState = false

\ No newline at end of file +

enum abstract CheckState(Null<Bool>)

package funkin.desktop.sprites

import funkin.desktop.sprites.Checkbox

@:build(hscript.UsingHandler.build())@:enum

Variables

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

@:value(cast true)@:impl@:enuminlineread onlyCHECKED:CheckState = true

@:value(cast false)@:impl@:enuminlineread onlyUNCHECKED:CheckState = false

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/Checkbox.html b/pages/funkin/desktop/sprites/Checkbox.html index 9d0b6956..8dc46afc 100644 --- a/pages/funkin/desktop/sprites/Checkbox.html +++ b/pages/funkin/desktop/sprites/Checkbox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Checkbox

package funkin.desktop.sprites

extends WindowText

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ checked : UNCHECKED })new(x:Float, y:Float, w:Float, t:String, checked:CheckState = UNCHECKED)

Variables

checkboxSprite:FlxSprite

@:value(UNCHECKED)checked:CheckState = UNCHECKED

@:value(false)disabled:Bool = false

Methods

Inherited Variables

Inherited Methods

Defined by WindowText

\ No newline at end of file +

class Checkbox

package funkin.desktop.sprites

extends WindowText

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ checked : UNCHECKED })new(x:Float, y:Float, w:Float, t:String, checked:CheckState = UNCHECKED)

Variables

checkboxSprite:FlxSprite

@:value(UNCHECKED)checked:CheckState = UNCHECKED

@:value(false)disabled:Bool = false

Methods

Inherited Variables

Inherited Methods

Defined by WindowText

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/SpliceSprite.html b/pages/funkin/desktop/sprites/SpliceSprite.html index 55735199..100ae542 100644 --- a/pages/funkin/desktop/sprites/SpliceSprite.html +++ b/pages/funkin/desktop/sprites/SpliceSprite.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class SpliceSprite

package funkin.desktop.sprites

extends FlxObject

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ right : 5, bottom : 5, top : 5, left : 5 })new(spr:FlxGraphicAsset, x:Float, y:Float, width:Float, height:Float, left:Float = 5, top:Float = 5, bottom:Float = 5, right:Float = 5)

Variables

__internalSprite:FlxSprite

@:value(new FlxSprite())bottom:FlxSprite = new FlxSprite()

@:value(new FlxSprite())bottomLeft:FlxSprite = new FlxSprite()

@:value(new FlxSprite())bottomRight:FlxSprite = new FlxSprite()

@:value(new FlxSprite())left:FlxSprite = new FlxSprite()

@:value(new FlxSprite())middle:FlxSprite = new FlxSprite()

@:value(new FlxSprite())right:FlxSprite = new FlxSprite()

@:value([0, 0, 0, 0])slice:Array<Int> = [0, 0, 0, 0]

@:value(new FlxSprite())top:FlxSprite = new FlxSprite()

@:value(new FlxSprite())topLeft:FlxSprite = new FlxSprite()

@:value(new FlxSprite())topRight:FlxSprite = new FlxSprite()

Methods

resize(width:Float, height:Float):Void

updateRects():Void

\ No newline at end of file +

class SpliceSprite

package funkin.desktop.sprites

extends FlxObject

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ right : 5, bottom : 5, top : 5, left : 5 })new(spr:FlxGraphicAsset, x:Float, y:Float, width:Float, height:Float, left:Float = 5, top:Float = 5, bottom:Float = 5, right:Float = 5)

Variables

__internalSprite:FlxSprite

@:value(new FlxSprite())bottom:FlxSprite = new FlxSprite()

@:value(new FlxSprite())bottomLeft:FlxSprite = new FlxSprite()

@:value(new FlxSprite())bottomRight:FlxSprite = new FlxSprite()

@:value(new FlxSprite())left:FlxSprite = new FlxSprite()

@:value(new FlxSprite())middle:FlxSprite = new FlxSprite()

@:value(new FlxSprite())right:FlxSprite = new FlxSprite()

@:value([0, 0, 0, 0])slice:Array<Int> = [0, 0, 0, 0]

@:value(new FlxSprite())top:FlxSprite = new FlxSprite()

@:value(new FlxSprite())topLeft:FlxSprite = new FlxSprite()

@:value(new FlxSprite())topRight:FlxSprite = new FlxSprite()

Methods

resize(width:Float, height:Float):Void

updateRects():Void

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/TabView.html b/pages/funkin/desktop/sprites/TabView.html index 88801bca..80394b19 100644 --- a/pages/funkin/desktop/sprites/TabView.html +++ b/pages/funkin/desktop/sprites/TabView.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class TabView

package funkin.desktop.sprites

extends WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, width:Float, height:Float, tabs:Array<String>)

Variables

bg:SpliceSprite

height:Float

@:value(0)selectedTab:Int = 0

tabBG:SpliceSprite

@:value([])tabButtons:Array<Button> = []

@:value([])tabs:Array<WindowGroup<FlxBasic>> = []

width:Float

Methods

resize(width:Float, height:Float):Void

switchTab(id:Int):Void

updateBG():Void

updateButtons():Void

Inherited Variables

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file +

class TabView

package funkin.desktop.sprites

extends WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, width:Float, height:Float, tabs:Array<String>)

Variables

bg:SpliceSprite

height:Float

@:value(0)selectedTab:Int = 0

tabBG:SpliceSprite

@:value([])tabButtons:Array<Button> = []

@:value([])tabs:Array<WindowGroup<FlxBasic>> = []

width:Float

Methods

resize(width:Float, height:Float):Void

switchTab(id:Int):Void

updateBG():Void

updateButtons():Void

Inherited Variables

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/WindowText.html b/pages/funkin/desktop/sprites/WindowText.html index d56f2d1d..d1f5171c 100644 --- a/pages/funkin/desktop/sprites/WindowText.html +++ b/pages/funkin/desktop/sprites/WindowText.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class WindowText

package funkin.desktop.sprites

extends FlxText

extended by Checkbox

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, w:Float, t:String)

Methods

applyFontSettings(data:ThemeData):Void

\ No newline at end of file +

class WindowText

package funkin.desktop.sprites

extends FlxText

extended by Checkbox

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, w:Float, t:String)

Methods

applyFontSettings(data:ThemeData):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/index.html b/pages/funkin/desktop/sprites/index.html index 0022223f..cf1f06dd 100644 --- a/pages/funkin/desktop/sprites/index.html +++ b/pages/funkin/desktop/sprites/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.desktop.sprites

..
Button

CheckState

Checkbox

SpliceSprite

TabView

WindowText

\ No newline at end of file +

funkin.desktop.sprites

..
Button

CheckState

Checkbox

SpliceSprite

TabView

WindowText

\ No newline at end of file diff --git a/pages/funkin/desktop/theme/Theme.html b/pages/funkin/desktop/theme/Theme.html index dc76ce32..018d6ce6 100644 --- a/pages/funkin/desktop/theme/Theme.html +++ b/pages/funkin/desktop/theme/Theme.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Theme

package funkin.desktop.theme

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticload(content:String):Theme

staticloadFromAssets(path:String):Theme

staticloadFromPath(path:String):Theme

Constructor

new(content:String)

Variables

@:value(new ThemeData())captionActive:ThemeData = new ThemeData()

@:value(new ThemeData())captionButtons:ThemeData = new ThemeData()

@:value(new ThemeData())captionInactive:ThemeData = new ThemeData()

@:value(new ThemeData())checkbox:ThemeData = new ThemeData()

CHECKBOX

@:value(new ThemeData())contextBackground:ThemeData = new ThemeData()

CONTEXT MENU

@:value(new ThemeData())contextOption:ThemeData = new ThemeData()

@:value(new ThemeData())disabledButton:ThemeData = new ThemeData()

@:value(new ThemeData())hoverButton:ThemeData = new ThemeData()

@:value(new ThemeData())normalButton:ThemeData = new ThemeData()

BUTTON

@:value(new ThemeData())pressedButton:ThemeData = new ThemeData()

@:value(new ThemeData())tabBackground:ThemeData = new ThemeData()

TABS

@:value(new ThemeData())tabButtonHover:ThemeData = new ThemeData()

@:value(new ThemeData())tabButtonPressed:ThemeData = new ThemeData()

@:value(new ThemeData())tabButtonSelected:ThemeData = new ThemeData()

@:value(new ThemeData())tabButtonUnselected:ThemeData = new ThemeData()

@:value(new ThemeData())window:ThemeData = new ThemeData()

CAPTION & WINDOW

\ No newline at end of file +

class Theme

package funkin.desktop.theme

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticload(content:String):Theme

staticloadFromAssets(path:String):Theme

staticloadFromPath(path:String):Theme

Constructor

new(content:String)

Variables

@:value(new ThemeData())captionActive:ThemeData = new ThemeData()

@:value(new ThemeData())captionButtons:ThemeData = new ThemeData()

@:value(new ThemeData())captionInactive:ThemeData = new ThemeData()

@:value(new ThemeData())checkbox:ThemeData = new ThemeData()

CHECKBOX

@:value(new ThemeData())contextBackground:ThemeData = new ThemeData()

CONTEXT MENU

@:value(new ThemeData())contextOption:ThemeData = new ThemeData()

@:value(new ThemeData())disabledButton:ThemeData = new ThemeData()

@:value(new ThemeData())hoverButton:ThemeData = new ThemeData()

@:value(new ThemeData())normalButton:ThemeData = new ThemeData()

BUTTON

@:value(new ThemeData())pressedButton:ThemeData = new ThemeData()

@:value(new ThemeData())tabBackground:ThemeData = new ThemeData()

TABS

@:value(new ThemeData())tabButtonHover:ThemeData = new ThemeData()

@:value(new ThemeData())tabButtonPressed:ThemeData = new ThemeData()

@:value(new ThemeData())tabButtonSelected:ThemeData = new ThemeData()

@:value(new ThemeData())tabButtonUnselected:ThemeData = new ThemeData()

@:value(new ThemeData())window:ThemeData = new ThemeData()

CAPTION & WINDOW

\ No newline at end of file diff --git a/pages/funkin/desktop/theme/ThemeData.html b/pages/funkin/desktop/theme/ThemeData.html index 1c99ae17..019c8604 100644 --- a/pages/funkin/desktop/theme/ThemeData.html +++ b/pages/funkin/desktop/theme/ThemeData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ThemeData

package funkin.desktop.theme

implements IFlxDestroyable

import funkin.desktop.theme.Theme

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

@:value(4)bottom:Float = 4

@:value(FlxColor.WHITE)color:FlxColor = FlxColor.WHITE

@:value(null)font:String = null

@:value(null)fontSize:Null<Float> = null

@:value(4)height:Float = 4

@:value(4)left:Float = 4

@:value(FlxPoint.get(0, 0))margin:FlxPoint = FlxPoint.get(0, 0)

@:value(FlxPoint.get(5, 5))offset:FlxPoint = FlxPoint.get(5, 5)

@:value(4)right:Float = 4

@:value(FlxPoint.get(20, 20))size:FlxPoint = FlxPoint.get(20, 20)

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

@:value(null)textColor:Null<FlxColor> = null

@:value(4)top:Float = 4

@:value(4)width:Float = 4

Methods

destroy():Void

\ No newline at end of file +

class ThemeData

package funkin.desktop.theme

implements IFlxDestroyable

import funkin.desktop.theme.Theme

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

@:value(4)bottom:Float = 4

@:value(FlxColor.WHITE)color:FlxColor = FlxColor.WHITE

@:value(null)font:String = null

@:value(null)fontSize:Null<Float> = null

@:value(4)height:Float = 4

@:value(4)left:Float = 4

@:value(FlxPoint.get(0, 0))margin:FlxPoint = FlxPoint.get(0, 0)

@:value(FlxPoint.get(5, 5))offset:FlxPoint = FlxPoint.get(5, 5)

@:value(4)right:Float = 4

@:value(FlxPoint.get(20, 20))size:FlxPoint = FlxPoint.get(20, 20)

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

@:value(null)textColor:Null<FlxColor> = null

@:value(4)top:Float = 4

@:value(4)width:Float = 4

Methods

destroy():Void

\ No newline at end of file diff --git a/pages/funkin/desktop/theme/index.html b/pages/funkin/desktop/theme/index.html index 866c343a..f3c859c8 100644 --- a/pages/funkin/desktop/theme/index.html +++ b/pages/funkin/desktop/theme/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.desktop.theme

..
Theme

ThemeData

\ No newline at end of file +

funkin.desktop.theme

..
Theme

ThemeData

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/ContextMenu.html b/pages/funkin/desktop/windows/ContextMenu.html index 41ecaea2..b58a39e7 100644 --- a/pages/funkin/desktop/windows/ContextMenu.html +++ b/pages/funkin/desktop/windows/ContextMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ContextMenu

package funkin.desktop.windows

extends WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, options:Array<ContextOption>, callback:Int ‑> Void)

Variables

bg:SpliceSprite

contextCamera:FlxCamera

@:value([])contextOptions:Array<ContextOption> = []

@:value([])selectionBGs:Array<FlxSprite> = []

@:value([])texts:Array<WindowText> = []

callback:Int ‑> Void

Methods

Inherited Variables

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file +

class ContextMenu

package funkin.desktop.windows

extends WindowGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, options:Array<ContextOption>, callback:Int ‑> Void)

Variables

bg:SpliceSprite

contextCamera:FlxCamera

@:value([])contextOptions:Array<ContextOption> = []

@:value([])selectionBGs:Array<FlxSprite> = []

@:value([])texts:Array<WindowText> = []

callback:Int ‑> Void

Methods

Inherited Variables

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/ContextOption.html b/pages/funkin/desktop/windows/ContextOption.html index 4172f405..45420b8e 100644 --- a/pages/funkin/desktop/windows/ContextOption.html +++ b/pages/funkin/desktop/windows/ContextOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef ContextOption

package funkin.desktop.windows

import funkin.desktop.windows.ContextMenu

@:build(hscript.UsingHandler.build())

Fields

name:String

@:optionaloptionaliconPath:Null<String>

@:optionaloptionaliconId:Null<Int>

@:optionaloptionalcallback:Null<() ‑> Void>

\ No newline at end of file +

typedef ContextOption

package funkin.desktop.windows

import funkin.desktop.windows.ContextMenu

@:build(hscript.UsingHandler.build())

Fields

name:String

@:optionaloptionaliconPath:Null<String>

@:optionaloptionaliconId:Null<Int>

@:optionaloptionalcallback:Null<() ‑> Void>

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/Window.html b/pages/funkin/desktop/windows/Window.html index 0d8324c2..19d79e7a 100644 --- a/pages/funkin/desktop/windows/Window.html +++ b/pages/funkin/desktop/windows/Window.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Window

package funkin.desktop.windows

extends FlxTypedGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(content:WindowContent)

Variables

@:value(true)canClose:Bool = true

@:value(false)canHelp:Bool = false

@:value(true)canMinimize:Bool = true

caption:WindowText

captionButtons:FlxTypedSpriteGroup<WindowCaptionButton>

content:WindowContent

@:value(null)curDialog:Window = null

dragHitbox:WindowDragHitbox

read onlyfocused:Bool

icon:FlxSprite

@:value(false)maximized:Bool = false

@:value(true)moveable:Bool = true

@:value(true)resizeable:Bool = true

@:value([])windowCameras:Array<WindowCam> = []

windowCaptionCamera:FlxCamera

windowFrame:SpliceSprite

@:value(0)windowHeight:Int = 0

windowInactiveFrame:SpliceSprite

@:value(0)windowWidth:Int = 0

Methods

@:value({ useResizeTechnique : true })addCamera(camera:FlxCamera, useResizeTechnique:Bool = true):Void

changeCaption(text:String):Void

close():Void

loadIcon(path:String):Void

maximize():Void

minimize():Void

move(x:Float, y:Float):Void

onDesktopSizeChange(width:Int, height:Int):Void

openDialog(window:Window):Void

@:value({ popout : false })popupCamera(cam:FlxCamera, popout:Bool = false, ?onFinish:FlxTween ‑> Void):Void

resize(width:Int, height:Int):Void

restore():Void

showMessage(caption:String, message:String, icon:MessageBoxIcon):Void

updateWindowFrame():Void

\ No newline at end of file +

class Window

package funkin.desktop.windows

extends FlxTypedGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(content:WindowContent)

Variables

@:value(true)canClose:Bool = true

@:value(false)canHelp:Bool = false

@:value(true)canMinimize:Bool = true

caption:WindowText

captionButtons:FlxTypedSpriteGroup<WindowCaptionButton>

content:WindowContent

@:value(null)curDialog:Window = null

dragHitbox:WindowDragHitbox

read onlyfocused:Bool

icon:FlxSprite

@:value(false)maximized:Bool = false

@:value(true)moveable:Bool = true

@:value(true)resizeable:Bool = true

@:value([])windowCameras:Array<WindowCam> = []

windowCaptionCamera:FlxCamera

windowFrame:SpliceSprite

@:value(0)windowHeight:Int = 0

windowInactiveFrame:SpliceSprite

@:value(0)windowWidth:Int = 0

Methods

@:value({ useResizeTechnique : true })addCamera(camera:FlxCamera, useResizeTechnique:Bool = true):Void

changeCaption(text:String):Void

close():Void

loadIcon(path:String):Void

maximize():Void

minimize():Void

move(x:Float, y:Float):Void

onDesktopSizeChange(width:Int, height:Int):Void

openDialog(window:Window):Void

@:value({ popout : false })popupCamera(cam:FlxCamera, popout:Bool = false, ?onFinish:FlxTween ‑> Void):Void

resize(width:Int, height:Int):Void

restore():Void

showMessage(caption:String, message:String, icon:MessageBoxIcon):Void

updateWindowFrame():Void

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/WindowCam.html b/pages/funkin/desktop/windows/WindowCam.html index e0376bae..053f62ed 100644 --- a/pages/funkin/desktop/windows/WindowCam.html +++ b/pages/funkin/desktop/windows/WindowCam.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef WindowCam

package funkin.desktop.windows

import funkin.desktop.windows.Window

@:build(hscript.UsingHandler.build())

Fields

width:Int

resizeScroll:Bool

height:Int

camera:FlxCamera

\ No newline at end of file +

typedef WindowCam

package funkin.desktop.windows

import funkin.desktop.windows.Window

@:build(hscript.UsingHandler.build())

Fields

width:Int

resizeScroll:Bool

height:Int

camera:FlxCamera

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/WindowCaptionButton.html b/pages/funkin/desktop/windows/WindowCaptionButton.html index 88c12033..ad0f70de 100644 --- a/pages/funkin/desktop/windows/WindowCaptionButton.html +++ b/pages/funkin/desktop/windows/WindowCaptionButton.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class WindowCaptionButton

package funkin.desktop.windows

extends FlxSprite

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(["close", "maximize", "minimize", "help", "restore"])staticanims:Array<String> = ["close", "maximize", "minimize", "help", "restore"]

Constructor

new(window:Window, i:Int)

Variables

icon:FlxSprite

window:Window

Methods

\ No newline at end of file +

class WindowCaptionButton

package funkin.desktop.windows

extends FlxSprite

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(["close", "maximize", "minimize", "help", "restore"])staticanims:Array<String> = ["close", "maximize", "minimize", "help", "restore"]

Constructor

new(window:Window, i:Int)

Variables

icon:FlxSprite

window:Window

Methods

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/WindowContent.html b/pages/funkin/desktop/windows/WindowContent.html index 0b32fadf..73d3cbef 100644 --- a/pages/funkin/desktop/windows/WindowContent.html +++ b/pages/funkin/desktop/windows/WindowContent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class WindowContent

package funkin.desktop.windows

extends WindowGroup

extended by CharacterEditor, EditorPlayState, HelloWorld, MessageBox

@:build(hscript.UsingHandler.build())

Constructor

new(caption:String, x:Float, y:Float, width:Int, height:Int)

Variables

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Methods

create():Void

onDesktopSizeChange(width:Int, height:Int):Void

onWindowResize(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Inherited Variables

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file +

class WindowContent

package funkin.desktop.windows

extends WindowGroup

extended by CharacterEditor, EditorPlayState, HelloWorld, MessageBox

@:build(hscript.UsingHandler.build())

Constructor

new(caption:String, x:Float, y:Float, width:Int, height:Int)

Variables

@:value(0)height:Int = 0

@:value("flixel/images/logo/default.png")icon:String = "flixel/images/logo/default.png"

@:value(null)parent:Window = null

@:value("Window")title:String = "Window"

@:value(0)width:Int = 0

@:value(0)winX:Float = 0

@:value(0)winY:Float = 0

@:value(null)windowCamera:FlxCamera = null

Methods

create():Void

onDesktopSizeChange(width:Int, height:Int):Void

onWindowResize(width:Int, height:Int):Void

setSize(width:Int, height:Int):Void

Inherited Variables

Defined by WindowGroup

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Inherited Methods

Defined by WindowGroup

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/WindowDragHitbox.html b/pages/funkin/desktop/windows/WindowDragHitbox.html index 67096cd7..03bdefe1 100644 --- a/pages/funkin/desktop/windows/WindowDragHitbox.html +++ b/pages/funkin/desktop/windows/WindowDragHitbox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class WindowDragHitbox

package funkin.desktop.windows

extends FlxObject

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(left:Float, top:Float, right:Float, height:Float)

Variables

@:value(false)dragging:Bool = false

left:Float

offset:FlxPoint

parent:Window

right:Float

top:Float

Methods

\ No newline at end of file +

class WindowDragHitbox

package funkin.desktop.windows

extends FlxObject

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(left:Float, top:Float, right:Float, height:Float)

Variables

@:value(false)dragging:Bool = false

left:Float

offset:FlxPoint

parent:Window

right:Float

top:Float

Methods

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/WindowGroup.html b/pages/funkin/desktop/windows/WindowGroup.html index a9a619c6..f52f1330 100644 --- a/pages/funkin/desktop/windows/WindowGroup.html +++ b/pages/funkin/desktop/windows/WindowGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class WindowGroup<T>

package funkin.desktop.windows

extends FlxTypedGroup

extended by TabView, ContextMenu, WindowContent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?MaxSize:Int)

Variables

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Methods

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file +

class WindowGroup<T>

package funkin.desktop.windows

extends FlxTypedGroup

extended by TabView, ContextMenu, WindowContent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?MaxSize:Int)

Variables

@:value(FlxPoint.get(0, 0))scrollFactor:FlxPoint = FlxPoint.get(0, 0)

@:value(true)updateScrolls:Bool = true

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Methods

updateAnchor(x:Float, y:Float, ?cameras:Array<FlxCamera>):Void

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/index.html b/pages/funkin/desktop/windows/index.html index 52ff199e..93cf4b33 100644 --- a/pages/funkin/desktop/windows/index.html +++ b/pages/funkin/desktop/windows/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.desktop.windows

..
ContextMenu

ContextOption

Window

WindowCam

WindowCaptionButton

WindowContent

WindowDragHitbox

WindowGroup

\ No newline at end of file +

funkin.desktop.windows

..
ContextMenu

ContextOption

Window

WindowCam

WindowCaptionButton

WindowContent

WindowDragHitbox

WindowGroup

\ No newline at end of file diff --git a/pages/funkin/editors/CharacterEditor.html b/pages/funkin/editors/CharacterEditor.html index 8bf7c05d..2cf0e735 100644 --- a/pages/funkin/editors/CharacterEditor.html +++ b/pages/funkin/editors/CharacterEditor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class CharacterEditor

package funkin.editors

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(char:String)

Variables

character:Character

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

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class CharacterEditor

package funkin.editors

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(char:String)

Variables

character:Character

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

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/editors/ChartingState.html b/pages/funkin/editors/ChartingState.html index 2e01efea..0c76a341 100644 --- a/pages/funkin/editors/ChartingState.html +++ b/pages/funkin/editors/ChartingState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ChartingState

package funkin.editors

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(0)staticlastSection:Int = 0

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class ChartingState

package funkin.editors

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(0)staticlastSection:Int = 0

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/editors/index.html b/pages/funkin/editors/index.html index fe69f435..e3897e95 100644 --- a/pages/funkin/editors/index.html +++ b/pages/funkin/editors/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.editors

..
CharacterEditor

ChartingState

\ No newline at end of file +

funkin.editors

..
CharacterEditor

ChartingState

\ No newline at end of file diff --git a/pages/funkin/game/Character.html b/pages/funkin/game/Character.html index 40be8d00..079071dc 100644 --- a/pages/funkin/game/Character.html +++ b/pages/funkin/game/Character.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Character

package funkin.game

extends FlxSprite

implements IOffsetCompatible, IBeatReceiver

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ switchAnims : true, isPlayer : false, character : "bf" })new(x:Float, y:Float, character:String = "bf", isPlayer:Bool = false, switchAnims:Bool = true)

Variables

animOffsets:Map<String, FlxPoint>

@:value(new FlxPoint(0, 0))cameraOffset:FlxPoint = new FlxPoint(0, 0)

@:value("bf")curCharacter:String = "bf"

@: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(false)debugMode:Bool = false

@: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(false)isGF:Bool = false

@:value(false)isPlayer:Bool = false

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

@:value(-5000)lastHit:Float = -5000

@:value(false)playerOffsets:Bool = false

script:Script

@:value(false)stunned:Bool = false

xml:Access

Methods

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

beatHit(curBeat:Int):Void

dance():Void

FOR GF DANCING SHIT

inlinegetCameraPosition():FlxPoint

inlinegetIcon():String

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

@:value({ Frame : 0, Reversed : false, suffix : "" })playSingAnim(direction:Int, suffix:String = "", Reversed:Bool = false, Frame:Int = 0):Void

stepHit(curStep:Int):Void

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

\ No newline at end of file +

class Character

package funkin.game

extends FlxSprite

implements IOffsetCompatible, IBeatReceiver

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ switchAnims : true, isPlayer : false, character : "bf" })new(x:Float, y:Float, character:String = "bf", isPlayer:Bool = false, switchAnims:Bool = true)

Variables

animOffsets:Map<String, FlxPoint>

@:value(new FlxPoint(0, 0))cameraOffset:FlxPoint = new FlxPoint(0, 0)

@:value("bf")curCharacter:String = "bf"

@: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(false)debugMode:Bool = false

@: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(false)isGF:Bool = false

@:value(false)isPlayer:Bool = false

@:value(DANCE)lastAnimContext:PlayAnimContext = DANCE

@:value(-5000)lastHit:Float = -5000

@:value(false)playerOffsets:Bool = false

script:Script

@:value(false)stunned:Bool = false

xml:Access

Methods

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

beatHit(curBeat:Int):Void

dance():Void

FOR GF DANCING SHIT

inlinegetCameraPosition():FlxPoint

inlinegetIcon():String

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

@:value({ Frame : 0, Reversed : false, suffix : "" })playSingAnim(direction:Int, suffix:String = "", Reversed:Bool = false, Frame:Int = 0):Void

stepHit(curStep:Int):Void

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

\ No newline at end of file diff --git a/pages/funkin/game/ComboRating.html b/pages/funkin/game/ComboRating.html index 790db6b8..54ffdc90 100644 --- a/pages/funkin/game/ComboRating.html +++ b/pages/funkin/game/ComboRating.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ComboRating

package funkin.game

import funkin.game.PlayState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(percent:Float, rating:String, color:FlxColor)

Variables

color:FlxColor

percent:Float

rating:String

\ No newline at end of file +

class ComboRating

package funkin.game

import funkin.game.PlayState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(percent:Float, rating:String, color:FlxColor)

Variables

color:FlxColor

percent:Float

rating:String

\ No newline at end of file diff --git a/pages/funkin/game/GameOverSubstate.html b/pages/funkin/game/GameOverSubstate.html index 8727a5a3..3b24e1eb 100644 --- a/pages/funkin/game/GameOverSubstate.html +++ b/pages/funkin/game/GameOverSubstate.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class GameOverSubstate

package funkin.game

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ retrySFX : "gameOverEnd", lossSFX : "gameOverSFX", gameOverSong : "gameOver", character : "bf-dead" })new(x:Float, y:Float, character:String = "bf-dead", gameOverSong:String = "gameOver", lossSFX:String = "gameOverSFX", retrySFX:String = "gameOverEnd")

Variables

characterName:String

gameOverSong:String

lossSFX:FlxSound

lossSFXName:String

retrySFX:String

Methods

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class GameOverSubstate

package funkin.game

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ retrySFX : "gameOverEnd", lossSFX : "gameOverSFX", gameOverSong : "gameOver", character : "bf-dead" })new(x:Float, y:Float, character:String = "bf-dead", gameOverSong:String = "gameOver", lossSFX:String = "gameOverSFX", retrySFX:String = "gameOverEnd")

Variables

characterName:String

gameOverSong:String

lossSFX:FlxSound

lossSFXName:String

retrySFX:String

Methods

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/game/HealthIcon.html b/pages/funkin/game/HealthIcon.html index 58ec08f5..13aed0ea 100644 --- a/pages/funkin/game/HealthIcon.html +++ b/pages/funkin/game/HealthIcon.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

class HealthIcon

package funkin.game

extends FlxSprite

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/game/Highscore.html b/pages/funkin/game/Highscore.html index 58e290b6..24561dea 100644 --- a/pages/funkin/game/Highscore.html +++ b/pages/funkin/game/Highscore.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Highscore

package funkin.game

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(new Map())staticsongScores:Map<String, SongScore> = new Map()

@:value(new Map())staticweekScores:Map<String, SongScore> = new Map()

Static methods

staticformatSong(song:String, diff:String):String

staticgetScore(song:String, diff:String):SongScore

staticgetWeekScore(week:String, diff:String):SongScore

staticload():Void

staticprepareScore(score:SongScore):SongScore

staticsave():Void

@:value({ diff : "normal" })staticsaveScore(song:String, score:SongScore, diff:String = "normal"):Void

@:value({ diff : "normal" })staticsaveWeekScore(weekName:String, score:SongScore, diff:String = "normal"):Void

\ No newline at end of file +

class Highscore

package funkin.game

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(new Map())staticsongScores:Map<String, SongScore> = new Map()

@:value(new Map())staticweekScores:Map<String, SongScore> = new Map()

Static methods

staticformatSong(song:String, diff:String):String

staticgetScore(song:String, diff:String):SongScore

staticgetWeekScore(week:String, diff:String):SongScore

staticload():Void

staticprepareScore(score:SongScore):SongScore

staticsave():Void

@:value({ diff : "normal" })staticsaveScore(song:String, score:SongScore, diff:String = "normal"):Void

@:value({ diff : "normal" })staticsaveWeekScore(weekName:String, score:SongScore, diff:String = "normal"):Void

\ No newline at end of file diff --git a/pages/funkin/game/HudCamera.html b/pages/funkin/game/HudCamera.html index 4d52cf1d..26a32f5f 100644 --- a/pages/funkin/game/HudCamera.html +++ b/pages/funkin/game/HudCamera.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class HudCamera

package funkin.game

extends FlxCamera

@:directlyUsed@:build(hscript.UsingHandler.build())

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 +

class HudCamera

package funkin.game

extends FlxCamera

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/game/Note.html b/pages/funkin/game/Note.html index 58c8f8a6..431553b1 100644 --- a/pages/funkin/game/Note.html +++ b/pages/funkin/game/Note.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

class Note

package funkin.game

extends FlxSprite

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(160 * 0.7)staticswagWidth:Float = 160 * 0.7

Constructor

@:value({ animSuffix : "", sustainNote : false, mustPress : true, noteType : 0 })new(strumTime:Float, noteData:Int, noteType:Int = 0, mustPress:Bool = true, ?prevNote:Note, sustainNote:Bool = false, animSuffix:String = "")

Variables

@:value(true)angleOffsets:Bool = true

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

@: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(true)flipSustain:Bool = true

@:value(false)isSustainNote:Bool = false

@:value(null)lastScrollSpeed:Null<Float> = null

@:value(1)latePressWindow:Float = 1

@:value(false)mustPress:Bool = false

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(0)stepLength:Float = 0

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 +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/pages/funkin/game/NoteGroup.html b/pages/funkin/game/NoteGroup.html index eda80aa7..f5e17f69 100644 --- a/pages/funkin/game/NoteGroup.html +++ b/pages/funkin/game/NoteGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class NoteGroup

package funkin.game

extends FlxTypedGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?MaxSize:Int)

Methods

addNotes(notes:Array<Note>):Void

sortNotes():Void

\ No newline at end of file +

class NoteGroup

package funkin.game

extends FlxTypedGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?MaxSize:Int)

Methods

addNotes(notes:Array<Note>):Void

sortNotes():Void

\ No newline at end of file diff --git a/pages/funkin/game/PlayState.html b/pages/funkin/game/PlayState.html index c11565fd..b1dbecba 100644 --- a/pages/funkin/game/PlayState.html +++ b/pages/funkin/game/PlayState.html @@ -9,4 +9,4 @@ }

class PlayState

package funkin.game

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())@:access(flixel.text.FlxText.FlxTextFormatRange)

Static variables

staticSONG:SwagSong

SONG METADATA

@:value(0)staticcampaignScore:Int = 0

Score for the current week.

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

@:value(false)staticisStoryMode:Bool = false

Whenever the song is being played in Story Mode.

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

The remaining songs in the Story Mode playlist.

@:value(null)staticstoryWeek:WeekData = null

The week data of the current week

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(true)camZooming:Bool = true

Whenever cam zooming is enabled.

@:value(4)camZoomingInterval:Int = 4

Interval of cam zooming (beats). For example: if set to 4, the camera will zoom every 4 beats.

@:value(true)canAccessDebugMenus:Bool = true

Whenever the player can press 7, 8 or 9 to access the debug menus.

@:value(true)canDie:Bool = true

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(false)comboBreaks:Bool = false

Whenever the misses should show "Combo Breaks" instead of "Misses"

comboGroup:FlxSpriteGroup

Group containing all of the combo sprites.

@:value([new ComboRating(0, "F", 0xFFFF4444), new ComboRating(0.1, "E", 0xFFFF8844), new ComboRating(0.2, "D", 0xFFFFAA44), new ComboRating(0.4, "C", 0xFFFFFF44), new ComboRating(0.6, "B", 0xFFAAFF44), new ComboRating(0.8, "A", 0xFF88FF44), new ComboRating(0.9, "S", 0xFF44FFFF), new ComboRating(1, "S++", 0xFF44FFFF)])comboRatings:Array<ComboRating> = [new ComboRating(0, "F", 0xFFFF4444), new ComboRating(0.1, "E", 0xFFFF8844), new ComboRating(0.2, "D", 0xFFFFAA44), new ComboRating(0.4, "C", 0xFFFFFF44), new ComboRating(0.6, "B", 0xFFAAFF44), new ComboRating(0.8, "A", 0xFF88FF44), new ComboRating(0.9, "S", 0xFF44FFFF), new ComboRating(1, "S++", 0xFF44FFFF)]

All combo ratings.

cpuStrums:FlxTypedGroup<Strum>

CPU strums.

curRating:ComboRating

Last rating (may be null)

read onlycurSection:SwagSection

Current section (can be null when using YoshiCrafter Engine charts).

@: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("")detailsPausedText:String = ""

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

@:value("")difficultyText: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("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

@:value(1)gfSpeed:Int = 1

Interval at which Girlfriend dances.

@:value(1)health:Float = 1

Current health. Goes from 0 to maxHealth (defaults to 2)

healthBar:FlxBar

Health bar.

healthBarBG:FlxSprite

Health bar background.

iconP1:HealthIcon

Player's icon

iconP2:HealthIcon

Opponent's icon

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

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

notes:NoteGroup

Group of all of the notes. Using forEach on this group will only loop through the first notes.

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

playerStrums:FlxTypedGroup<Strum>

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)songLength:Float = 0

@:value(0)songScore:Int = 0

The player's current score.

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

strumLineNotes:FlxTypedGroup<Strum>

All of the strum line notes.

@:value(0)totalAccuracyAmount:Float = 0

The total accuracy amount.

vocals:FlxSound

Vocals sound (Vocals.ogg).

Methods

@:value({ addAsDefaultIfUnknown : false })addNoteType(name:String, addAsDefaultIfUnknown:Bool = false):Int

countdown(swagCounter:Int):Void

Creates a fake countdown.

deleteNote(note:Note):Void

generateNotes(songData:SwagSong):Void

getNoteType(id:Int):String

get_curSection():SwagSection

nextSong():Void

pauseGame():Void

startCountdown():Void

startCutscene():Void

startEndCutscene():Void

updateDiscordStatus():Void

updateRating():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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

\ No newline at end of file +To set a scroll speed for a specific strum, use strum.scrollSpeed.

@:value(0)songLength:Float = 0

@:value(0)songScore:Int = 0

The player's current score.

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

strumLineNotes:FlxTypedGroup<Strum>

All of the strum line notes.

@:value(0)totalAccuracyAmount:Float = 0

The total accuracy amount.

vocals:FlxSound

Vocals sound (Vocals.ogg).

Methods

@:value({ addAsDefaultIfUnknown : false })addNoteType(name:String, addAsDefaultIfUnknown:Bool = false):Int

countdown(swagCounter:Int):Void

Creates a fake countdown.

deleteNote(note:Note):Void

generateNotes(songData:SwagSong):Void

getNoteType(id:Int):String

get_curSection():SwagSection

nextSong():Void

pauseGame():Void

startCountdown():Void

startCutscene():Void

startEndCutscene():Void

updateDiscordStatus():Void

updateRating():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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

\ No newline at end of file diff --git a/pages/funkin/game/SongScore.html b/pages/funkin/game/SongScore.html index 9fd126b8..1f0b20bb 100644 --- a/pages/funkin/game/SongScore.html +++ b/pages/funkin/game/SongScore.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef SongScore

package funkin.game

import funkin.game.Highscore

@:build(hscript.UsingHandler.build())

Fields

@:optionaloptionalscore:Null<Int>

@:optionaloptionalmisses:Null<Int>

@:optionaloptionalhits:Null<Map<String, Int>>

@:optionaloptionalaccuracy:Null<Float>

\ No newline at end of file +

typedef SongScore

package funkin.game

import funkin.game.Highscore

@:build(hscript.UsingHandler.build())

Fields

@:optionaloptionalscore:Null<Int>

@:optionaloptionalmisses:Null<Int>

@:optionaloptionalhits:Null<Map<String, Int>>

@:optionaloptionalaccuracy:Null<Float>

\ No newline at end of file diff --git a/pages/funkin/game/Stage.html b/pages/funkin/game/Stage.html index 1a13872a..90d4c6c5 100644 --- a/pages/funkin/game/Stage.html +++ b/pages/funkin/game/Stage.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Stage

package funkin.game

extends FlxBasic

implements IBeatReceiver

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(stage:String, ?state:FlxState)

Variables

stagePath:String

stageScript:Script

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

stageXML:Access

Methods

beatHit(curBeat:Int):Void

getSprite(name:String):Null<FlxSprite>

stepHit(curStep:Int):Void

\ No newline at end of file +

class Stage

package funkin.game

extends FlxBasic

implements IBeatReceiver

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(stage:String, ?state:FlxState)

Variables

stagePath:String

stageScript:Script

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

stageXML:Access

Methods

beatHit(curBeat:Int):Void

getSprite(name:String):Null<FlxSprite>

stepHit(curStep:Int):Void

\ No newline at end of file diff --git a/pages/funkin/game/Strum.html b/pages/funkin/game/Strum.html index b02ac69f..54795d5f 100644 --- a/pages/funkin/game/Strum.html +++ b/pages/funkin/game/Strum.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Strum

package funkin.game

extends FlxSprite

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

@:value(false)cpu:Bool = false

@:value([])read onlylastDrawCameras:Array<FlxCamera> = []

@:value(-5000)lastHit:Float = -5000

@:value(null)noteAngle:Null<Float> = null

@:value(null)scrollSpeed:Null<Float> = null

Methods

getAnim():Null<String>

getNotesAngle(?note:Note):Null<Float>

getScrollSpeed(?note:Note):Null<Float>

@:value({ force : true })playAnim(anim:String, force:Bool = true):Void

press(time:Float):Void

updateNotePosition(daNote:Note):Void

updatePlayerInput(pressed:Bool, justPressed:Bool, justReleased:Bool):Void

updateSustain(daNote:Note):Void

\ No newline at end of file +

class Strum

package funkin.game

extends FlxSprite

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

@:value(false)cpu:Bool = false

@:value([])read onlylastDrawCameras:Array<FlxCamera> = []

@:value(-5000)lastHit:Float = -5000

@:value(null)noteAngle:Null<Float> = null

@:value(null)scrollSpeed:Null<Float> = null

Methods

getAnim():Null<String>

getNotesAngle(?note:Note):Null<Float>

getScrollSpeed(?note:Note):Null<Float>

@:value({ force : true })playAnim(anim:String, force:Bool = true):Void

press(time:Float):Void

updateNotePosition(daNote:Note):Void

updatePlayerInput(pressed:Bool, justPressed:Bool, justReleased:Bool):Void

updateSustain(daNote:Note):Void

\ No newline at end of file diff --git a/pages/funkin/game/index.html b/pages/funkin/game/index.html index 54717636..779d2882 100644 --- a/pages/funkin/game/index.html +++ b/pages/funkin/game/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.game

..
Character

ComboRating

GameOverSubstate

HealthIcon

Highscore

HudCamera

Note

NoteGroup

PlayState

SongScore

Stage

Strum

\ No newline at end of file +

funkin.game

..
Character

ComboRating

GameOverSubstate

HealthIcon

Highscore

HudCamera

Note

NoteGroup

PlayState

SongScore

Stage

Strum

\ No newline at end of file diff --git a/pages/funkin/github/GitHub.html b/pages/funkin/github/GitHub.html index 090041d9..ff1fb219 100644 --- a/pages/funkin/github/GitHub.html +++ b/pages/funkin/github/GitHub.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class GitHub

package funkin.github

@:directlyUsed@:build(hscript.UsingHandler.build())

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 +

class GitHub

package funkin.github

@:directlyUsed@:build(hscript.UsingHandler.build())

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 diff --git a/pages/funkin/github/GitHubAsset.html b/pages/funkin/github/GitHubAsset.html index 4afaa0a3..4d6ead2d 100644 --- a/pages/funkin/github/GitHubAsset.html +++ b/pages/funkin/github/GitHubAsset.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef GitHubAsset

package funkin.github

@:build(hscript.UsingHandler.build())

Fields

url:String

uploader:GitHubUser

updated_at:String

state:String

size:UInt

node_id:String

name:String

label:String

id:Int

download_count:Int

created_at:String

content_type:String

browser_download_url:String

\ No newline at end of file +

typedef GitHubAsset

package funkin.github

@:build(hscript.UsingHandler.build())

Fields

url:String

uploader:GitHubUser

updated_at:String

state:String

size:UInt

node_id:String

name:String

label:String

id:Int

download_count:Int

created_at:String

content_type:String

browser_download_url:String

\ No newline at end of file diff --git a/pages/funkin/github/GitHubContributor.html b/pages/funkin/github/GitHubContributor.html index 0aca9cf0..51045526 100644 --- a/pages/funkin/github/GitHubContributor.html +++ b/pages/funkin/github/GitHubContributor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef GitHubContributor

package funkin.github

@:build(hscript.UsingHandler.build())

Fields

url:String

type:String

subscriptions_url:String

starred_url:String

site_admin:Bool

repos_url:String

received_events_url:String

organizations_url:String

node_id:String

login:String

id:Int

html_url:String

gravatar_id:String

gists_url:String

following_url:String

followers_url:String

events_url:String

contributions:Int

avatar_url:String

\ No newline at end of file +

typedef GitHubContributor

package funkin.github

@:build(hscript.UsingHandler.build())

Fields

url:String

type:String

subscriptions_url:String

starred_url:String

site_admin:Bool

repos_url:String

received_events_url:String

organizations_url:String

node_id:String

login:String

id:Int

html_url:String

gravatar_id:String

gists_url:String

following_url:String

followers_url:String

events_url:String

contributions:Int

avatar_url:String

\ No newline at end of file diff --git a/pages/funkin/github/GitHubException.html b/pages/funkin/github/GitHubException.html index ee12c6f2..6cd9cb84 100644 --- a/pages/funkin/github/GitHubException.html +++ b/pages/funkin/github/GitHubException.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class GitHubException

package funkin.github

extends Exception

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(apiMessage:String, documentationUrl:String)

Variables

apiMessage:String

documentationUrl:String

\ No newline at end of file +

class GitHubException

package funkin.github

extends Exception

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(apiMessage:String, documentationUrl:String)

Variables

apiMessage:String

documentationUrl:String

\ No newline at end of file diff --git a/pages/funkin/github/GitHubReactions.html b/pages/funkin/github/GitHubReactions.html index dcc4cd0f..79d316f3 100644 --- a/pages/funkin/github/GitHubReactions.html +++ b/pages/funkin/github/GitHubReactions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef GitHubReactions

package funkin.github

@:build(hscript.UsingHandler.build())

Fields

url:String

total_count:Int

rocket:Int

laugh:Int

hooray:Int

heart:Int

eyes:Int

confused:Int

\ No newline at end of file +

typedef GitHubReactions

package funkin.github

@:build(hscript.UsingHandler.build())

Fields

url:String

total_count:Int

rocket:Int

laugh:Int

hooray:Int

heart:Int

eyes:Int

confused:Int

\ No newline at end of file diff --git a/pages/funkin/github/GitHubRelease.html b/pages/funkin/github/GitHubRelease.html index af624c07..9f922c07 100644 --- a/pages/funkin/github/GitHubRelease.html +++ b/pages/funkin/github/GitHubRelease.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef GitHubRelease

package funkin.github

@:build(hscript.UsingHandler.build())

Fields

zipball_url:String

url:String

Url of the release (GitHub API)

upload_url:String

Template URL for asset download link.

target_commitish:String

tarball_url:String

tag_name:String

reactions:GitHubReactions

published_at:String

prerelease:Bool

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

assets:Array<GitHubAsset>

\ No newline at end of file +

typedef GitHubRelease

package funkin.github

@:build(hscript.UsingHandler.build())

Fields

zipball_url:String

url:String

Url of the release (GitHub API)

upload_url:String

Template URL for asset download link.

target_commitish:String

tarball_url:String

tag_name:String

reactions:GitHubReactions

published_at:String

prerelease:Bool

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

assets:Array<GitHubAsset>

\ No newline at end of file diff --git a/pages/funkin/github/GitHubUser.html b/pages/funkin/github/GitHubUser.html index 20ab1e84..9ff301be 100644 --- a/pages/funkin/github/GitHubUser.html +++ b/pages/funkin/github/GitHubUser.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef GitHubUser

package funkin.github

@:build(hscript.UsingHandler.build())

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 +

typedef GitHubUser

package funkin.github

@:build(hscript.UsingHandler.build())

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/pages/funkin/github/GitHubUserType.html b/pages/funkin/github/GitHubUserType.html index 91e3ca96..5f8a13ca 100644 --- a/pages/funkin/github/GitHubUserType.html +++ b/pages/funkin/github/GitHubUserType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract GitHubUserType(String)

package funkin.github

import funkin.github.GitHubUser

@:build(hscript.UsingHandler.build())@:enum

Variables

@:value(cast "Organization")@:impl@:enuminlineread onlyORGANIZATION:GitHubUserType = "Organization"

@:value(cast "User")@:impl@:enuminlineread onlyUSER:GitHubUserType = "User"

\ No newline at end of file +

enum abstract GitHubUserType(String)

package funkin.github

import funkin.github.GitHubUser

@:build(hscript.UsingHandler.build())@:enum

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/pages/funkin/github/index.html b/pages/funkin/github/index.html index 3c43c976..8b987d97 100644 --- a/pages/funkin/github/index.html +++ b/pages/funkin/github/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.github

..
GitHub

GitHubAsset

GitHubContributor

GitHubException

GitHubReactions

GitHubRelease

GitHubUser

GitHubUserType

\ No newline at end of file +

funkin.github

..
GitHub

GitHubAsset

GitHubContributor

GitHubException

GitHubReactions

GitHubRelease

GitHubUser

GitHubUserType

\ No newline at end of file diff --git a/pages/funkin/index.html b/pages/funkin/index.html index 47747929..9b9b68bc 100644 --- a/pages/funkin/index.html +++ b/pages/funkin/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin

..
cutscenes
debug
desktop
editors
game
github
interfaces
macros
menus
mods
multitasking
options
scripting
shaders
system
ui
updating
windows
\ No newline at end of file +

funkin

..
cutscenes
debug
desktop
editors
game
github
interfaces
macros
menus
mods
multitasking
options
scripting
shaders
system
ui
updating
windows
\ No newline at end of file diff --git a/pages/funkin/interfaces/IBeatReceiver.html b/pages/funkin/interfaces/IBeatReceiver.html index 49356115..05fb91f7 100644 --- a/pages/funkin/interfaces/IBeatReceiver.html +++ b/pages/funkin/interfaces/IBeatReceiver.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

interface IBeatReceiver

package funkin.interfaces

extended by Character, Stage, MusicBeatGroup, MusicBeatState, MusicBeatSubstate, XMLSprite

@:directlyUsed@:build(hscript.UsingHandler.build())

Methods

beatHit(curBeat:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file +

interface IBeatReceiver

package funkin.interfaces

extended by Character, Stage, MusicBeatGroup, MusicBeatState, MusicBeatSubstate, XMLSprite

@:directlyUsed@:build(hscript.UsingHandler.build())

Methods

beatHit(curBeat:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file diff --git a/pages/funkin/interfaces/IOffsetCompatible.html b/pages/funkin/interfaces/IOffsetCompatible.html index c3696b30..22bbb8f6 100644 --- a/pages/funkin/interfaces/IOffsetCompatible.html +++ b/pages/funkin/interfaces/IOffsetCompatible.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

interface IOffsetCompatible

package funkin.interfaces

extended by Character

@:directlyUsed@:build(hscript.UsingHandler.build())

Methods

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

\ No newline at end of file +

interface IOffsetCompatible

package funkin.interfaces

extended by Character

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/interfaces/index.html b/pages/funkin/interfaces/index.html index c7ab4fb6..a764b11b 100644 --- a/pages/funkin/interfaces/index.html +++ b/pages/funkin/interfaces/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.interfaces

..
IBeatReceiver

IOffsetCompatible

\ No newline at end of file +

funkin.interfaces

..
IBeatReceiver

IOffsetCompatible

\ No newline at end of file diff --git a/pages/funkin/macros/BuildCounterMacro.html b/pages/funkin/macros/BuildCounterMacro.html index 6da39288..d0225e0d 100644 --- a/pages/funkin/macros/BuildCounterMacro.html +++ b/pages/funkin/macros/BuildCounterMacro.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class BuildCounterMacro

package funkin.macros

@:build(hscript.UsingHandler.build())

\ No newline at end of file +

class BuildCounterMacro

package funkin.macros

@:build(hscript.UsingHandler.build())

\ No newline at end of file diff --git a/pages/funkin/macros/index.html b/pages/funkin/macros/index.html index ee21f67d..cafff7e0 100644 --- a/pages/funkin/macros/index.html +++ b/pages/funkin/macros/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.macros

..
BuildCounterMacro

\ No newline at end of file +

funkin.macros

..
BuildCounterMacro

\ No newline at end of file diff --git a/pages/funkin/menus/FreeplayJSON.html b/pages/funkin/menus/FreeplayJSON.html index 001b2c0b..763ff5b0 100644 --- a/pages/funkin/menus/FreeplayJSON.html +++ b/pages/funkin/menus/FreeplayJSON.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef FreeplayJSON

package funkin.menus

import funkin.menus.FreeplayState

@:build(hscript.UsingHandler.build())

Fields

songs:Array<FreeplaySong>

addOGSongs:Null<Bool>

\ No newline at end of file +

typedef FreeplayJSON

package funkin.menus

import funkin.menus.FreeplayState

@:build(hscript.UsingHandler.build())

Fields

songs:Array<FreeplaySong>

addOGSongs:Null<Bool>

\ No newline at end of file diff --git a/pages/funkin/menus/FreeplaySong.html b/pages/funkin/menus/FreeplaySong.html index 57a51209..b74435bd 100644 --- a/pages/funkin/menus/FreeplaySong.html +++ b/pages/funkin/menus/FreeplaySong.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef FreeplaySong

package funkin.menus

import funkin.menus.FreeplayState

@:build(hscript.UsingHandler.build())

Fields

name:String

icon:String

difficulties:Array<String>

color:Dynamic

\ No newline at end of file +

typedef FreeplaySong

package funkin.menus

import funkin.menus.FreeplayState

@:build(hscript.UsingHandler.build())

Fields

name:String

icon:String

difficulties:Array<String>

color:Dynamic

\ No newline at end of file diff --git a/pages/funkin/menus/FreeplaySonglist.html b/pages/funkin/menus/FreeplaySonglist.html index 5526afd2..91bd3aa4 100644 --- a/pages/funkin/menus/FreeplaySonglist.html +++ b/pages/funkin/menus/FreeplaySonglist.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class FreeplaySonglist

package funkin.menus

import funkin.menus.FreeplayState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticget():FreeplaySonglist

Constructor

new()

Variables

@:value(false)addOGSongs:Bool = false

@:value([])songs:Array<SongMetadata> = []

\ No newline at end of file +

class FreeplaySonglist

package funkin.menus

import funkin.menus.FreeplayState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticget():FreeplaySonglist

Constructor

new()

Variables

@:value(false)addOGSongs:Bool = false

@:value([])songs:Array<SongMetadata> = []

\ No newline at end of file diff --git a/pages/funkin/menus/FreeplayState.html b/pages/funkin/menus/FreeplayState.html index 061e559a..9b115608 100644 --- a/pages/funkin/menus/FreeplayState.html +++ b/pages/funkin/menus/FreeplayState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class FreeplayState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

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

Default background colors for songs without bg color

@:value(1)staticinlineread onlytimeUntilAutoplay:Float = 1

How much time a song stays selected until it autoplays.

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class FreeplayState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

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

Default background colors for songs without bg color

@:value(1)staticinlineread onlytimeUntilAutoplay:Float = 1

How much time a song stays selected until it autoplays.

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/GitarooPause.html b/pages/funkin/menus/GitarooPause.html index 588b595d..54c1ebc7 100644 --- a/pages/funkin/menus/GitarooPause.html +++ b/pages/funkin/menus/GitarooPause.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class GitarooPause

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class GitarooPause

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/IntroText.html b/pages/funkin/menus/IntroText.html index a03866e4..7ad7d059 100644 --- a/pages/funkin/menus/IntroText.html +++ b/pages/funkin/menus/IntroText.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class IntroText

package funkin.menus

import funkin.menus.TitleState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?lines:Array<OneOfTwo<String, TitleStateImage>>)

Variables

@:value([])lines:Array<OneOfTwo<String, TitleStateImage>> = []

Methods

show():Void

\ No newline at end of file +

class IntroText

package funkin.menus

import funkin.menus.TitleState

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/menus/MainMenuState.html b/pages/funkin/menus/MainMenuState.html index e15eede1..eb9a4e23 100644 --- a/pages/funkin/menus/MainMenuState.html +++ b/pages/funkin/menus/MainMenuState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MainMenuState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class MainMenuState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/MenuCharacter.html b/pages/funkin/menus/MenuCharacter.html index 39584588..0ded1e6a 100644 --- a/pages/funkin/menus/MenuCharacter.html +++ b/pages/funkin/menus/MenuCharacter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef MenuCharacter

package funkin.menus

import funkin.menus.StoryMenuState

@:build(hscript.UsingHandler.build())

Fields

xml:Access

spritePath:String

scale:Float

offset:FlxPoint

\ No newline at end of file +

typedef MenuCharacter

package funkin.menus

import funkin.menus.StoryMenuState

@:build(hscript.UsingHandler.build())

Fields

xml:Access

spritePath:String

scale:Float

offset:FlxPoint

\ No newline at end of file diff --git a/pages/funkin/menus/MenuCharacterSprite.html b/pages/funkin/menus/MenuCharacterSprite.html index 4b79d74b..b5e99e28 100644 --- a/pages/funkin/menus/MenuCharacterSprite.html +++ b/pages/funkin/menus/MenuCharacterSprite.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MenuCharacterSprite

package funkin.menus

extends FlxSprite

import funkin.menus.StoryMenuState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(pos:Int)

Variables

character:String

@:value(null)oldChar:MenuCharacter = null

Methods

changeCharacter(data:MenuCharacter):Void

\ No newline at end of file +

class MenuCharacterSprite

package funkin.menus

extends FlxSprite

import funkin.menus.StoryMenuState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(pos:Int)

Variables

character:String

@:value(null)oldChar:MenuCharacter = null

Methods

changeCharacter(data:MenuCharacter):Void

\ No newline at end of file diff --git a/pages/funkin/menus/MenuItem.html b/pages/funkin/menus/MenuItem.html index f47f4fc1..ea7c992c 100644 --- a/pages/funkin/menus/MenuItem.html +++ b/pages/funkin/menus/MenuItem.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MenuItem

package funkin.menus

extends FlxSprite

import funkin.menus.StoryMenuState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, path:String)

Variables

@:value(0)targetY:Float = 0

Methods

startFlashing():Void

\ No newline at end of file +

class MenuItem

package funkin.menus

extends FlxSprite

import funkin.menus.StoryMenuState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, path:String)

Variables

@:value(0)targetY:Float = 0

Methods

startFlashing():Void

\ No newline at end of file diff --git a/pages/funkin/menus/ModSwitchMenu.html b/pages/funkin/menus/ModSwitchMenu.html index 5546c6a1..67323298 100644 --- a/pages/funkin/menus/ModSwitchMenu.html +++ b/pages/funkin/menus/ModSwitchMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ModSwitchMenu

package funkin.menus

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class ModSwitchMenu

package funkin.menus

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/PauseSubState.html b/pages/funkin/menus/PauseSubState.html index 7e939b64..e97c6a31 100644 --- a/pages/funkin/menus/PauseSubState.html +++ b/pages/funkin/menus/PauseSubState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class PauseSubState

package funkin.menus

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

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

Constructor

new(x:Float, y:Float)

Variables

@:value(PlayState.instance)game:PlayState = PlayState.instance

pauseScript:Script

Methods

selectOption():Void

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class PauseSubState

package funkin.menus

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

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

Constructor

new(x:Float, y:Float)

Variables

@:value(PlayState.instance)game:PlayState = PlayState.instance

pauseScript:Script

Methods

selectOption():Void

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/SongMetadata.html b/pages/funkin/menus/SongMetadata.html index 3a58f70c..f6ae66b8 100644 --- a/pages/funkin/menus/SongMetadata.html +++ b/pages/funkin/menus/SongMetadata.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class SongMetadata

package funkin.menus

import funkin.menus.FreeplayState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ fromSource : false })new(song:String, songCharacter:String, color:FlxColor, ?difficulties:Array<String>, fromSource:Bool = false)

Variables

@:value(FreeplayState.defaultColor)color:FlxColor = FreeplayState.defaultColor

@:value(["EASY", "NORMAL", "HARD"])difficulties:Array<String> = ["EASY", "NORMAL", "HARD"]

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

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

\ No newline at end of file +

class SongMetadata

package funkin.menus

import funkin.menus.FreeplayState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ fromSource : false })new(song:String, songCharacter:String, color:FlxColor, ?difficulties:Array<String>, fromSource:Bool = false)

Variables

@:value(FreeplayState.defaultColor)color:FlxColor = FreeplayState.defaultColor

@:value(["EASY", "NORMAL", "HARD"])difficulties:Array<String> = ["EASY", "NORMAL", "HARD"]

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

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

\ No newline at end of file diff --git a/pages/funkin/menus/StoryMenuState.html b/pages/funkin/menus/StoryMenuState.html index 893e13fa..f7fb18d2 100644 --- a/pages/funkin/menus/StoryMenuState.html +++ b/pages/funkin/menus/StoryMenuState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class StoryMenuState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

blackBar:FlxSprite

@:value(true)canSelect:Bool = true

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

characterSprites:FlxTypedGroup<MenuCharacterSprite>

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

@:value({ force : false })changeDifficulty(change:Int, force:Bool = false):Void

@:value({ force : false })changeWeek(change:Int, force:Bool = false):Void

goBack():Void

loadXML(xmlPath:String):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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class StoryMenuState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

blackBar:FlxSprite

@:value(true)canSelect:Bool = true

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

characterSprites:FlxTypedGroup<MenuCharacterSprite>

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

@:value({ force : false })changeDifficulty(change:Int, force:Bool = false):Void

@:value({ force : false })changeWeek(change:Int, force:Bool = false):Void

goBack():Void

loadXML(xmlPath:String):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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/TitleState.html b/pages/funkin/menus/TitleState.html index 175232fc..951dd0ee 100644 --- a/pages/funkin/menus/TitleState.html +++ b/pages/funkin/menus/TitleState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class TitleState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())@:allow(funkin.mods.ModsFolder)

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 : "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 : "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

deleteCoolText():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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class TitleState

package funkin.menus

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())@:allow(funkin.mods.ModsFolder)

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 : "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 : "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

deleteCoolText():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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/TitleStateImage.html b/pages/funkin/menus/TitleStateImage.html index 7c6eea26..8fc83746 100644 --- a/pages/funkin/menus/TitleStateImage.html +++ b/pages/funkin/menus/TitleStateImage.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef TitleStateImage

package funkin.menus

import funkin.menus.TitleState

@:build(hscript.UsingHandler.build())

Fields

@:optionaloptionalscale:Null<Float>

path:String

name:String

@:optionaloptionalflipY:Null<Bool>

@:optionaloptionalflipX:Null<Bool>

\ No newline at end of file +

typedef TitleStateImage

package funkin.menus

import funkin.menus.TitleState

@:build(hscript.UsingHandler.build())

Fields

@:optionaloptionalscale:Null<Float>

path:String

name:String

@:optionaloptionalflipY:Null<Bool>

@:optionaloptionalflipX:Null<Bool>

\ No newline at end of file diff --git a/pages/funkin/menus/WeekData.html b/pages/funkin/menus/WeekData.html index 45b18aca..09789dee 100644 --- a/pages/funkin/menus/WeekData.html +++ b/pages/funkin/menus/WeekData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef WeekData

package funkin.menus

import funkin.menus.StoryMenuState

@:build(hscript.UsingHandler.build())

Fields

sprite:String

songs:Array<WeekSong>

name:String

difficulties:Array<String>

chars:Array<String>

\ No newline at end of file +

typedef WeekData

package funkin.menus

import funkin.menus.StoryMenuState

@:build(hscript.UsingHandler.build())

Fields

sprite:String

songs:Array<WeekSong>

name:String

difficulties:Array<String>

chars:Array<String>

\ No newline at end of file diff --git a/pages/funkin/menus/WeekSong.html b/pages/funkin/menus/WeekSong.html index 07594603..0ac4d2eb 100644 --- a/pages/funkin/menus/WeekSong.html +++ b/pages/funkin/menus/WeekSong.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef WeekSong

package funkin.menus

import funkin.menus.StoryMenuState

@:build(hscript.UsingHandler.build())

Fields

name:String

hide:Bool

\ No newline at end of file +

typedef WeekSong

package funkin.menus

import funkin.menus.StoryMenuState

@:build(hscript.UsingHandler.build())

Fields

name:String

hide:Bool

\ No newline at end of file diff --git a/pages/funkin/menus/credits/CreditsCodename.html b/pages/funkin/menus/credits/CreditsCodename.html index 3d4376a2..5b7ebec2 100644 --- a/pages/funkin/menus/credits/CreditsCodename.html +++ b/pages/funkin/menus/credits/CreditsCodename.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class CreditsCodename

package funkin.menus.credits

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(0)avatarLoadListId:Int = 0

@:value([])contributorsAvatars:Array<FlxGraphic> = []

@:value([])contributorsSprites:Array<FlxSprite> = []

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class CreditsCodename

package funkin.menus.credits

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?scriptsAllowed:Bool, ?scriptName:String)

Variables

@:value(0)avatarLoadListId:Int = 0

@:value([])contributorsAvatars:Array<FlxGraphic> = []

@:value([])contributorsSprites:Array<FlxSprite> = []

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/credits/CreditsMain.html b/pages/funkin/menus/credits/CreditsMain.html index 9d2751ab..40def9f6 100644 --- a/pages/funkin/menus/credits/CreditsMain.html +++ b/pages/funkin/menus/credits/CreditsMain.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class CreditsMain

package funkin.menus.credits

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class CreditsMain

package funkin.menus.credits

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/menus/credits/index.html b/pages/funkin/menus/credits/index.html index e803fb12..93c2d4f8 100644 --- a/pages/funkin/menus/credits/index.html +++ b/pages/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/pages/funkin/menus/index.html b/pages/funkin/menus/index.html index 771a3519..646aca92 100644 --- a/pages/funkin/menus/index.html +++ b/pages/funkin/menus/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.menus

..
credits
FreeplayJSON

FreeplaySong

FreeplaySonglist

FreeplayState

GitarooPause

IntroText

MainMenuState

MenuCharacter

MenuCharacterSprite

MenuItem

ModSwitchMenu

PauseSubState

SongMetadata

StoryMenuState

TitleState

TitleStateImage

WeekData

WeekSong

\ No newline at end of file +

funkin.menus

..
credits
FreeplayJSON

FreeplaySong

FreeplaySonglist

FreeplayState

GitarooPause

IntroText

MainMenuState

MenuCharacter

MenuCharacterSprite

MenuItem

ModSwitchMenu

PauseSubState

SongMetadata

StoryMenuState

TitleState

TitleStateImage

WeekData

WeekSong

\ No newline at end of file diff --git a/pages/funkin/mods/LimeLibrarySymbol.html b/pages/funkin/mods/LimeLibrarySymbol.html index b32f437b..45fd6da3 100644 --- a/pages/funkin/mods/LimeLibrarySymbol.html +++ b/pages/funkin/mods/LimeLibrarySymbol.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class LimeLibrarySymbol

package funkin.mods

@:build(hscript.UsingHandler.build())

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

Constructor

inlinenew(id:String)

Variables

library:AssetLibrary

libraryName:String

symbolName:String

Methods

inlineexists(?type:String):Bool

inlineisLocal(?type:String):Bool

\ No newline at end of file +

class LimeLibrarySymbol

package funkin.mods

@:build(hscript.UsingHandler.build())

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

Constructor

inlinenew(id:String)

Variables

library:AssetLibrary

libraryName:String

symbolName:String

Methods

inlineexists(?type:String):Bool

inlineisLocal(?type:String):Bool

\ No newline at end of file diff --git a/pages/funkin/mods/ModsAssetLibrary.html b/pages/funkin/mods/ModsAssetLibrary.html index 89fc5427..a5c56704 100644 --- a/pages/funkin/mods/ModsAssetLibrary.html +++ b/pages/funkin/mods/ModsAssetLibrary.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

interface ModsAssetLibrary

package funkin.mods

extended by ModsFolderLibrary, ZipFolderLibrary

@:directlyUsed@:build(hscript.UsingHandler.build())

Variables

_parsedAsset:String

libName:String

prefix:String

Methods

getFiles(folder:String):Array<String>

\ No newline at end of file +

interface ModsAssetLibrary

package funkin.mods

extended by ModsFolderLibrary, ZipFolderLibrary

@:directlyUsed@:build(hscript.UsingHandler.build())

Variables

_parsedAsset:String

libName:String

prefix:String

Methods

getFiles(folder:String):Array<String>

\ No newline at end of file diff --git a/pages/funkin/mods/ModsFolder.html b/pages/funkin/mods/ModsFolder.html index 0ca65417..b42a4d01 100644 --- a/pages/funkin/mods/ModsFolder.html +++ b/pages/funkin/mods/ModsFolder.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ModsFolder

package funkin.mods

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(null)staticcurrentModFolder:String = null

Current mod folder. Will affect Paths.

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

Map all loaded mods' folder libraries.

@: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 })staticloadMod(mod:String, force:Bool = false):AssetLibrary

Loads a mod with the specified name.

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:ModsAssetLibrary, force:Bool = false):AssetLibrary

staticswitchMod(mod:String):Void

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

Parameters:

null

libName

staticunloadMod(mod:String):Void

\ No newline at end of file +

class ModsFolder

package funkin.mods

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(null)staticcurrentModFolder:String = null

Current mod folder. Will affect Paths.

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

Map all loaded mods' folder libraries.

@: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 })staticloadMod(mod:String, force:Bool = false):AssetLibrary

Loads a mod with the specified name.

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:ModsAssetLibrary, force:Bool = false):AssetLibrary

staticswitchMod(mod:String):Void

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

Parameters:

null

libName

staticunloadMod(mod:String):Void

\ No newline at end of file diff --git a/pages/funkin/mods/ModsFolderLibrary.html b/pages/funkin/mods/ModsFolderLibrary.html index 25786bf6..3a67d458 100644 --- a/pages/funkin/mods/ModsFolderLibrary.html +++ b/pages/funkin/mods/ModsFolderLibrary.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ModsFolderLibrary

package funkin.mods

extends AssetLibrary

implements ModsAssetLibrary

@:directlyUsed@:build(hscript.UsingHandler.build())

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

getEditedTime(asset:String):Null<Float>

getFiles(folder:String):Array<String>

\ No newline at end of file +

class ModsFolderLibrary

package funkin.mods

extends AssetLibrary

implements ModsAssetLibrary

@:directlyUsed@:build(hscript.UsingHandler.build())

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

getEditedTime(asset:String):Null<Float>

getFiles(folder:String):Array<String>

\ No newline at end of file diff --git a/pages/funkin/mods/ZipFolderLibrary.html b/pages/funkin/mods/ZipFolderLibrary.html index 99f9f5a5..ce05a362 100644 --- a/pages/funkin/mods/ZipFolderLibrary.html +++ b/pages/funkin/mods/ZipFolderLibrary.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ZipFolderLibrary

package funkin.mods

extends AssetLibrary

implements ModsAssetLibrary

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticunzip(f:Entry):Null<Bytes>

Constructor

new(zipPath:String, libName:String)

Variables

_parsedAsset:String

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

libName:String

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

@:value(false)useImageCache:Bool = false

zip:Reader

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>

\ No newline at end of file +

class ZipFolderLibrary

package funkin.mods

extends AssetLibrary

implements ModsAssetLibrary

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticunzip(f:Entry):Null<Bytes>

Constructor

new(zipPath:String, libName:String)

Variables

_parsedAsset:String

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

libName:String

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

@:value(false)useImageCache:Bool = false

zip:Reader

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>

\ No newline at end of file diff --git a/pages/funkin/mods/index.html b/pages/funkin/mods/index.html index 62255cf9..ecb5cecb 100644 --- a/pages/funkin/mods/index.html +++ b/pages/funkin/mods/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.mods

..
LimeLibrarySymbol

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

ModsAssetLibrary

ModsFolder

ModsFolderLibrary

ZipFolderLibrary

\ No newline at end of file +

funkin.mods

..
LimeLibrarySymbol

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

ModsAssetLibrary

ModsFolder

ModsFolderLibrary

ZipFolderLibrary

\ No newline at end of file diff --git a/pages/funkin/multitasking/MultiTaskingHandler.html b/pages/funkin/multitasking/MultiTaskingHandler.html index f5496f84..c46f672d 100644 --- a/pages/funkin/multitasking/MultiTaskingHandler.html +++ b/pages/funkin/multitasking/MultiTaskingHandler.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MultiTaskingHandler

package funkin.multitasking

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value([])staticopenedWindows:Array<StateWindow> = []

Static methods

staticcloseWindow(window:StateWindow):Void

staticdraw():Void

staticinit():Void

staticopenWindow(name:String, state:MusicBeatState):Void

staticupdate():Void

\ No newline at end of file +

class MultiTaskingHandler

package funkin.multitasking

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value([])staticopenedWindows:Array<StateWindow> = []

Static methods

staticcloseWindow(window:StateWindow):Void

staticdraw():Void

staticinit():Void

staticopenWindow(name:String, state:MusicBeatState):Void

staticupdate():Void

\ No newline at end of file diff --git a/pages/funkin/multitasking/StateWindow.html b/pages/funkin/multitasking/StateWindow.html index 8c871d79..57993da2 100644 --- a/pages/funkin/multitasking/StateWindow.html +++ b/pages/funkin/multitasking/StateWindow.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class StateWindow

package funkin.multitasking

extends Sprite

@:directlyUsed@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())@:build(hscript.UsingHandler.build())

Constructor

new(windowName:String, state:MusicBeatState)

Variables

@:value(new BitmapFrontEnd())bmapFrontEnd:BitmapFrontEnd = new BitmapFrontEnd()

camera:FlxCamera

cameras:Array<FlxCamera>

camerasDefault:Array<FlxCamera>

state:MusicBeatState

window:Window

Methods

afterStateShit():Void

beforeStateShit():Void

draw():Void

update(elapsed:Float):Void

\ No newline at end of file +

class StateWindow

package funkin.multitasking

extends Sprite

@:directlyUsed@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())@:build(hscript.UsingHandler.build())

Constructor

new(windowName:String, state:MusicBeatState)

Variables

@:value(new BitmapFrontEnd())bmapFrontEnd:BitmapFrontEnd = new BitmapFrontEnd()

camera:FlxCamera

cameras:Array<FlxCamera>

camerasDefault:Array<FlxCamera>

state:MusicBeatState

window:Window

Methods

afterStateShit():Void

beforeStateShit():Void

draw():Void

update(elapsed:Float):Void

\ No newline at end of file diff --git a/pages/funkin/multitasking/index.html b/pages/funkin/multitasking/index.html index b4cb2bcc..3ce5e601 100644 --- a/pages/funkin/multitasking/index.html +++ b/pages/funkin/multitasking/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.multitasking

..
MultiTaskingHandler

StateWindow

\ No newline at end of file +

funkin.multitasking

..
MultiTaskingHandler

StateWindow

\ No newline at end of file diff --git a/pages/funkin/options/OptionCategory.html b/pages/funkin/options/OptionCategory.html index 3149e2e7..8c7a31c2 100644 --- a/pages/funkin/options/OptionCategory.html +++ b/pages/funkin/options/OptionCategory.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef OptionCategory

package funkin.options

import funkin.options.OptionsMenu

@:build(hscript.UsingHandler.build())

Fields

state:OneOfTwo<Class<FlxState>, FlxState>

name:String

desc:String

\ No newline at end of file +

typedef OptionCategory

package funkin.options

import funkin.options.OptionsMenu

@:build(hscript.UsingHandler.build())

Fields

state:OneOfTwo<Class<FlxState>, FlxState>

name:String

desc:String

\ No newline at end of file diff --git a/pages/funkin/options/Options.html b/pages/funkin/options/Options.html index 5272ebba..dcaae168 100644 --- a/pages/funkin/options/Options.html +++ b/pages/funkin/options/Options.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Options

package funkin.options

@:directlyUsed@:build(hscript.UsingHandler.build())

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([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([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 & SETTERS

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_UP:Array<FlxKey>

@:value(true)staticantialiasing:Bool = true

@:value(true)staticautoPause:Bool = true

@:value(false)staticbetaUpdates:Bool = false

@:value(true)staticcamZoomOnBeat:Bool = true

@:value(false)staticdownscroll:Bool = false

@:value(true)staticflashingMenu:Bool = true

@:value(true)staticfpsCounter:Bool = true

@:value(true)staticnaughtyness:Bool = true

SETTINGS

@:value(1)staticvolume:Float = 1

@:value(true)staticweek6PixelPerfect:Bool = true

Static methods

staticapplySettings():Void

staticload():Void

staticsave():Void

\ No newline at end of file +

class Options

package funkin.options

@:directlyUsed@:build(hscript.UsingHandler.build())

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([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([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 & SETTERS

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_UP:Array<FlxKey>

@:value(true)staticantialiasing:Bool = true

@:value(true)staticautoPause:Bool = true

@:value(false)staticbetaUpdates:Bool = false

@:value(true)staticcamZoomOnBeat:Bool = true

@:value(false)staticdownscroll:Bool = false

@:value(true)staticflashingMenu:Bool = true

@:value(true)staticfpsCounter:Bool = true

@:value(true)staticnaughtyness:Bool = true

SETTINGS

@:value(1)staticvolume:Float = 1

@:value(true)staticweek6PixelPerfect:Bool = true

Static methods

staticapplySettings():Void

staticload():Void

staticsave():Void

\ No newline at end of file diff --git a/pages/funkin/options/OptionsMenu.html b/pages/funkin/options/OptionsMenu.html index 30cbbb09..a15029f0 100644 --- a/pages/funkin/options/OptionsMenu.html +++ b/pages/funkin/options/OptionsMenu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class OptionsMenu

package funkin.options

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(false)staticfromPlayState:Bool = false

Constructor

new(?fromPlayState:Bool)

Variables

alphabets:FlxTypedGroup<Alphabet>

@:value(true)canSelect:Bool = true

@:value(-1)curSelected:Int = -1

@:value([{ name : "Controls", desc : "Change Controls for Player 1 and Player 2!", state : funkin.options.keybinds.KeybindsOptions }, { name : "Gameplay", desc : "Change Gameplay options such as Downscroll, Scroll Speed, Naughtyness...", state : GameplayOptions }, { name : "Behaviour", desc : "Change Behaviour options such as Flashing menus...", state : BehaviourOptions }, { name : "Miscellaneous", desc : "Use this menu to reset save data or engine settings.", state : MiscOptions }, { name : "Debug Options", desc : "Use this menu to change debug options.", state : DebugOptions }])options:Array<OptionCategory> = [{ name : "Controls", desc : "Change Controls for Player 1 and Player 2!", state : funkin.options.keybinds.KeybindsOptions }, { name : "Gameplay", desc : "Change Gameplay options such as Downscroll, Scroll Speed, Naughtyness...", state : GameplayOptions }, { name : "Behaviour", desc : "Change Behaviour options such as Flashing menus...", state : BehaviourOptions }, { name : "Miscellaneous", desc : "Use this menu to reset save data or engine settings.", state : MiscOptions }, { name : "Debug Options", desc : "Use this menu to change debug options.", state : DebugOptions }]

Methods

changeSelection(change:Int):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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class OptionsMenu

package funkin.options

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(false)staticfromPlayState:Bool = false

Constructor

new(?fromPlayState:Bool)

Variables

alphabets:FlxTypedGroup<Alphabet>

@:value(true)canSelect:Bool = true

@:value(-1)curSelected:Int = -1

@:value([{ name : "Controls", desc : "Change Controls for Player 1 and Player 2!", state : funkin.options.keybinds.KeybindsOptions }, { name : "Gameplay", desc : "Change Gameplay options such as Downscroll, Scroll Speed, Naughtyness...", state : GameplayOptions }, { name : "Behaviour", desc : "Change Behaviour options such as Flashing menus...", state : BehaviourOptions }, { name : "Miscellaneous", desc : "Use this menu to reset save data or engine settings.", state : MiscOptions }, { name : "Debug Options", desc : "Use this menu to change debug options.", state : DebugOptions }])options:Array<OptionCategory> = [{ name : "Controls", desc : "Change Controls for Player 1 and Player 2!", state : funkin.options.keybinds.KeybindsOptions }, { name : "Gameplay", desc : "Change Gameplay options such as Downscroll, Scroll Speed, Naughtyness...", state : GameplayOptions }, { name : "Behaviour", desc : "Change Behaviour options such as Flashing menus...", state : BehaviourOptions }, { name : "Miscellaneous", desc : "Use this menu to reset save data or engine settings.", state : MiscOptions }, { name : "Debug Options", desc : "Use this menu to change debug options.", state : DebugOptions }]

Methods

changeSelection(change:Int):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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/options/OptionsScreen.html b/pages/funkin/options/OptionsScreen.html index f6d30214..113c480d 100644 --- a/pages/funkin/options/OptionsScreen.html +++ b/pages/funkin/options/OptionsScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class OptionsScreen

package funkin.options

extends MusicBeatState

extended by CreditsMain, BehaviourOptions, DebugOptions, GameplayOptions, MiscOptions

@:build(hscript.UsingHandler.build())

Direct replica from Week 7 lol

Static variables

@:value(0xFFFDE871)staticinlineread onlydefaultBGColor:FlxColor = 0xFFFDE871

staticinstance:OptionsScreen

@:value(120)staticoptionHeight:Float = 120

Constructor

new()

Variables

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Methods

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class OptionsScreen

package funkin.options

extends MusicBeatState

extended by CreditsMain, BehaviourOptions, DebugOptions, GameplayOptions, MiscOptions

@:build(hscript.UsingHandler.build())

Direct replica from Week 7 lol

Static variables

@:value(0xFFFDE871)staticinlineread onlydefaultBGColor:FlxColor = 0xFFFDE871

staticinstance:OptionsScreen

@:value(120)staticoptionHeight:Float = 120

Constructor

new()

Variables

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Methods

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/options/PlayerSettings.html b/pages/funkin/options/PlayerSettings.html index 19c28aeb..f141e0fb 100644 --- a/pages/funkin/options/PlayerSettings.html +++ b/pages/funkin/options/PlayerSettings.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class PlayerSettings

package funkin.options

@:directlyUsed@:build(hscript.UsingHandler.build())

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

Static methods

staticinit():Void

staticreset():Void

Variables

finalcontrols:Controls

read onlyid:Int

Methods

setKeyboardScheme(scheme:KeyboardScheme):Void

\ No newline at end of file +

class PlayerSettings

package funkin.options

@:directlyUsed@:build(hscript.UsingHandler.build())

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

Static methods

staticinit():Void

staticreset():Void

Variables

finalcontrols:Controls

read onlyid:Int

Methods

setKeyboardScheme(scheme:KeyboardScheme):Void

\ No newline at end of file diff --git a/pages/funkin/options/categories/BehaviourOptions.html b/pages/funkin/options/categories/BehaviourOptions.html index 85583a2f..3bb9c942 100644 --- a/pages/funkin/options/categories/BehaviourOptions.html +++ b/pages/funkin/options/categories/BehaviourOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class BehaviourOptions

package funkin.options.categories

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class BehaviourOptions

package funkin.options.categories

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/options/categories/DebugOptions.html b/pages/funkin/options/categories/DebugOptions.html index dcdf419c..e518593b 100644 --- a/pages/funkin/options/categories/DebugOptions.html +++ b/pages/funkin/options/categories/DebugOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class DebugOptions

package funkin.options.categories

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class DebugOptions

package funkin.options.categories

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/options/categories/GameplayOptions.html b/pages/funkin/options/categories/GameplayOptions.html index 93d8a87f..212e46f4 100644 --- a/pages/funkin/options/categories/GameplayOptions.html +++ b/pages/funkin/options/categories/GameplayOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class GameplayOptions

package funkin.options.categories

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class GameplayOptions

package funkin.options.categories

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/options/categories/MiscOptions.html b/pages/funkin/options/categories/MiscOptions.html index 27a4e77f..b0e525e0 100644 --- a/pages/funkin/options/categories/MiscOptions.html +++ b/pages/funkin/options/categories/MiscOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MiscOptions

package funkin.options.categories

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class MiscOptions

package funkin.options.categories

extends OptionsScreen › MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Methods

Inherited Variables

Defined by OptionsScreen

bg:FlxSprite

@:value(-1)curSelected:Int = -1

descBG:FlxSprite

descDrop:FlxBackdrop

@:value(35)descSpeed:Float = 35

descText:FunkinText

@:value([])options:Array<OptionType> = []

@:value(FlxPoint.get(0, 0))scrollDest:FlxPoint = FlxPoint.get(0, 0)

Defined by MusicBeatState

@:value(false)cancelConductorUpdate:Bool = false

Whenever the Conductor auto update should be enabled or not.

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

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

changeSelection(change:Int):Void

exit():Void

updateDesc():Void

updateDescText(text:String):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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/options/categories/index.html b/pages/funkin/options/categories/index.html index 32af701d..579cba4e 100644 --- a/pages/funkin/options/categories/index.html +++ b/pages/funkin/options/categories/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.options.categories

..
BehaviourOptions

DebugOptions

GameplayOptions

MiscOptions

\ No newline at end of file +

funkin.options.categories

..
BehaviourOptions

DebugOptions

GameplayOptions

MiscOptions

\ No newline at end of file diff --git a/pages/funkin/options/index.html b/pages/funkin/options/index.html index 5f1b8468..413072a0 100644 --- a/pages/funkin/options/index.html +++ b/pages/funkin/options/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.options

..
categories
keybinds
type
OptionCategory

Options

OptionsMenu

OptionsScreen

Direct replica from Week 7 lol

PlayerSettings

\ No newline at end of file +

funkin.options

..
categories
keybinds
type
OptionCategory

Options

OptionsMenu

OptionsScreen

Direct replica from Week 7 lol

PlayerSettings

\ No newline at end of file diff --git a/pages/funkin/options/keybinds/ChangeKeybindSubState.html b/pages/funkin/options/keybinds/ChangeKeybindSubState.html index 42ee47ac..26c0ca8a 100644 --- a/pages/funkin/options/keybinds/ChangeKeybindSubState.html +++ b/pages/funkin/options/keybinds/ChangeKeybindSubState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ChangeKeybindSubState

package funkin.options.keybinds

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(callback:FlxKey ‑> Void, cancelCallback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class ChangeKeybindSubState

package funkin.options.keybinds

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(callback:FlxKey ‑> Void, cancelCallback:() ‑> Void)

Methods

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/options/keybinds/KeybindSetting.html b/pages/funkin/options/keybinds/KeybindSetting.html index 3ae61140..c4b84fc2 100644 --- a/pages/funkin/options/keybinds/KeybindSetting.html +++ b/pages/funkin/options/keybinds/KeybindSetting.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class KeybindSetting

package funkin.options.keybinds

extends FlxTypedSpriteGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, name:String, value:String, ?sparrowIcon:String, ?sparrowAnim:String)

Variables

bind1:Alphabet

bind2:Alphabet

@:value(-1)changingKeybind:Int = -1

icon:FlxSprite

option1:Null<FlxKey>

option2:Null<FlxKey>

@:value(false)p2Selected:Bool = false

title:Alphabet

value:String

Methods

@:value({ p2 : false })changeKeybind(callback:() ‑> Void, cancelCallback:() ‑> Void, p2:Bool = false):Void

updateText():Void

\ No newline at end of file +

class KeybindSetting

package funkin.options.keybinds

extends FlxTypedSpriteGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float, name:String, value:String, ?sparrowIcon:String, ?sparrowAnim:String)

Variables

bind1:Alphabet

bind2:Alphabet

@:value(-1)changingKeybind:Int = -1

icon:FlxSprite

option1:Null<FlxKey>

option2:Null<FlxKey>

@:value(false)p2Selected:Bool = false

title:Alphabet

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/pages/funkin/options/keybinds/KeybindsOptions.html b/pages/funkin/options/keybinds/KeybindsOptions.html index 23bbedaa..b4e1faba 100644 --- a/pages/funkin/options/keybinds/KeybindsOptions.html +++ b/pages/funkin/options/keybinds/KeybindsOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class KeybindsOptions

package funkin.options.keybinds

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

staticinstance:KeybindsOptions

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" }] }])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" }] }]

coloredBG:FlxSprite

@:value(-1)curSelected:Int = -1

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

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class KeybindsOptions

package funkin.options.keybinds

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

staticinstance:KeybindsOptions

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" }] }])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" }] }]

coloredBG:FlxSprite

@:value(-1)curSelected:Int = -1

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

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/options/keybinds/index.html b/pages/funkin/options/keybinds/index.html index 3ce09fcc..081b6adc 100644 --- a/pages/funkin/options/keybinds/index.html +++ b/pages/funkin/options/keybinds/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.options.keybinds

..
ChangeKeybindSubState

KeybindSetting

KeybindsOptions

\ No newline at end of file +

funkin.options.keybinds

..
ChangeKeybindSubState

KeybindSetting

KeybindsOptions

\ No newline at end of file diff --git a/pages/funkin/options/type/Checkbox.html b/pages/funkin/options/type/Checkbox.html index bdd7e104..98de4eb6 100644 --- a/pages/funkin/options/type/Checkbox.html +++ b/pages/funkin/options/type/Checkbox.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Checkbox

package funkin.options.type

extends TextOption › OptionType

@:directlyUsed@:build(hscript.UsingHandler.build())@:allow

Constructor

new(text:String, desc:String, optionName:String)

Variables

checkbox:FlxSprite

checked:Bool

optionName:String

Methods

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

read onlycontrols:Controls

desc:String

@:value(false)selected:Bool = false

Inherited Methods

\ No newline at end of file +

class Checkbox

package funkin.options.type

extends TextOption › OptionType

@:directlyUsed@:build(hscript.UsingHandler.build())@:allow

Constructor

new(text:String, desc:String, optionName:String)

Variables

checkbox:FlxSprite

checked:Bool

optionName:String

Methods

Inherited Variables

Defined by TextOption

selectCallback:() ‑> Void

text:String

Defined by OptionType

read onlycontrols:Controls

desc:String

@:value(false)selected:Bool = false

Inherited Methods

\ No newline at end of file diff --git a/pages/funkin/options/type/OptionType.html b/pages/funkin/options/type/OptionType.html index 1072f6b6..013d5df4 100644 --- a/pages/funkin/options/type/OptionType.html +++ b/pages/funkin/options/type/OptionType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class OptionType

package funkin.options.type

extends FlxTypedSpriteGroup

extended by TextOption

@:build(hscript.UsingHandler.build())

Constructor

new(desc:String)

Variables

read onlycontrols:Controls

desc:String

@:value(false)selected:Bool = false

Methods

onSelect():Void

\ No newline at end of file +

class OptionType

package funkin.options.type

extends FlxTypedSpriteGroup

extended by TextOption

@:build(hscript.UsingHandler.build())

Constructor

new(desc:String)

Variables

read onlycontrols:Controls

desc:String

@:value(false)selected:Bool = false

Methods

onSelect():Void

\ No newline at end of file diff --git a/pages/funkin/options/type/TextOption.html b/pages/funkin/options/type/TextOption.html index 40f1342d..37faba61 100644 --- a/pages/funkin/options/type/TextOption.html +++ b/pages/funkin/options/type/TextOption.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class TextOption

package funkin.options.type

extends OptionType

extended by Checkbox

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(text:String, desc:String, selectCallback:() ‑> Void)

Variables

text:String

selectCallback:() ‑> Void

Methods

Inherited Variables

Defined by OptionType

read onlycontrols:Controls

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by OptionType

\ No newline at end of file +

class TextOption

package funkin.options.type

extends OptionType

extended by Checkbox

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(text:String, desc:String, selectCallback:() ‑> Void)

Variables

text:String

selectCallback:() ‑> Void

Methods

Inherited Variables

Defined by OptionType

read onlycontrols:Controls

desc:String

@:value(false)selected:Bool = false

Inherited Methods

Defined by OptionType

\ No newline at end of file diff --git a/pages/funkin/options/type/index.html b/pages/funkin/options/type/index.html index 9c61a06c..212b1f97 100644 --- a/pages/funkin/options/type/index.html +++ b/pages/funkin/options/type/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.options.type

..
Checkbox

OptionType

TextOption

\ No newline at end of file +

funkin.options.type

..
Checkbox

OptionType

TextOption

\ No newline at end of file diff --git a/pages/funkin/scripting/DummyScript.html b/pages/funkin/scripting/DummyScript.html index d54c64d2..2c4ebf74 100644 --- a/pages/funkin/scripting/DummyScript.html +++ b/pages/funkin/scripting/DummyScript.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

class DummyScript

package funkin.scripting

extends Script

@:directlyUsed@:build(hscript.UsingHandler.build())

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.instace 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 +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/pages/funkin/scripting/GlobalScript.html b/pages/funkin/scripting/GlobalScript.html index fabe52f8..dc74a974 100644 --- a/pages/funkin/scripting/GlobalScript.html +++ b/pages/funkin/scripting/GlobalScript.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class GlobalScript

package funkin.scripting

@:directlyUsed@:build(hscript.UsingHandler.build())

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

Static variables

staticscript:Script

Static methods

staticbeatHit(curBeat:Int):Void

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

staticinit():Void

staticonModSwitch(newMod:String):Void

staticstepHit(curStep:Int):Void

\ No newline at end of file +

class GlobalScript

package funkin.scripting

@:directlyUsed@:build(hscript.UsingHandler.build())

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

Static variables

staticscript:Script

Static methods

staticbeatHit(curBeat:Int):Void

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

staticinit():Void

staticonModSwitch(newMod:String):Void

staticstepHit(curStep:Int):Void

\ No newline at end of file diff --git a/pages/funkin/scripting/HScript.html b/pages/funkin/scripting/HScript.html index 4ef769da..0653c5b3 100644 --- a/pages/funkin/scripting/HScript.html +++ b/pages/funkin/scripting/HScript.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class HScript

package funkin.scripting

extends Script

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(path:String)

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

onDestroy():Void

\ No newline at end of file +

class HScript

package funkin.scripting

extends Script

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(path:String)

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

onDestroy():Void

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

class ModState

package funkin.scripting

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class ModState

package funkin.scripting

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/scripting/ModSubState.html b/pages/funkin/scripting/ModSubState.html index 604ac7eb..6ab11b2e 100644 --- a/pages/funkin/scripting/ModSubState.html +++ b/pages/funkin/scripting/ModSubState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ModSubState

package funkin.scripting

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(scriptName:String)

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class ModSubState

package funkin.scripting

extends MusicBeatSubstate

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(scriptName:String)

Inherited Variables

Defined by MusicBeatSubstate

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/scripting/Script.html b/pages/funkin/scripting/Script.html index a73ba4cf..77207469 100644 --- a/pages/funkin/scripting/Script.html +++ b/pages/funkin/scripting/Script.html @@ -9,4 +9,4 @@ }

class Script

package funkin.scripting

extends FlxBasic

implements IFlxDestroyable

extended by DummyScript, HScript, ScriptPack

@:directlyUsed@:build(hscript.UsingHandler.build())

Class used for scripting.

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 youre 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():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.instace 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 +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/pages/funkin/scripting/ScriptPack.html b/pages/funkin/scripting/ScriptPack.html index 07a502a7..f0433ca3 100644 --- a/pages/funkin/scripting/ScriptPack.html +++ b/pages/funkin/scripting/ScriptPack.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

class ScriptPack

package funkin.scripting

extends Script

@:directlyUsed@:build(hscript.UsingHandler.build())@:access(CancellableEvent)

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

event<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 +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/pages/funkin/scripting/events/CamMoveEvent.html b/pages/funkin/scripting/events/CamMoveEvent.html index fef0ba8d..a642be7e 100644 --- a/pages/funkin/scripting/events/CamMoveEvent.html +++ b/pages/funkin/scripting/events/CamMoveEvent.html @@ -12,4 +12,4 @@ 0.5 = Duet Camera 1 = Camera focuses BF

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/CancellableEvent.html b/pages/funkin/scripting/events/CancellableEvent.html index 415aa2b8..0a3a4abb 100644 --- a/pages/funkin/scripting/events/CancellableEvent.html +++ b/pages/funkin/scripting/events/CancellableEvent.html @@ -10,4 +10,4 @@

class CancellableEvent

package funkin.scripting.events

extended by CamMoveEvent, CountdownEvent, DanceEvent, DirectionAnimEvent, InputSystemEvent, MenuChangeEvent, NameEvent, NoteCreationEvent, NoteHitEvent, NoteUpdateEvent, PauseCreationEvent, PlayAnimEvent, PointEvent, RatingUpdateEvent, ResizeEvent, SimpleNoteEvent, StateEvent, StrumCreationEvent, WeekSelectEvent

@:directlyUsed@:build(hscript.UsingHandler.build())@:allow(ScriptPack)

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

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/CountdownEvent.html b/pages/funkin/scripting/events/CountdownEvent.html index 742833bc..bfe931a6 100644 --- a/pages/funkin/scripting/events/CountdownEvent.html +++ b/pages/funkin/scripting/events/CountdownEvent.html @@ -9,4 +9,4 @@ }

class CountdownEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ antialiasing : true, volume : 1, scale : 1 })new(swagCounter:Int, spritePath:String, soundPath:String, scale:Float = 1, volume:Float = 1, antialiasing:Bool = true)

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.

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/DanceEvent.html b/pages/funkin/scripting/events/DanceEvent.html index 8f48414e..81eb8cd1 100644 --- a/pages/funkin/scripting/events/DanceEvent.html +++ b/pages/funkin/scripting/events/DanceEvent.html @@ -9,4 +9,4 @@ }

class DanceEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ danced : false })new(danced:Bool = false)

Variables

danced:Bool

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/DirectionAnimEvent.html b/pages/funkin/scripting/events/DirectionAnimEvent.html index da5cba14..9536d7aa 100644 --- a/pages/funkin/scripting/events/DirectionAnimEvent.html +++ b/pages/funkin/scripting/events/DirectionAnimEvent.html @@ -9,4 +9,4 @@ }

class DirectionAnimEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ frame : 0, reversed : false, suffix : "" })new(animName:String, direction:Int, suffix:String = "", reversed:Bool = false, frame:Int = 0)

Variables

animName:String

Default animation that will be played

direction:Int

In which direction the animation will be played

force:Bool

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

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/InputSystemEvent.html b/pages/funkin/scripting/events/InputSystemEvent.html index be849c44..fd6127e0 100644 --- a/pages/funkin/scripting/events/InputSystemEvent.html +++ b/pages/funkin/scripting/events/InputSystemEvent.html @@ -12,4 +12,4 @@ For example, justPressed[0] will return whenever the left strum was 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.

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/MenuChangeEvent.html b/pages/funkin/scripting/events/MenuChangeEvent.html index f3892f88..6b1d90a0 100644 --- a/pages/funkin/scripting/events/MenuChangeEvent.html +++ b/pages/funkin/scripting/events/MenuChangeEvent.html @@ -9,4 +9,4 @@ }

class MenuChangeEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(oldValue:Int, value:Int, change:Int)

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

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/NameEvent.html b/pages/funkin/scripting/events/NameEvent.html index 595d1f6a..22f27f8d 100644 --- a/pages/funkin/scripting/events/NameEvent.html +++ b/pages/funkin/scripting/events/NameEvent.html @@ -9,4 +9,4 @@ }

class NameEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(name:String)

Variables

name:String

Name

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/NoteCreationEvent.html b/pages/funkin/scripting/events/NoteCreationEvent.html index 0b210347..5029fa87 100644 --- a/pages/funkin/scripting/events/NoteCreationEvent.html +++ b/pages/funkin/scripting/events/NoteCreationEvent.html @@ -9,4 +9,4 @@ }

class NoteCreationEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

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

[Description] Creates a new NoteCreationEvent

Parameters:

note
strumID
noteType
noteTypeID
null

mustHit

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)

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/NoteHitEvent.html b/pages/funkin/scripting/events/NoteHitEvent.html index 2c356f17..08108534 100644 --- a/pages/funkin/scripting/events/NoteHitEvent.html +++ b/pages/funkin/scripting/events/NoteHitEvent.html @@ -9,4 +9,4 @@ }

class NoteHitEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ ratingSuffix : "", ratingPrefix : "", rating : "sick", animSuffix : "", score : 350, unmuteVocals : true })new(note:Note, character:Character, player:Bool, noteType:String, direction:Int, healthGain:Float, unmuteVocals:Bool = true, score:Int = 350, animSuffix:String = "", rating:String = "sick", ?accuracy:Float, ratingPrefix:String = "", ratingSuffix:String = "")

Creates a new NoteHitEvent.

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

@:value(true)countAsCombo:Bool = true

Whenever a miss should be added.

direction:Int

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

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.

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.

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/NoteUpdateEvent.html b/pages/funkin/scripting/events/NoteUpdateEvent.html index d8bd2cfd..e5e37977 100644 --- a/pages/funkin/scripting/events/NoteUpdateEvent.html +++ b/pages/funkin/scripting/events/NoteUpdateEvent.html @@ -9,4 +9,4 @@ }

class NoteUpdateEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(note:Note, elapsed:Float, strum:Strum)

Variables

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

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/PauseCreationEvent.html b/pages/funkin/scripting/events/PauseCreationEvent.html index 394274d1..ac6ce745 100644 --- a/pages/funkin/scripting/events/PauseCreationEvent.html +++ b/pages/funkin/scripting/events/PauseCreationEvent.html @@ -9,4 +9,4 @@ }

class PauseCreationEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

CANCEL this event to prevent default behaviour!

Constructor

new(music:String, options:Array<String>)

Variables

music:String

Music that is going to be played

options:Array<String>

All option names

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/PlayAnimContext.html b/pages/funkin/scripting/events/PlayAnimContext.html index 2e236fab..8435d1ba 100644 --- a/pages/funkin/scripting/events/PlayAnimContext.html +++ b/pages/funkin/scripting/events/PlayAnimContext.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract PlayAnimContext(String)

package funkin.scripting.events

import funkin.scripting.events.PlayAnimEvent

@:build(hscript.UsingHandler.build())@:enum

Contains all contexts possible for PlayAnimEvent.

Variables

@:value(cast "DANCE")@:impl@:enuminlineread onlyDANCE:PlayAnimContext = "DANCE"

Whenever a dance animation is played.

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

Whenever a note is missed and a miss animation will be played.

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

No context was given for the animation

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

Whenever a note is hit and a sing animation will be played.

\ No newline at end of file +

enum abstract PlayAnimContext(String)

package funkin.scripting.events

import funkin.scripting.events.PlayAnimEvent

@:build(hscript.UsingHandler.build())@:enum

Contains all contexts possible for PlayAnimEvent.

Variables

@:value(cast "DANCE")@:impl@:enuminlineread onlyDANCE:PlayAnimContext = "DANCE"

Whenever a dance animation is played.

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

Whenever a note is missed and a miss animation will be played.

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

No context was given for the animation

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

Whenever a note is hit and a sing animation will be played.

\ No newline at end of file diff --git a/pages/funkin/scripting/events/PlayAnimEvent.html b/pages/funkin/scripting/events/PlayAnimEvent.html index 34401408..a59c6d3f 100644 --- a/pages/funkin/scripting/events/PlayAnimEvent.html +++ b/pages/funkin/scripting/events/PlayAnimEvent.html @@ -9,4 +9,4 @@ }

class PlayAnimEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(animName:String, force:Bool, reverse:Bool, startingFrame:Int, context:PlayAnimContext)

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

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/PointEvent.html b/pages/funkin/scripting/events/PointEvent.html index 893340d9..9767e09e 100644 --- a/pages/funkin/scripting/events/PointEvent.html +++ b/pages/funkin/scripting/events/PointEvent.html @@ -9,4 +9,4 @@ }

class PointEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(x:Float, y:Float)

Variables

x:Float

X position

y:Float

Y position

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/RatingUpdateEvent.html b/pages/funkin/scripting/events/RatingUpdateEvent.html index 11f3fe1f..b92c65d3 100644 --- a/pages/funkin/scripting/events/RatingUpdateEvent.html +++ b/pages/funkin/scripting/events/RatingUpdateEvent.html @@ -9,4 +9,4 @@ }

class RatingUpdateEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(rating:ComboRating, oldRating:ComboRating)

Variables

oldRating:ComboRating

Old combo (may be null)

rating:ComboRating

New combo

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/ResizeEvent.html b/pages/funkin/scripting/events/ResizeEvent.html index c873d37c..c5e57b94 100644 --- a/pages/funkin/scripting/events/ResizeEvent.html +++ b/pages/funkin/scripting/events/ResizeEvent.html @@ -9,4 +9,4 @@ }

class ResizeEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(width:Int, height:Int, ?oldWidth:Int, ?oldHeight:Int)

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

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/SimpleNoteEvent.html b/pages/funkin/scripting/events/SimpleNoteEvent.html index 12ead19e..8f30e9c7 100644 --- a/pages/funkin/scripting/events/SimpleNoteEvent.html +++ b/pages/funkin/scripting/events/SimpleNoteEvent.html @@ -9,4 +9,4 @@ }

class SimpleNoteEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(note:Note)

Variables

note:Note

Note that is affected.

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/StateEvent.html b/pages/funkin/scripting/events/StateEvent.html index 424d4f53..bd1448a1 100644 --- a/pages/funkin/scripting/events/StateEvent.html +++ b/pages/funkin/scripting/events/StateEvent.html @@ -9,4 +9,4 @@ }

class StateEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(substate:FlxState)

Variables

substate:FlxState

Substate that is about to be opened/closed

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/StrumCreationEvent.html b/pages/funkin/scripting/events/StrumCreationEvent.html index 40f86d00..254a6aff 100644 --- a/pages/funkin/scripting/events/StrumCreationEvent.html +++ b/pages/funkin/scripting/events/StrumCreationEvent.html @@ -9,4 +9,4 @@ }

class StrumCreationEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(strum:Strum, player:Int, strumID:Int)

Variables

player:Int

Player ID

@:value("game/NOTE_assets")sprite:String = "game/NOTE_assets"

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.

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/WeekSelectEvent.html b/pages/funkin/scripting/events/WeekSelectEvent.html index 4207e1ac..75a7738b 100644 --- a/pages/funkin/scripting/events/WeekSelectEvent.html +++ b/pages/funkin/scripting/events/WeekSelectEvent.html @@ -9,4 +9,4 @@ }

class WeekSelectEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(week:WeekData, difficulty:String, weekID:Int, difficultyID:Int)

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.

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

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/pages/funkin/scripting/events/index.html b/pages/funkin/scripting/events/index.html index 8abc8a4e..e3c8b6f9 100644 --- a/pages/funkin/scripting/events/index.html +++ b/pages/funkin/scripting/events/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.scripting.events

..
CamMoveEvent

CancellableEvent

CountdownEvent

DanceEvent

DirectionAnimEvent

InputSystemEvent

MenuChangeEvent

NameEvent

NoteCreationEvent

NoteHitEvent

NoteUpdateEvent

PauseCreationEvent

CANCEL this event to prevent default behaviour!

PlayAnimContext

Contains all contexts possible for PlayAnimEvent.

PlayAnimEvent

PointEvent

RatingUpdateEvent

ResizeEvent

SimpleNoteEvent

StateEvent

StrumCreationEvent

WeekSelectEvent

\ No newline at end of file +

funkin.scripting.events

..
CamMoveEvent

CancellableEvent

CountdownEvent

DanceEvent

DirectionAnimEvent

InputSystemEvent

MenuChangeEvent

NameEvent

NoteCreationEvent

NoteHitEvent

NoteUpdateEvent

PauseCreationEvent

CANCEL this event to prevent default behaviour!

PlayAnimContext

Contains all contexts possible for PlayAnimEvent.

PlayAnimEvent

PointEvent

RatingUpdateEvent

ResizeEvent

SimpleNoteEvent

StateEvent

StrumCreationEvent

WeekSelectEvent

\ No newline at end of file diff --git a/pages/funkin/scripting/index.html b/pages/funkin/scripting/index.html index 25b0862b..d4f53f04 100644 --- a/pages/funkin/scripting/index.html +++ b/pages/funkin/scripting/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.scripting

..
events
DummyScript

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

GlobalScript

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

HScript

ModState

ModSubState

Script

Class used for scripting.

ScriptPack

\ No newline at end of file +

funkin.scripting

..
events
DummyScript

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

GlobalScript

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

HScript

ModState

ModSubState

Script

Class used for scripting.

ScriptPack

\ No newline at end of file diff --git a/pages/funkin/shaders/CustomShader.html b/pages/funkin/shaders/CustomShader.html index 9aeb7589..347dcb36 100644 --- a/pages/funkin/shaders/CustomShader.html +++ b/pages/funkin/shaders/CustomShader.html @@ -10,4 +10,4 @@

class CustomShader

package funkin.shaders

extends FunkinShader

@:directlyUsed@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:build(hscript.UsingHandler.build())

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.

Inherited Variables

Defined by FunkinShader

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

Inherited Methods

Defined by FunkinShader

hget(v:String):Dynamic

hset(v: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.

Inherited Variables

Defined by FunkinShader

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

Inherited Methods

Defined by FunkinShader

hget(v:String):Dynamic

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

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

class FunkinShader

package funkin.shaders

extends FlxGraphicsShader

implements IHScriptCustomBehaviour

extended by CustomShader

@:directlyUsed@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:build(hscript.UsingHandler.build())

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(v:String):Dynamic

hset(v: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(v:String):Dynamic

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

\ No newline at end of file diff --git a/pages/funkin/shaders/ShaderTemplates.html b/pages/funkin/shaders/ShaderTemplates.html index 27de04c6..b667e68a 100644 --- a/pages/funkin/shaders/ShaderTemplates.html +++ b/pages/funkin/shaders/ShaderTemplates.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ShaderTemplates

package funkin.shaders

import funkin.shaders.FunkinShader

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

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

@:value("#pragma header\r\n\t\t\r\n attribute float alpha;\r\n attribute vec4 colorMultiplier;\r\n attribute vec4 colorOffset;\r\n uniform bool hasColorTransform;\r\n \r\n void main(void)\r\n {\r\n #pragma body\r\n \r\n openfl_Alphav = openfl_Alpha * alpha;\r\n \r\n if (hasColorTransform)\r\n {\r\n openfl_ColorOffsetv = colorOffset / 255.0;\r\n openfl_ColorMultiplierv = colorMultiplier;\r\n }\r\n }")staticfinalread onlydefaultVertexSource:String = "#pragma header\r\n\t\t\r\n attribute float alpha;\r\n attribute vec4 colorMultiplier;\r\n attribute vec4 colorOffset;\r\n uniform bool hasColorTransform;\r\n \r\n void main(void)\r\n {\r\n #pragma body\r\n \r\n openfl_Alphav = openfl_Alpha * alpha;\r\n \r\n if (hasColorTransform)\r\n {\r\n openfl_ColorOffsetv = colorOffset / 255.0;\r\n openfl_ColorMultiplierv = colorMultiplier;\r\n }\r\n }"

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

@:value("varying float openfl_Alphav;\r\n varying vec4 openfl_ColorMultiplierv;\r\n varying vec4 openfl_ColorOffsetv;\r\n varying vec2 openfl_TextureCoordv;\r\n\r\n uniform bool openfl_HasColorTransform;\r\n uniform vec2 openfl_TextureSize;\r\n uniform sampler2D bitmap;\r\n\r\n uniform bool hasTransform;\r\n uniform bool hasColorTransform;\r\n\r\n vec4 flixel_texture2D(sampler2D bitmap, vec2 coord)\r\n {\r\n vec4 color = texture2D(bitmap, coord);\r\n if (!hasTransform)\r\n {\r\n return color;\r\n }\r\n\r\n if (color.a == 0.0)\r\n {\r\n return vec4(0.0, 0.0, 0.0, 0.0);\r\n }\r\n\r\n if (!hasColorTransform)\r\n {\r\n return color * openfl_Alphav;\r\n }\r\n\r\n color = vec4(color.rgb / color.a, color.a);\r\n\r\n mat4 colorMultiplier = mat4(0);\r\n colorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n colorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n colorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n colorMultiplier[3][3] = openfl_ColorMultiplierv.w;\r\n\r\n color = clamp(openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n if (color.a > 0.0)\r\n {\r\n return vec4(color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n }\r\n return vec4(0.0, 0.0, 0.0, 0.0);\r\n }\r\n\r\n uniform vec4 _camSize;\r\n \r\n float map(float value, float min1, float max1, float min2, float max2) {\r\n return min2 + (value - min1) * (max2 - min2) / (max1 - min1);\r\n }\r\n \r\n vec2 getCamPos(vec2 pos) {\r\n vec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n return 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\n vec2 camToOg(vec2 pos) {\r\n vec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n return 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\n vec4 textureCam(sampler2D bitmap, vec2 pos) {\r\n return flixel_texture2D(bitmap, camToOg(pos));\r\n }")staticfinalread onlyfragHeader:String = "varying float openfl_Alphav;\r\n varying vec4 openfl_ColorMultiplierv;\r\n varying vec4 openfl_ColorOffsetv;\r\n varying vec2 openfl_TextureCoordv;\r\n\r\n uniform bool openfl_HasColorTransform;\r\n uniform vec2 openfl_TextureSize;\r\n uniform sampler2D bitmap;\r\n\r\n uniform bool hasTransform;\r\n uniform bool hasColorTransform;\r\n\r\n vec4 flixel_texture2D(sampler2D bitmap, vec2 coord)\r\n {\r\n vec4 color = texture2D(bitmap, coord);\r\n if (!hasTransform)\r\n {\r\n return color;\r\n }\r\n\r\n if (color.a == 0.0)\r\n {\r\n return vec4(0.0, 0.0, 0.0, 0.0);\r\n }\r\n\r\n if (!hasColorTransform)\r\n {\r\n return color * openfl_Alphav;\r\n }\r\n\r\n color = vec4(color.rgb / color.a, color.a);\r\n\r\n mat4 colorMultiplier = mat4(0);\r\n colorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n colorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n colorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n colorMultiplier[3][3] = openfl_ColorMultiplierv.w;\r\n\r\n color = clamp(openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n if (color.a > 0.0)\r\n {\r\n return vec4(color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n }\r\n return vec4(0.0, 0.0, 0.0, 0.0);\r\n }\r\n\r\n uniform vec4 _camSize;\r\n \r\n float map(float value, float min1, float max1, float min2, float max2) {\r\n return min2 + (value - min1) * (max2 - min2) / (max1 - min1);\r\n }\r\n \r\n vec2 getCamPos(vec2 pos) {\r\n vec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n return 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\n vec2 camToOg(vec2 pos) {\r\n vec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n return 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\n vec4 textureCam(sampler2D bitmap, vec2 pos) {\r\n return flixel_texture2D(bitmap, camToOg(pos));\r\n }"

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

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

\ No newline at end of file +

class ShaderTemplates

package funkin.shaders

import funkin.shaders.FunkinShader

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

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

@:value("#pragma header\r\n\t\t\r\n attribute float alpha;\r\n attribute vec4 colorMultiplier;\r\n attribute vec4 colorOffset;\r\n uniform bool hasColorTransform;\r\n \r\n void main(void)\r\n {\r\n #pragma body\r\n \r\n openfl_Alphav = openfl_Alpha * alpha;\r\n \r\n if (hasColorTransform)\r\n {\r\n openfl_ColorOffsetv = colorOffset / 255.0;\r\n openfl_ColorMultiplierv = colorMultiplier;\r\n }\r\n }")staticfinalread onlydefaultVertexSource:String = "#pragma header\r\n\t\t\r\n attribute float alpha;\r\n attribute vec4 colorMultiplier;\r\n attribute vec4 colorOffset;\r\n uniform bool hasColorTransform;\r\n \r\n void main(void)\r\n {\r\n #pragma body\r\n \r\n openfl_Alphav = openfl_Alpha * alpha;\r\n \r\n if (hasColorTransform)\r\n {\r\n openfl_ColorOffsetv = colorOffset / 255.0;\r\n openfl_ColorMultiplierv = colorMultiplier;\r\n }\r\n }"

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

@:value("varying float openfl_Alphav;\r\n varying vec4 openfl_ColorMultiplierv;\r\n varying vec4 openfl_ColorOffsetv;\r\n varying vec2 openfl_TextureCoordv;\r\n\r\n uniform bool openfl_HasColorTransform;\r\n uniform vec2 openfl_TextureSize;\r\n uniform sampler2D bitmap;\r\n\r\n uniform bool hasTransform;\r\n uniform bool hasColorTransform;\r\n\r\n vec4 flixel_texture2D(sampler2D bitmap, vec2 coord)\r\n {\r\n vec4 color = texture2D(bitmap, coord);\r\n if (!hasTransform)\r\n {\r\n return color;\r\n }\r\n\r\n if (color.a == 0.0)\r\n {\r\n return vec4(0.0, 0.0, 0.0, 0.0);\r\n }\r\n\r\n if (!hasColorTransform)\r\n {\r\n return color * openfl_Alphav;\r\n }\r\n\r\n color = vec4(color.rgb / color.a, color.a);\r\n\r\n mat4 colorMultiplier = mat4(0);\r\n colorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n colorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n colorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n colorMultiplier[3][3] = openfl_ColorMultiplierv.w;\r\n\r\n color = clamp(openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n if (color.a > 0.0)\r\n {\r\n return vec4(color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n }\r\n return vec4(0.0, 0.0, 0.0, 0.0);\r\n }\r\n\r\n uniform vec4 _camSize;\r\n \r\n float map(float value, float min1, float max1, float min2, float max2) {\r\n return min2 + (value - min1) * (max2 - min2) / (max1 - min1);\r\n }\r\n \r\n vec2 getCamPos(vec2 pos) {\r\n vec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n return 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\n vec2 camToOg(vec2 pos) {\r\n vec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n return 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\n vec4 textureCam(sampler2D bitmap, vec2 pos) {\r\n return flixel_texture2D(bitmap, camToOg(pos));\r\n }")staticfinalread onlyfragHeader:String = "varying float openfl_Alphav;\r\n varying vec4 openfl_ColorMultiplierv;\r\n varying vec4 openfl_ColorOffsetv;\r\n varying vec2 openfl_TextureCoordv;\r\n\r\n uniform bool openfl_HasColorTransform;\r\n uniform vec2 openfl_TextureSize;\r\n uniform sampler2D bitmap;\r\n\r\n uniform bool hasTransform;\r\n uniform bool hasColorTransform;\r\n\r\n vec4 flixel_texture2D(sampler2D bitmap, vec2 coord)\r\n {\r\n vec4 color = texture2D(bitmap, coord);\r\n if (!hasTransform)\r\n {\r\n return color;\r\n }\r\n\r\n if (color.a == 0.0)\r\n {\r\n return vec4(0.0, 0.0, 0.0, 0.0);\r\n }\r\n\r\n if (!hasColorTransform)\r\n {\r\n return color * openfl_Alphav;\r\n }\r\n\r\n color = vec4(color.rgb / color.a, color.a);\r\n\r\n mat4 colorMultiplier = mat4(0);\r\n colorMultiplier[0][0] = openfl_ColorMultiplierv.x;\r\n colorMultiplier[1][1] = openfl_ColorMultiplierv.y;\r\n colorMultiplier[2][2] = openfl_ColorMultiplierv.z;\r\n colorMultiplier[3][3] = openfl_ColorMultiplierv.w;\r\n\r\n color = clamp(openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\r\n\r\n if (color.a > 0.0)\r\n {\r\n return vec4(color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\r\n }\r\n return vec4(0.0, 0.0, 0.0, 0.0);\r\n }\r\n\r\n uniform vec4 _camSize;\r\n \r\n float map(float value, float min1, float max1, float min2, float max2) {\r\n return min2 + (value - min1) * (max2 - min2) / (max1 - min1);\r\n }\r\n \r\n vec2 getCamPos(vec2 pos) {\r\n vec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n return 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\n vec2 camToOg(vec2 pos) {\r\n vec4 size = _camSize / vec4(openfl_TextureSize, openfl_TextureSize);\r\n return 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\n vec4 textureCam(sampler2D bitmap, vec2 pos) {\r\n return flixel_texture2D(bitmap, camToOg(pos));\r\n }"

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

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

\ No newline at end of file diff --git a/pages/funkin/shaders/ShaderTypeException.html b/pages/funkin/shaders/ShaderTypeException.html index f13edd35..352ed2eb 100644 --- a/pages/funkin/shaders/ShaderTypeException.html +++ b/pages/funkin/shaders/ShaderTypeException.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ShaderTypeException

package funkin.shaders

extends Exception

import funkin.shaders.FunkinShader

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

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

\ No newline at end of file +

class ShaderTypeException

package funkin.shaders

extends Exception

import funkin.shaders.FunkinShader

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

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

\ No newline at end of file diff --git a/pages/funkin/shaders/WiggleEffect.html b/pages/funkin/shaders/WiggleEffect.html index 349c9357..61a24ead 100644 --- a/pages/funkin/shaders/WiggleEffect.html +++ b/pages/funkin/shaders/WiggleEffect.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class WiggleEffect

package funkin.shaders

@:build(hscript.UsingHandler.build())

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 +

class WiggleEffect

package funkin.shaders

@:build(hscript.UsingHandler.build())

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/pages/funkin/shaders/WiggleEffectType.html b/pages/funkin/shaders/WiggleEffectType.html index bfe05d02..31461277 100644 --- a/pages/funkin/shaders/WiggleEffectType.html +++ b/pages/funkin/shaders/WiggleEffectType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum WiggleEffectType

package funkin.shaders

import funkin.shaders.WiggleEffect

@:directlyUsed@:flatEnum@:build(hscript.UsingHandler.build())

Values

DREAMY

WAVY

HEAT_WAVE_HORIZONTAL

HEAT_WAVE_VERTICAL

FLAG

\ No newline at end of file +

enum WiggleEffectType

package funkin.shaders

import funkin.shaders.WiggleEffect

@:directlyUsed@:flatEnum@:build(hscript.UsingHandler.build())

Values

DREAMY

WAVY

HEAT_WAVE_HORIZONTAL

HEAT_WAVE_VERTICAL

FLAG

\ No newline at end of file diff --git a/pages/funkin/shaders/WiggleShader.html b/pages/funkin/shaders/WiggleShader.html index 127cad95..0ae1077c 100644 --- a/pages/funkin/shaders/WiggleShader.html +++ b/pages/funkin/shaders/WiggleShader.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class WiggleShader

package funkin.shaders

extends FlxGraphicsShader

import funkin.shaders.WiggleEffect

@:directlyUsed@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:build(hscript.UsingHandler.build())

Constructor

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

class WiggleShader

package funkin.shaders

extends FlxGraphicsShader

import funkin.shaders.WiggleEffect

@:directlyUsed@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:build(hscript.UsingHandler.build())

Constructor

@:glFragmentSource("\n\t\t#pragma header\n\t\t//uniform float tx, ty; // x,y waves phase\n\t\tuniform float uTime;\n\t\t\n\t\tconst int EFFECT_TYPE_DREAMY = 0;\n\t\tconst int EFFECT_TYPE_WAVY = 1;\n\t\tconst int EFFECT_TYPE_HEAT_WAVE_HORIZONTAL = 2;\n\t\tconst int EFFECT_TYPE_HEAT_WAVE_VERTICAL = 3;\n\t\tconst int EFFECT_TYPE_FLAG = 4;\n\t\t\n\t\tuniform int effectType;\n\t\t\n\t\t/**\n\t\t * How fast the waves move over time\n\t\t */\n\t\tuniform float uSpeed;\n\t\t\n\t\t/**\n\t\t * Number of waves over time\n\t\t */\n\t\tuniform float uFrequency;\n\t\t\n\t\t/**\n\t\t * How much the pixels are going to stretch over the waves\n\t\t */\n\t\tuniform float uWaveAmplitude;\n\n\t\tvec2 sineWave(vec2 pt)\n\t\t{\n\t\t\tfloat x = 0.0;\n\t\t\tfloat y = 0.0;\n\t\t\t\n\t\t\tif (effectType == EFFECT_TYPE_DREAMY) \n\t\t\t{\n\t\t\t\tfloat offsetX = sin(pt.y * uFrequency + uTime * uSpeed) * uWaveAmplitude;\n pt.x += offsetX; // * (pt.y - 1.0); // <- Uncomment to stop bottom part of the screen from moving\n\t\t\t}\n\t\t\telse if (effectType == EFFECT_TYPE_WAVY) \n\t\t\t{\n\t\t\t\tfloat offsetY = sin(pt.x * uFrequency + uTime * uSpeed) * uWaveAmplitude;\n\t\t\t\tpt.y += offsetY; // * (pt.y - 1.0); // <- Uncomment to stop bottom part of the screen from moving\n\t\t\t}\n\t\t\telse if (effectType == EFFECT_TYPE_HEAT_WAVE_HORIZONTAL)\n\t\t\t{\n\t\t\t\tx = sin(pt.x * uFrequency + uTime * uSpeed) * uWaveAmplitude;\n\t\t\t}\n\t\t\telse if (effectType == EFFECT_TYPE_HEAT_WAVE_VERTICAL)\n\t\t\t{\n\t\t\t\ty = sin(pt.y * uFrequency + uTime * uSpeed) * uWaveAmplitude;\n\t\t\t}\n\t\t\telse if (effectType == EFFECT_TYPE_FLAG)\n\t\t\t{\n\t\t\t\ty = sin(pt.y * uFrequency + 10.0 * pt.x + uTime * uSpeed) * uWaveAmplitude;\n\t\t\t\tx = sin(pt.x * uFrequency + 5.0 * pt.y + uTime * uSpeed) * uWaveAmplitude;\n\t\t\t}\n\t\t\t\n\t\t\treturn vec2(pt.x + x, pt.y + y);\n\t\t}\n\n\t\tvoid main()\n\t\t{\n\t\t\tvec2 uv = sineWave(openfl_TextureCoordv);\n\t\t\tgl_FragColor = texture2D(bitmap, uv);\n\t\t}")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/pages/funkin/shaders/index.html b/pages/funkin/shaders/index.html index 0de96a5f..c55ccdcb 100644 --- a/pages/funkin/shaders/index.html +++ b/pages/funkin/shaders/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.shaders

..
CustomShader

Class for custom shaders.

FunkinShader

ShaderTemplates

ShaderTypeException

WiggleEffect

WiggleEffectType

WiggleShader

\ No newline at end of file +

funkin.shaders

..
CustomShader

Class for custom shaders.

FunkinShader

ShaderTemplates

ShaderTypeException

WiggleEffect

WiggleEffectType

WiggleShader

\ No newline at end of file diff --git a/pages/funkin/system/Action.html b/pages/funkin/system/Action.html index 7cbf4a73..4ce16499 100644 --- a/pages/funkin/system/Action.html +++ b/pages/funkin/system/Action.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract Action(String)

package funkin.system

from String to String

import funkin.system.Controls

@:build(hscript.UsingHandler.build())@:enum

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 "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 +

enum abstract Action(String)

package funkin.system

from String to String

import funkin.system.Controls

@:build(hscript.UsingHandler.build())@:enum

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 "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/pages/funkin/system/AnimData.html b/pages/funkin/system/AnimData.html index b0a53560..442341c1 100644 --- a/pages/funkin/system/AnimData.html +++ b/pages/funkin/system/AnimData.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef AnimData

package funkin.system

import funkin.system.XMLUtil

@:build(hscript.UsingHandler.build())

Fields

y:Float

x:Float

name:String

loop:Bool

indices:Array<Int>

fps:Int

animType:XMLAnimType

anim:String

\ No newline at end of file +

typedef AnimData

package funkin.system

import funkin.system.XMLUtil

@:build(hscript.UsingHandler.build())

Fields

y:Float

x:Float

name:String

loop:Bool

indices:Array<Int>

fps:Int

animType:XMLAnimType

anim:String

\ No newline at end of file diff --git a/pages/funkin/system/AssetsLibraryList.html b/pages/funkin/system/AssetsLibraryList.html index 730a13a4..4bd42178 100644 --- a/pages/funkin/system/AssetsLibraryList.html +++ b/pages/funkin/system/AssetsLibraryList.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class AssetsLibraryList

package funkin.system

extends AssetLibrary

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?base:AssetLibrary)

Variables

base:AssetLibrary

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

Methods

addLibrary(lib:AssetLibrary):AssetLibrary

clearCache():Void

getFiles(folder:String):Array<String>

removeLibrary(lib:AssetLibrary):AssetLibrary

\ No newline at end of file +

class AssetsLibraryList

package funkin.system

extends AssetLibrary

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?base:AssetLibrary)

Variables

base:AssetLibrary

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

Methods

addLibrary(lib:AssetLibrary):AssetLibrary

clearCache():Void

getFiles(folder:String):Array<String>

removeLibrary(lib:AssetLibrary):AssetLibrary

\ No newline at end of file diff --git a/pages/funkin/system/BPMChangeEvent.html b/pages/funkin/system/BPMChangeEvent.html index d8855937..3e16ba90 100644 --- a/pages/funkin/system/BPMChangeEvent.html +++ b/pages/funkin/system/BPMChangeEvent.html @@ -9,4 +9,4 @@ text-shadow: 0 0 0 transparent; }

typedef BPMChangeEvent

package funkin.system

import funkin.system.Conductor

@:build(hscript.UsingHandler.build())

... -@author

Fields

stepTime:Int

songTime:Float

bpm:Float

\ No newline at end of file +@author

Fields

stepTime:Int

songTime:Float

bpm:Float

\ No newline at end of file diff --git a/pages/funkin/system/Conductor.html b/pages/funkin/system/Conductor.html index a034006d..c2f65c6d 100644 --- a/pages/funkin/system/Conductor.html +++ b/pages/funkin/system/Conductor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Conductor

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

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

FlxSignals

@:value(new FlxTypedSignal())staticonStepHit:FlxTypedSignal<Int ‑> Void> = new FlxTypedSignal()

staticsongPosition:Float

Current position of the song, in milliseconds.

@:value(crochet / 4)staticstepCrochet:Float = crochet / 4

Current StepCrochet (time per step), in milliseconds.

Static methods

staticchangeBPM(newBpm:Float):Void

staticinit():Void

staticmapBPMChanges(song:SwagSong):Void

Maps BPM changes from a song.

Parameters:

song

Song to map BPM changes from.

staticreset():Void

staticsetupSong(SONG:SwagSong):Void

\ No newline at end of file +

class Conductor

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

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

FlxSignals

@:value(new FlxTypedSignal())staticonStepHit:FlxTypedSignal<Int ‑> Void> = new FlxTypedSignal()

staticsongPosition:Float

Current position of the song, in milliseconds.

@:value(crochet / 4)staticstepCrochet:Float = crochet / 4

Current StepCrochet (time per step), in milliseconds.

Static methods

staticchangeBPM(newBpm:Float):Void

staticinit():Void

staticmapBPMChanges(song:SwagSong):Void

Maps BPM changes from a song.

Parameters:

song

Song to map BPM changes from.

staticreset():Void

staticsetupSong(SONG:SwagSong):Void

\ No newline at end of file diff --git a/pages/funkin/system/Control.html b/pages/funkin/system/Control.html index 998f3933..80994fe4 100644 --- a/pages/funkin/system/Control.html +++ b/pages/funkin/system/Control.html @@ -11,4 +11,4 @@ an input so, for instance, they can't set jump-press and jump-release to di }

enum Control

package funkin.system

import funkin.system.Controls

@:directlyUsed@:flatEnum@:build(hscript.UsingHandler.build())

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 percieves as -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

\ 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

\ No newline at end of file diff --git a/pages/funkin/system/Controls.html b/pages/funkin/system/Controls.html index 604bf665..45236d9a 100644 --- a/pages/funkin/system/Controls.html +++ b/pages/funkin/system/Controls.html @@ -13,4 +13,4 @@ Uses FlxActions to funnel various inputs to a single action.

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/pages/funkin/system/CoolUtil.html b/pages/funkin/system/CoolUtil.html index 3670dcf1..440bf597 100644 --- a/pages/funkin/system/CoolUtil.html +++ b/pages/funkin/system/CoolUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class CoolUtil

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

static__loadSong(name:String, difficulty:String):Void

staticaddZeros(str:String, num:Int):String

@:value({ axes : XY })staticcameraCenter(obj:FlxObject, cam:FlxCamera, axes:FlxAxes = XY):Void

staticcoolTextFile(path:String):Array<String>

staticfpsLerp(v1:Float, v2:Float, ratio:Float):Float

staticgetAtt(xml:Access, name:String):String

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.

staticgetDefault<T>(v:T, defaultValue:T):T

staticgetFPSRatio(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

staticgetSizeString(size:Float):String

staticisNaN(v:Dynamic):Bool

statickeyToString(key:Null<FlxKey>):String

staticlast<T>(array:Array<T>):T

@:value({ fpsSensitive : false })staticlerpColor(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 case sentivive (adapted when game is running at 120 instead of 60)

staticloadAnimatedGraphic(spr:FlxSprite, path:String):FlxSprite

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

@:value({ difficulty : "normal" })staticloadSong(name:String, difficulty:String = "normal"):Void

@:value({ difficulty : "normal" })staticloadWeek(weekData:WeekData, difficulty:String = "normal"):Void

@:value({ min : 0 })staticnumberArray(max:Int, min:Int = 0):Array<Int>

staticparseJson(assetPath:String):Unknown

staticinlineparseJsonString(str:String):Unknown

@:value({ volume : 1, menuSFX : 0 })staticplayMenuSFX(menuSFX:Int = 0, 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

@:value({ Looped : true, Volume : 1, DefaultBPM : 102 })staticplayMusic(path:String, DefaultBPM:Int = 102, Volume:Int = 1, Looped:Bool = true, ?Group:FlxSoundGroup):Void

staticsetFieldDefault<T>(v:Dynamic, name:String, defaultValue:T):T

staticsetSpriteSize(sprite:FlxSprite, width:Float, height:Float):Void

@:value({ maxScale : 0, fill : true })staticsetUnstretchedGraphicSize(sprite:FlxSprite, width:Int, height:Int, fill:Bool = true, maxScale:Float = 0):Void

staticswitchAnimFrames(anim1:FlxAnimation, anim2:FlxAnimation):Void

\ No newline at end of file +

class CoolUtil

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

static__loadSong(name:String, difficulty:String):Void

staticaddZeros(str:String, num:Int):String

@:value({ axes : XY })staticcameraCenter(obj:FlxObject, cam:FlxCamera, axes:FlxAxes = XY):Void

staticcoolTextFile(path:String):Array<String>

staticfpsLerp(v1:Float, v2:Float, ratio:Float):Float

staticgetAtt(xml:Access, name:String):String

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.

staticgetDefault<T>(v:T, defaultValue:T):T

staticgetFPSRatio(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

staticgetSizeString(size:Float):String

staticisNaN(v:Dynamic):Bool

statickeyToString(key:Null<FlxKey>):String

staticlast<T>(array:Array<T>):T

@:value({ fpsSensitive : false })staticlerpColor(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 case sentivive (adapted when game is running at 120 instead of 60)

staticloadAnimatedGraphic(spr:FlxSprite, path:String):FlxSprite

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

@:value({ difficulty : "normal" })staticloadSong(name:String, difficulty:String = "normal"):Void

@:value({ difficulty : "normal" })staticloadWeek(weekData:WeekData, difficulty:String = "normal"):Void

@:value({ min : 0 })staticnumberArray(max:Int, min:Int = 0):Array<Int>

staticparseJson(assetPath:String):Unknown

staticinlineparseJsonString(str:String):Unknown

@:value({ volume : 1, menuSFX : 0 })staticplayMenuSFX(menuSFX:Int = 0, 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

@:value({ Looped : true, Volume : 1, DefaultBPM : 102 })staticplayMusic(path:String, DefaultBPM:Int = 102, Volume:Int = 1, Looped:Bool = true, ?Group:FlxSoundGroup):Void

staticsetFieldDefault<T>(v:Dynamic, name:String, defaultValue:T):T

staticsetSpriteSize(sprite:FlxSprite, width:Float, height:Float):Void

@:value({ maxScale : 0, fill : true })staticsetUnstretchedGraphicSize(sprite:FlxSprite, width:Int, height:Int, fill:Bool = true, maxScale:Float = 0):Void

staticswitchAnimFrames(anim1:FlxAnimation, anim2:FlxAnimation):Void

\ No newline at end of file diff --git a/pages/funkin/system/CrashHandler.html b/pages/funkin/system/CrashHandler.html index c55456c7..4c3c221f 100644 --- a/pages/funkin/system/CrashHandler.html +++ b/pages/funkin/system/CrashHandler.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class CrashHandler

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticinit():Void

staticonError(e:UncaughtErrorEvent):Void

\ No newline at end of file +

class CrashHandler

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticinit():Void

staticonError(e:UncaughtErrorEvent):Void

\ No newline at end of file diff --git a/pages/funkin/system/Device.html b/pages/funkin/system/Device.html index 290bcaec..5394ceef 100644 --- a/pages/funkin/system/Device.html +++ b/pages/funkin/system/Device.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum Device

package funkin.system

import funkin.system.Controls

@:build(hscript.UsingHandler.build())

Values

Keys

Gamepad(id:Int)

\ No newline at end of file +

enum Device

package funkin.system

import funkin.system.Controls

@:build(hscript.UsingHandler.build())

Values

Keys

Gamepad(id:Int)

\ No newline at end of file diff --git a/pages/funkin/system/DiscordClient.html b/pages/funkin/system/DiscordClient.html index 78f489ca..3ea7177a 100644 --- a/pages/funkin/system/DiscordClient.html +++ b/pages/funkin/system/DiscordClient.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class DiscordClient

package funkin.system

import funkin.system.Discord

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticchangePresence(details:String, state:Null<String>, ?smallImageKey:String, ?hasStartTimestamp:Bool, ?endTimestamp:Float):Void

staticinitialize():Void

staticshutdown():Void

Constructor

new()

\ No newline at end of file +

class DiscordClient

package funkin.system

import funkin.system.Discord

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

staticchangePresence(details:String, state:Null<String>, ?smallImageKey:String, ?hasStartTimestamp:Bool, ?endTimestamp:Float):Void

staticinitialize():Void

staticshutdown():Void

Constructor

new()

\ No newline at end of file diff --git a/pages/funkin/system/ErrorCode.html b/pages/funkin/system/ErrorCode.html index 66e1f65e..f4b25dfb 100644 --- a/pages/funkin/system/ErrorCode.html +++ b/pages/funkin/system/ErrorCode.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract ErrorCode(Int)

package funkin.system

@:build(hscript.UsingHandler.build())@:enum

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 +

enum abstract ErrorCode(Int)

package funkin.system

@:build(hscript.UsingHandler.build())@:enum

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/pages/funkin/system/FramerateField.html b/pages/funkin/system/FramerateField.html index 2b61366d..fa8a5138 100644 --- a/pages/funkin/system/FramerateField.html +++ b/pages/funkin/system/FramerateField.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class FramerateField

package funkin.system

extends TextField

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ color : 0x000000, y : 10, x : 10 })new(x:Float = 10, y:Float = 10, color:Int = 0x000000)

Variables

@:value(false)debugMode:Bool = false

Press F3 to enable

@:value(0)lastFPS:Float = 0

@:value(0)peak:UInt = 0

@:value(true)showFPS:Bool = true

@:value(true)showMemory:Bool = true

@:value(true)showMemoryPeak:Bool = true

Methods

\ No newline at end of file +

class FramerateField

package funkin.system

extends TextField

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

@:value({ color : 0x000000, y : 10, x : 10 })new(x:Float = 10, y:Float = 10, color:Int = 0x000000)

Variables

@:value(false)debugMode:Bool = false

Press F3 to enable

@:value(0)lastFPS:Float = 0

@:value(0)peak:UInt = 0

@:value(true)showFPS:Bool = true

@:value(true)showMemory:Bool = true

@:value(true)showMemoryPeak:Bool = true

Methods

\ No newline at end of file diff --git a/pages/funkin/system/IniUtils.html b/pages/funkin/system/IniUtils.html index c86a50e5..07688bbf 100644 --- a/pages/funkin/system/IniUtils.html +++ b/pages/funkin/system/IniUtils.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class IniUtils

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

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 +

class IniUtils

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/system/KeyboardScheme.html b/pages/funkin/system/KeyboardScheme.html index 7f287c40..25009d23 100644 --- a/pages/funkin/system/KeyboardScheme.html +++ b/pages/funkin/system/KeyboardScheme.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum KeyboardScheme

package funkin.system

import funkin.system.Controls

@:directlyUsed@:build(hscript.UsingHandler.build())

Values

Solo

Duo(first:Bool)

None

Custom

\ No newline at end of file +

enum KeyboardScheme

package funkin.system

import funkin.system.Controls

@:directlyUsed@:build(hscript.UsingHandler.build())

Values

Solo

Duo(first:Bool)

None

Custom

\ No newline at end of file diff --git a/pages/funkin/system/Level.html b/pages/funkin/system/Level.html index 5cadc1fa..7959a2ba 100644 --- a/pages/funkin/system/Level.html +++ b/pages/funkin/system/Level.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract Level(Int)

package funkin.system

import funkin.system.Logs

@:build(hscript.UsingHandler.build())@:enum

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 +

enum abstract Level(Int)

package funkin.system

import funkin.system.Logs

@:build(hscript.UsingHandler.build())@:enum

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/pages/funkin/system/LogText.html b/pages/funkin/system/LogText.html index e3036324..27a42e50 100644 --- a/pages/funkin/system/LogText.html +++ b/pages/funkin/system/LogText.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef LogText

package funkin.system

import funkin.system.Logs

@:build(hscript.UsingHandler.build())

Fields

text:String

color:ConsoleColor

\ No newline at end of file +

typedef LogText

package funkin.system

import funkin.system.Logs

@:build(hscript.UsingHandler.build())

Fields

text:String

color:ConsoleColor

\ No newline at end of file diff --git a/pages/funkin/system/Logs.html b/pages/funkin/system/Logs.html index b24af41d..01dc0a77 100644 --- a/pages/funkin/system/Logs.html +++ b/pages/funkin/system/Logs.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Logs

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(Log.trace)staticnativeTrace:(v:Dynamic, infos:Null<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 +

class Logs

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value(Log.trace)staticnativeTrace:(v:Dynamic, infos:Null<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/pages/funkin/system/Main.html b/pages/funkin/system/Main.html index 48a2ee21..83e85191 100644 --- a/pages/funkin/system/Main.html +++ b/pages/funkin/system/Main.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Main

package funkin.system

extends Sprite

@:directlyUsed@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())@:build(hscript.UsingHandler.build())

Static variables

@:value(0)@:keepstaticchangeID:Int = 0

@:value([])@:keepstaticgameThreads:Array<Thread> = []

@:keepstaticinstance:Main

Static methods

@:keepstaticexecAsync(func:() ‑> Void):Void

@:keepstaticinitTransition():Void

@:keepstaticmain():Void

@:keepstaticrefreshAssets():Void

Constructor

@:keepnew()

Methods

@:keeploadGameSettings():Void

\ No newline at end of file +

class Main

package funkin.system

extends Sprite

@:directlyUsed@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())@:build(hscript.UsingHandler.build())

Static variables

@:value(0)@:keepstaticchangeID:Int = 0

@:value([])@:keepstaticgameThreads:Array<Thread> = []

@:keepstaticinstance:Main

Static methods

@:keepstaticexecAsync(func:() ‑> Void):Void

@:keepstaticinitTransition():Void

@:keepstaticmain():Void

@:keepstaticrefreshAssets():Void

Constructor

@:keepnew()

Methods

@:keeploadGameSettings():Void

\ No newline at end of file diff --git a/pages/funkin/system/MarkdownUtil.html b/pages/funkin/system/MarkdownUtil.html index 1b7829a0..327b7b16 100644 --- a/pages/funkin/system/MarkdownUtil.html +++ b/pages/funkin/system/MarkdownUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MarkdownUtil

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

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 +

class MarkdownUtil

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/system/MusicBeatGroup.html b/pages/funkin/system/MusicBeatGroup.html index 0b705d4b..60af1cd2 100644 --- a/pages/funkin/system/MusicBeatGroup.html +++ b/pages/funkin/system/MusicBeatGroup.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MusicBeatGroup

package funkin.system

extends FlxTypedSpriteGroup

implements IBeatReceiver

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

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

Methods

beatHit(curBeat:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file +

class MusicBeatGroup

package funkin.system

extends FlxTypedSpriteGroup

implements IBeatReceiver

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

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

Methods

beatHit(curBeat:Int):Void

stepHit(curStep:Int):Void

\ No newline at end of file diff --git a/pages/funkin/system/MusicBeatState.html b/pages/funkin/system/MusicBeatState.html index 3f30c456..5dff9ac8 100644 --- a/pages/funkin/system/MusicBeatState.html +++ b/pages/funkin/system/MusicBeatState.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MusicBeatState

package funkin.system

extends FlxUIState

implements IBeatReceiver

extended by DesktopMain, CharacterEditor, ChartingState, PlayState, CreditsCodename, FreeplayState, GitarooPause, MainMenuState, StoryMenuState, TitleState, OptionsMenu, OptionsScreen, ModState, UpdateAvailableScreen, UpdateScreen

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class MusicBeatState

package funkin.system

extends FlxUIState

implements IBeatReceiver

extended by DesktopMain, CharacterEditor, ChartingState, PlayState, CreditsCodename, FreeplayState, GitarooPause, MainMenuState, StoryMenuState, TitleState, OptionsMenu, OptionsScreen, ModState, UpdateAvailableScreen, UpdateScreen

@:directlyUsed@:build(hscript.UsingHandler.build())

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/system/MusicBeatSubstate.html b/pages/funkin/system/MusicBeatSubstate.html index 65ddab07..e3a852d5 100644 --- a/pages/funkin/system/MusicBeatSubstate.html +++ b/pages/funkin/system/MusicBeatSubstate.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class MusicBeatSubstate

package funkin.system

extends FlxSubState

implements IBeatReceiver

extended by Cutscene, GameOverSubstate, ModSwitchMenu, PauseSubState, ChangeKeybindSubState, KeybindsOptions, ModSubState

@:build(hscript.UsingHandler.build())

Constructor

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

Variables

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class MusicBeatSubstate

package funkin.system

extends FlxSubState

implements IBeatReceiver

extended by Cutscene, GameOverSubstate, ModSwitchMenu, PauseSubState, ChangeKeybindSubState, KeybindsOptions, ModSubState

@:build(hscript.UsingHandler.build())

Constructor

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

Variables

read onlycontrols:Controls

Game Controls.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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(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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/system/Paths.html b/pages/funkin/system/Paths.html index f467be42..71e6a7a3 100644 --- a/pages/funkin/system/Paths.html +++ b/pages/funkin/system/Paths.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

class Paths

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value("ogg")staticinlineread 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.

staticassetsTree:AssetsLibraryList

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

Static methods

staticinlineawd(key:String):String

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

staticinlinedae(key:String):String

@:value({ type : TEXT })staticinlinefile(file:String, type:AssetType = TEXT, ?library:String):String

staticinlinefont(key:String):String

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

@:value({ scanSource : false, addPath : false, includeSource : true })staticgetFolderContent(key:String, includeSource:Bool = true, addPath:Bool = false, scanSource:Bool = false):Array<String>

staticgetFrames(key:String, ?library:String):Null<FlxFramesCollection>

@:value({ library : "default" })staticgetLibraryPath(file:String, library:String = "default"):String

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

staticinlinegetPackerAtlasAlt(key:String):FlxAtlasFrames

@:value({ skipModsVerification : false })staticgetPath(file:String, type:AssetType, library:Null<String>, skipModsVerification:Bool = false):String

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

staticinlinegetSparrowAtlasAlt(key:String):FlxAtlasFrames

@:value({ checkForAtlas : false })staticinlineimage(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

staticinlineobj(key: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

staticvideo(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

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

staticinlinedae(key:String):String

@:value({ type : TEXT })staticinlinefile(file:String, type:AssetType = TEXT, ?library:String):String

staticinlinefont(key:String):String

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

@:value({ scanSource : false, addPath : false, includeSource : true })staticgetFolderContent(key:String, includeSource:Bool = true, addPath:Bool = false, scanSource:Bool = false):Array<String>

staticgetFrames(key:String, ?library:String):Null<FlxFramesCollection>

@:value({ library : "default" })staticgetLibraryPath(file:String, library:String = "default"):String

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

staticinlinegetPackerAtlasAlt(key:String):FlxAtlasFrames

@:value({ skipModsVerification : false })staticgetPath(file:String, type:AssetType, library:Null<String>, skipModsVerification:Bool = false):String

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

staticinlinegetSparrowAtlasAlt(key:String):FlxAtlasFrames

@:value({ checkForAtlas : false })staticinlineimage(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

staticinlineobj(key: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

staticvideo(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 diff --git a/pages/funkin/system/PlayingSound.html b/pages/funkin/system/PlayingSound.html index 459bf6f8..6da60660 100644 --- a/pages/funkin/system/PlayingSound.html +++ b/pages/funkin/system/PlayingSound.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef PlayingSound

package funkin.system

import funkin.system.AudioSwitchFix

@:build(hscript.UsingHandler.build())

Fields

time:Float

sound:FlxSound

\ No newline at end of file +

typedef PlayingSound

package funkin.system

import funkin.system.AudioSwitchFix

@:build(hscript.UsingHandler.build())

Fields

time:Float

sound:FlxSound

\ No newline at end of file diff --git a/pages/funkin/system/Section.html b/pages/funkin/system/Section.html index 96ddc4f5..e04d7e43 100644 --- a/pages/funkin/system/Section.html +++ b/pages/funkin/system/Section.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Section

package funkin.system

@:build(hscript.UsingHandler.build())

Static variables

@:value(0)staticCOPYCAT:Int = 0

Copies the first section into the second section!

Constructor

@:value({ lengthInSteps : 16 })new(lengthInSteps:Int = 16)

Variables

@:value(16)lengthInSteps:Int = 16

@:value(true)mustHitSection:Bool = true

@:value([])sectionNotes:Array<Dynamic> = []

@:value(0)typeOfSection:Int = 0

\ No newline at end of file +

class Section

package funkin.system

@:build(hscript.UsingHandler.build())

Static variables

@:value(0)staticCOPYCAT:Int = 0

Copies the first section into the second section!

Constructor

@:value({ lengthInSteps : 16 })new(lengthInSteps:Int = 16)

Variables

@:value(16)lengthInSteps:Int = 16

@:value(true)mustHitSection:Bool = true

@:value([])sectionNotes:Array<Dynamic> = []

@:value(0)typeOfSection:Int = 0

\ No newline at end of file diff --git a/pages/funkin/system/Song.html b/pages/funkin/system/Song.html index 5099b3a6..a01a6c35 100644 --- a/pages/funkin/system/Song.html +++ b/pages/funkin/system/Song.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Song

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

@:value({ difficulty : "normal" })staticloadFromJson(songName:String, difficulty:String = "normal"):SwagSong

staticparseJSONshit(rawJson:String):SwagSong

\ No newline at end of file +

class Song

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Static methods

@:value({ difficulty : "normal" })staticloadFromJson(songName:String, difficulty:String = "normal"):SwagSong

staticparseJSONshit(rawJson:String):SwagSong

\ No newline at end of file diff --git a/pages/funkin/system/StrNameLabel.html b/pages/funkin/system/StrNameLabel.html index f91eca59..735ce083 100644 --- a/pages/funkin/system/StrNameLabel.html +++ b/pages/funkin/system/StrNameLabel.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class StrNameLabel

package funkin.system

import funkin.system.ZipUtils

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(name:String, label:String)

Variables

label:String

name:String

\ No newline at end of file +

class StrNameLabel

package funkin.system

import funkin.system.ZipUtils

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(name:String, label:String)

Variables

label:String

name:String

\ No newline at end of file diff --git a/pages/funkin/system/SwagSection.html b/pages/funkin/system/SwagSection.html index b5680b31..afa03110 100644 --- a/pages/funkin/system/SwagSection.html +++ b/pages/funkin/system/SwagSection.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef SwagSection

package funkin.system

import funkin.system.Section

@:build(hscript.UsingHandler.build())

Fields

typeOfSection:Int

sectionNotes:Array<Dynamic>

mustHitSection:Bool

lengthInSteps:Int

changeBPM:Bool

@:optionaloptionalcamTarget:Null<Float>

bpm:Float

altAnim:Bool

\ No newline at end of file +

typedef SwagSection

package funkin.system

import funkin.system.Section

@:build(hscript.UsingHandler.build())

Fields

typeOfSection:Int

sectionNotes:Array<Dynamic>

mustHitSection:Bool

lengthInSteps:Int

changeBPM:Bool

@:optionaloptionalcamTarget:Null<Float>

bpm:Float

altAnim:Bool

\ No newline at end of file diff --git a/pages/funkin/system/SwagSong.html b/pages/funkin/system/SwagSong.html index 00ad586f..dd3e5051 100644 --- a/pages/funkin/system/SwagSong.html +++ b/pages/funkin/system/SwagSong.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef SwagSong

package funkin.system

import funkin.system.Song

@:build(hscript.UsingHandler.build())

Fields

validScore:Bool

stage:String

speed:Float

song:String

player2:String

player1:String

notes:Array<SwagSection>

noteTypes:Array<String>

needsVoices:Bool

gf:String

bpm:Float

\ No newline at end of file +

typedef SwagSong

package funkin.system

import funkin.system.Song

@:build(hscript.UsingHandler.build())

Fields

validScore:Bool

stage:String

speed:Float

song:String

player2:String

player1:String

notes:Array<SwagSection>

noteTypes:Array<String>

needsVoices:Bool

gf:String

bpm:Float

\ No newline at end of file diff --git a/pages/funkin/system/XMLAnimType.html b/pages/funkin/system/XMLAnimType.html index 46063de1..754b8716 100644 --- a/pages/funkin/system/XMLAnimType.html +++ b/pages/funkin/system/XMLAnimType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract XMLAnimType(Int)

package funkin.system

import funkin.system.XMLSprite

@:build(hscript.UsingHandler.build())@:enum

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 +

enum abstract XMLAnimType(Int)

package funkin.system

import funkin.system.XMLSprite

@:build(hscript.UsingHandler.build())@:enum

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/pages/funkin/system/XMLSprite.html b/pages/funkin/system/XMLSprite.html index 1de9e21b..271e0ec3 100644 --- a/pages/funkin/system/XMLSprite.html +++ b/pages/funkin/system/XMLSprite.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class XMLSprite

package funkin.system

extends FlxSprite

implements IBeatReceiver

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

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

@:value(1)initialZoom:Float = 1

name:String

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Methods

beatHit(curBeat:Int):Void

stepHit(curBeat:Int):Void

\ No newline at end of file +

class XMLSprite

package funkin.system

extends FlxSprite

implements IBeatReceiver

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

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

@:value(1)initialZoom:Float = 1

name:String

@:value(NONE)spriteAnimType:XMLAnimType = NONE

@:value(1)zoomFactor:Float = 1

Methods

beatHit(curBeat:Int):Void

stepHit(curBeat:Int):Void

\ No newline at end of file diff --git a/pages/funkin/system/XMLUtil.html b/pages/funkin/system/XMLUtil.html index aa5db61b..a46b7aec 100644 --- a/pages/funkin/system/XMLUtil.html +++ b/pages/funkin/system/XMLUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class XMLUtil

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Class made to make XML parsing easier.

Static methods

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

Creates a new sprite based on a XML node.

\ No newline at end of file +

class XMLUtil

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

Class made to make XML parsing easier.

Static methods

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

Creates a new sprite based on a XML node.

\ No newline at end of file diff --git a/pages/funkin/system/ZipProgress.html b/pages/funkin/system/ZipProgress.html index 6fb307b8..6970cdae 100644 --- a/pages/funkin/system/ZipProgress.html +++ b/pages/funkin/system/ZipProgress.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ZipProgress

package funkin.system

import funkin.system.ZipUtils

@:directlyUsed@:build(hscript.UsingHandler.build())

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 +

class ZipProgress

package funkin.system

import funkin.system.ZipUtils

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/system/ZipReader.html b/pages/funkin/system/ZipReader.html index 5a8781e0..dc0a2e31 100644 --- a/pages/funkin/system/ZipReader.html +++ b/pages/funkin/system/ZipReader.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ZipReader

package funkin.system

extends Reader

import funkin.system.ZipUtils

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(i:Input)

Variables

files:List<Entry>

Methods

\ No newline at end of file +

class ZipReader

package funkin.system

extends Reader

import funkin.system.ZipUtils

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(i:Input)

Variables

files:List<Entry>

Methods

\ No newline at end of file diff --git a/pages/funkin/system/ZipUtils.html b/pages/funkin/system/ZipUtils.html index 932fbe8f..932685ac 100644 --- a/pages/funkin/system/ZipUtils.html +++ b/pages/funkin/system/ZipUtils.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ZipUtils

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

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 +

class ZipUtils

package funkin.system

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/system/ZipWriter.html b/pages/funkin/system/ZipWriter.html index ac6d1549..003503e0 100644 --- a/pages/funkin/system/ZipWriter.html +++ b/pages/funkin/system/ZipWriter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class ZipWriter

package funkin.system

extends Writer

import funkin.system.ZipUtils

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(o:Output)

Methods

close():Void

flush():Void

writeFile(entry:Entry):Void

\ No newline at end of file +

class ZipWriter

package funkin.system

extends Writer

import funkin.system.ZipUtils

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(o:Output)

Methods

close():Void

flush():Void

writeFile(entry:Entry):Void

\ No newline at end of file diff --git a/pages/funkin/system/index.html b/pages/funkin/system/index.html index ed33a84b..1ce75618 100644 --- a/pages/funkin/system/index.html +++ b/pages/funkin/system/index.html @@ -11,4 +11,4 @@ @author

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

CoolUtil

CrashHandler

Device

DiscordClient

ErrorCode

FramerateField

IniUtils

DOESNT SUPPORT CATEGORIES YET!!

KeyboardScheme

Level

LogText

Logs

Main

MarkdownUtil

MusicBeatGroup

MusicBeatState

MusicBeatSubstate

Paths

PlayingSound

Section

Song

StrNameLabel

SwagSection

SwagSong

XMLAnimType

XMLSprite

XMLUtil

Class made to make XML parsing easier.

ZipProgress

ZipReader

ZipUtils

ZipWriter

\ No newline at end of file +Uses FlxActions to funnel various inputs to a single action.

CoolUtil

CrashHandler

Device

DiscordClient

ErrorCode

FramerateField

IniUtils

DOESNT SUPPORT CATEGORIES YET!!

KeyboardScheme

Level

LogText

Logs

Main

MarkdownUtil

MusicBeatGroup

MusicBeatState

MusicBeatSubstate

Paths

PlayingSound

Section

Song

StrNameLabel

SwagSection

SwagSong

XMLAnimType

XMLSprite

XMLUtil

Class made to make XML parsing easier.

ZipProgress

ZipReader

ZipUtils

ZipWriter

\ No newline at end of file diff --git a/pages/funkin/ui/AlphaCharacter.html b/pages/funkin/ui/AlphaCharacter.html index 4418d1f7..d4bbacc7 100644 --- a/pages/funkin/ui/AlphaCharacter.html +++ b/pages/funkin/ui/AlphaCharacter.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class AlphaCharacter

package funkin.ui

extends FlxSprite

import funkin.ui.Alphabet

@:directlyUsed@:build(hscript.UsingHandler.build())

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 +

class AlphaCharacter

package funkin.ui

extends FlxSprite

import funkin.ui.Alphabet

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/ui/Alphabet.html b/pages/funkin/ui/Alphabet.html index 4934f352..47fe15bc 100644 --- a/pages/funkin/ui/Alphabet.html +++ b/pages/funkin/ui/Alphabet.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Alphabet

package funkin.ui

extends FlxTypedSpriteGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Loosley 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

startTypedText():Void

\ No newline at end of file +

class Alphabet

package funkin.ui

extends FlxTypedSpriteGroup

@:directlyUsed@:build(hscript.UsingHandler.build())

Loosley 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

startTypedText():Void

\ No newline at end of file diff --git a/pages/funkin/ui/FunkinText.html b/pages/funkin/ui/FunkinText.html index 142a977e..c183fae1 100644 --- a/pages/funkin/ui/FunkinText.html +++ b/pages/funkin/ui/FunkinText.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class FunkinText

package funkin.ui

extends FlxText

@:directlyUsed@:build(hscript.UsingHandler.build())

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 +

class FunkinText

package funkin.ui

extends FlxText

@:directlyUsed@:build(hscript.UsingHandler.build())

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/pages/funkin/ui/index.html b/pages/funkin/ui/index.html index 87d31314..c3e62489 100644 --- a/pages/funkin/ui/index.html +++ b/pages/funkin/ui/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.ui

..
AlphaCharacter

Alphabet

Loosley based on FlxTypeText lolol

FunkinText

\ No newline at end of file +

funkin.ui

..
AlphaCharacter

Alphabet

Loosley based on FlxTypeText lolol

FunkinText

\ No newline at end of file diff --git a/pages/funkin/updating/AsyncUpdater.html b/pages/funkin/updating/AsyncUpdater.html index a5d711bb..3d04f9b3 100644 --- a/pages/funkin/updating/AsyncUpdater.html +++ b/pages/funkin/updating/AsyncUpdater.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class AsyncUpdater

package funkin.updating

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value("update-windows.exe")staticexecutableGitHubName:String = "update-windows.exe"

@:value("CodenameEngine.exe")staticexecutableName:String = "CodenameEngine.exe"

Constructor

new(releases:Array<GitHubRelease>)

Variables

downloadStream:URLLoader

@:value(false)executableReplaced:Bool = false

@:value(0)lastTime:Float = 0

@:value(0)oldBytesLoaded:Float = 0

path:String

@:value(new UpdaterProgress())progress:UpdaterProgress = new UpdaterProgress()

releases:Array<GitHubRelease>

Methods

doFile(files:Array<String>, fileNames:Array<String>, onFinish:() ‑> Void):Void

downloadFiles():Void

execute():Void

installFiles(files:Array<String>):Void

installUpdates():Void

prepareInstallationEnvironment():Void

\ No newline at end of file +

class AsyncUpdater

package funkin.updating

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value("update-windows.exe")staticexecutableGitHubName:String = "update-windows.exe"

@:value("CodenameEngine.exe")staticexecutableName:String = "CodenameEngine.exe"

Constructor

new(releases:Array<GitHubRelease>)

Variables

downloadStream:URLLoader

@:value(false)executableReplaced:Bool = false

@:value(0)lastTime:Float = 0

@:value(0)oldBytesLoaded:Float = 0

path:String

@:value(new UpdaterProgress())progress:UpdaterProgress = new UpdaterProgress()

releases:Array<GitHubRelease>

Methods

doFile(files:Array<String>, fileNames:Array<String>, onFinish:() ‑> Void):Void

downloadFiles():Void

execute():Void

installFiles(files:Array<String>):Void

installUpdates():Void

prepareInstallationEnvironment():Void

\ No newline at end of file diff --git a/pages/funkin/updating/UpdateAvailableScreen.html b/pages/funkin/updating/UpdateAvailableScreen.html index c4813bba..311b3754 100644 --- a/pages/funkin/updating/UpdateAvailableScreen.html +++ b/pages/funkin/updating/UpdateAvailableScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class UpdateAvailableScreen

package funkin.updating

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(check:UpdateCheckCallback)

Variables

bg:FlxSprite

changeLogText:FunkinText

check:UpdateCheckCallback

installButton:FunkinText

@:value(true)installSelected:Bool = true

optionsBG:FlxSprite

skipButton:FunkinText

title:Alphabet

versionCheckBG:FlxSprite

versionDifferenceLabel:FunkinText

Methods

changeSelection():Void

select():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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class UpdateAvailableScreen

package funkin.updating

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(check:UpdateCheckCallback)

Variables

bg:FlxSprite

changeLogText:FunkinText

check:UpdateCheckCallback

installButton:FunkinText

@:value(true)installSelected:Bool = true

optionsBG:FlxSprite

skipButton:FunkinText

title:Alphabet

versionCheckBG:FlxSprite

versionDifferenceLabel:FunkinText

Methods

changeSelection():Void

select():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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/updating/UpdateCheckCallback.html b/pages/funkin/updating/UpdateCheckCallback.html index 48792aed..c4d102ed 100644 --- a/pages/funkin/updating/UpdateCheckCallback.html +++ b/pages/funkin/updating/UpdateCheckCallback.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef UpdateCheckCallback

package funkin.updating

import funkin.updating.UpdateUtil

@:build(hscript.UsingHandler.build())

Fields

@:optionaloptionalupdates:Null<Array<GitHubRelease>>

success:Bool

@:optionaloptionalnewVersionTag:Null<String>

newUpdate:Bool

@:optionaloptionalcurrentVersionTag:Null<String>

\ No newline at end of file +

typedef UpdateCheckCallback

package funkin.updating

import funkin.updating.UpdateUtil

@:build(hscript.UsingHandler.build())

Fields

@:optionaloptionalupdates:Null<Array<GitHubRelease>>

success:Bool

@:optionaloptionalnewVersionTag:Null<String>

newUpdate:Bool

@:optionaloptionalcurrentVersionTag:Null<String>

\ No newline at end of file diff --git a/pages/funkin/updating/UpdateScreen.html b/pages/funkin/updating/UpdateScreen.html index d85b51ed..17b3dc4c 100644 --- a/pages/funkin/updating/UpdateScreen.html +++ b/pages/funkin/updating/UpdateScreen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class UpdateScreen

package funkin.updating

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(check:UpdateCheckCallback)

Variables

bf:FlxSprite

@:value(false)done:Bool = false

@:value(0)elapsedTime:Float = 0

generalProgress:FunkinText

@:value(0)lerpSpeed:Float = 0

overSound:FlxSound

partProgress:FunkinText

progressBar:FlxBar

rainbowShader:CustomShader

updater:AsyncUpdater

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file +

class UpdateScreen

package funkin.updating

extends MusicBeatState

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(check:UpdateCheckCallback)

Variables

bf:FlxSprite

@:value(false)done:Bool = false

@:value(0)elapsedTime:Float = 0

generalProgress:FunkinText

@:value(0)lerpSpeed:Float = 0

overSound:FlxSound

partProgress:FunkinText

progressBar:FlxBar

rainbowShader:CustomShader

updater:AsyncUpdater

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.

read onlycurBeat:Int

Current beat

read onlycurBeatFloat: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)

parentWindow:StateWindow

@: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 independant of framerate.

openSubState(subState:FlxSubState):Void

SCRIPTING STUFF

\ No newline at end of file diff --git a/pages/funkin/updating/UpdateUtil.html b/pages/funkin/updating/UpdateUtil.html index b0898220..cbeb36a5 100644 --- a/pages/funkin/updating/UpdateUtil.html +++ b/pages/funkin/updating/UpdateUtil.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class UpdateUtil

package funkin.updating

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value("CodenameTestRepo")staticfinalread onlyrepoName:String = "CodenameTestRepo"

@:value("YoshiCrafter29")staticfinalread onlyrepoOwner:String = "YoshiCrafter29"

Static methods

staticcheckForUpdates():UpdateCheckCallback

staticinit():Void

\ No newline at end of file +

class UpdateUtil

package funkin.updating

@:directlyUsed@:build(hscript.UsingHandler.build())

Static variables

@:value("CodenameTestRepo")staticfinalread onlyrepoName:String = "CodenameTestRepo"

@:value("YoshiCrafter29")staticfinalread onlyrepoOwner:String = "YoshiCrafter29"

Static methods

staticcheckForUpdates():UpdateCheckCallback

staticinit():Void

\ No newline at end of file diff --git a/pages/funkin/updating/UpdaterProgress.html b/pages/funkin/updating/UpdaterProgress.html index 51b0af15..ae608349 100644 --- a/pages/funkin/updating/UpdaterProgress.html +++ b/pages/funkin/updating/UpdaterProgress.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class UpdaterProgress

package funkin.updating

import funkin.updating.AsyncUpdater

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

@:value(0)bytesLoaded:Float = 0

@:value(0)bytesTotal:Float = 0

@:value(0)curFile:Int = 0

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

@:value(new ZipProgress())curZipProgress:ZipProgress = new ZipProgress()

@:value(false)done:Bool = false

@:value(0)downloadSpeed:Float = 0

@:value(0)files:Int = 0

@:value(PREPARING)step:UpdaterStep = PREPARING

\ No newline at end of file +

class UpdaterProgress

package funkin.updating

import funkin.updating.AsyncUpdater

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new()

Variables

@:value(0)bytesLoaded:Float = 0

@:value(0)bytesTotal:Float = 0

@:value(0)curFile:Int = 0

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

@:value(new ZipProgress())curZipProgress:ZipProgress = new ZipProgress()

@:value(false)done:Bool = false

@:value(0)downloadSpeed:Float = 0

@:value(0)files:Int = 0

@:value(PREPARING)step:UpdaterStep = PREPARING

\ No newline at end of file diff --git a/pages/funkin/updating/UpdaterStep.html b/pages/funkin/updating/UpdaterStep.html index ce8b81e2..c6d51db7 100644 --- a/pages/funkin/updating/UpdaterStep.html +++ b/pages/funkin/updating/UpdaterStep.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract UpdaterStep(Int)

package funkin.updating

import funkin.updating.AsyncUpdater

@:build(hscript.UsingHandler.build())@:enum

Variables

@:value(cast 1)@:impl@:enuminlineread onlyDOWNLOADING_ASSETS:UpdaterStep = 1

@:value(cast 2)@:impl@:enuminlineread onlyDOWNLOADING_EXECUTABLE:UpdaterStep = 2

@:value(cast 3)@:impl@:enuminlineread onlyINSTALLING:UpdaterStep = 3

@:value(cast 0)@:impl@:enuminlineread onlyPREPARING:UpdaterStep = 0

\ No newline at end of file +

enum abstract UpdaterStep(Int)

package funkin.updating

import funkin.updating.AsyncUpdater

@:build(hscript.UsingHandler.build())@:enum

Variables

@:value(cast 1)@:impl@:enuminlineread onlyDOWNLOADING_ASSETS:UpdaterStep = 1

@:value(cast 2)@:impl@:enuminlineread onlyDOWNLOADING_EXECUTABLE:UpdaterStep = 2

@:value(cast 3)@:impl@:enuminlineread onlyINSTALLING:UpdaterStep = 3

@:value(cast 0)@:impl@:enuminlineread onlyPREPARING:UpdaterStep = 0

\ No newline at end of file diff --git a/pages/funkin/updating/index.html b/pages/funkin/updating/index.html index 519a7efb..039425ad 100644 --- a/pages/funkin/updating/index.html +++ b/pages/funkin/updating/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.updating

..
AsyncUpdater

UpdateAvailableScreen

UpdateCheckCallback

UpdateScreen

UpdateUtil

UpdaterProgress

UpdaterStep

\ No newline at end of file +

funkin.updating

..
AsyncUpdater

UpdateAvailableScreen

UpdateCheckCallback

UpdateScreen

UpdateUtil

UpdaterProgress

UpdaterStep

\ No newline at end of file diff --git a/pages/funkin/windows/ConsoleColor.html b/pages/funkin/windows/ConsoleColor.html index 371bda55..97d13cf9 100644 --- a/pages/funkin/windows/ConsoleColor.html +++ b/pages/funkin/windows/ConsoleColor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract ConsoleColor(Int)

package funkin.windows

import funkin.windows.WindowsAPI

@:build(hscript.UsingHandler.build())@:enum

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

enum abstract ConsoleColor(Int)

package funkin.windows

import funkin.windows.WindowsAPI

@:build(hscript.UsingHandler.build())@:enum

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 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/pages/funkin/windows/MessageBoxIcon.html b/pages/funkin/windows/MessageBoxIcon.html index 318bc9d1..59278382 100644 --- a/pages/funkin/windows/MessageBoxIcon.html +++ b/pages/funkin/windows/MessageBoxIcon.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

enum abstract MessageBoxIcon(Int)

package funkin.windows

import funkin.windows.WindowsAPI

@:build(hscript.UsingHandler.build())@:enum

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 +

enum abstract MessageBoxIcon(Int)

package funkin.windows

import funkin.windows.WindowsAPI

@:build(hscript.UsingHandler.build())@:enum

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/pages/funkin/windows/WindowsAPI.html b/pages/funkin/windows/WindowsAPI.html index ddb350ed..2eee6551 100644 --- a/pages/funkin/windows/WindowsAPI.html +++ b/pages/funkin/windows/WindowsAPI.html @@ -9,4 +9,4 @@ Does not have any effect on other platforms."/> \ 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

staticconsoleColorToOpenFL(color:ConsoleColor):Int

@:value({ backgroundColor : BLACK, foregroundColor : LIGHTGRAY })staticsetConsoleColors(foregroundColor:ConsoleColor = LIGHTGRAY, backgroundColor:ConsoleColor = BLACK):Void

Sets the console colors

staticsetDarkMode(enable:Bool):Void

Sets the window titlebar to dark mode (Windows 10 only)

@: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/pages/funkin/windows/index.html b/pages/funkin/windows/index.html index cb568140..77235f9b 100644 --- a/pages/funkin/windows/index.html +++ b/pages/funkin/windows/index.html @@ -8,4 +8,4 @@ text-shadow: 0 0 0 transparent; }

funkin.windows

..
ConsoleColor

MessageBoxIcon

WindowsAPI

Class for Windows-only functions, such as transparent windows, message boxes, and more. -Does not have any effect on other platforms.

\ No newline at end of file +Does not have any effect on other platforms.

\ No newline at end of file diff --git a/pages/index.html b/pages/index.html index 0fbc4daf..9806d0ef 100644 --- a/pages/index.html +++ b/pages/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

top level

funkin
scripting
\ No newline at end of file +

top level

funkin
scripting
\ No newline at end of file diff --git a/pages/scripting/CharacterScript.html b/pages/scripting/CharacterScript.html index 0897a428..881a01af 100644 --- a/pages/scripting/CharacterScript.html +++ b/pages/scripting/CharacterScript.html @@ -9,4 +9,4 @@ }

interface CharacterScript

package scripting

@:build(hscript.UsingHandler.build())

Contains all callbacks you can add in a Character script.

To add a Character script, create a file here: data/characters/my-char.hx

Methods

beatHit(curBeat:Int):Void

Triggered every beat

create():Void

Triggered after the characters XML has been loaded.

onDance(event:DanceEvent):Void

Triggered everytime the character will dance (play its idle animation).

onGetCamPos(event:PointEvent):Void

Triggered everytime the game tries to get your player's camera position. -This event cannot be cancelled.

onPlayAnim(event:PlayAnimEvent):Void

Triggered everytime the game tries to play an animation on your character.

onPlaySingAnim(event:DirectionAnimEvent):Void

Triggered everytime the game tries to play a sing, alt sing or miss animation.

postCreate():Void

Triggered after the character has been entirely loaded.

stepHit(curStep:Int):Void

Triggered every step

update(elapsed:Float):Void

Triggered every frame.

\ No newline at end of file +This event cannot be cancelled.

onPlayAnim(event:PlayAnimEvent):Void

Triggered everytime the game tries to play an animation on your character.

onPlaySingAnim(event:DirectionAnimEvent):Void

Triggered everytime the game tries to play a sing, alt sing or miss animation.

postCreate():Void

Triggered after the character has been entirely loaded.

stepHit(curStep:Int):Void

Triggered every step

update(elapsed:Float):Void

Triggered every frame.

\ No newline at end of file diff --git a/pages/scripting/GlobalScript.html b/pages/scripting/GlobalScript.html index f87cece5..2cd3477d 100644 --- a/pages/scripting/GlobalScript.html +++ b/pages/scripting/GlobalScript.html @@ -11,4 +11,4 @@

To create one, go to data and create a script named "global", then press F5 in game to hot reload.

All flixel signals are automatically binded, as shown below.

Methods

focusGained():Void

Called whenever the game gains focus.

focusLost():Void

Called whenever the game loses focus.

gameResized(width:Int, height:Int):Void

Called whenever the game loses focus.

Parameters:

width

Width of the game

height

Height of the game

postDraw():Void

Called after the screen has been drawn.

postGameReset():Void

Called after the game has been reset.

postGameStart():Void

Called after the game has been started.

postStateSwitch():Void

Called after the state has been switched.

postUpdate(elapsed:Float):Void

Called after the game has been updated.

Aliases: postUpdate

Parameters:

elapsed

Time elapsed since last frame

preDraw():Void

Called before the game draws on screen.

preGameReset():Void

Called before the game resets.

preGameStart():Void

Called before the game starts.

preStateCreate(state:FlxState):Void

Called before the state creates.

preStateSwitch():Void

Called before the state switches.

update(elapsed:Float):Void

Called before the game updates.

-

Aliases: preUpdate

\ No newline at end of file +

Aliases: preUpdate

\ No newline at end of file diff --git a/pages/scripting/PlayStateScript.html b/pages/scripting/PlayStateScript.html index e31405c5..3a9eb5c2 100644 --- a/pages/scripting/PlayStateScript.html +++ b/pages/scripting/PlayStateScript.html @@ -9,4 +9,4 @@ }

interface PlayStateScript

package scripting

@:build(hscript.UsingHandler.build())

Contains all callbacks you can add in modcharts and stage scripts.

NOTE: In case you're scripting a stage, all sprites of that stage are directly accessible via their name.

-

Ex: If you added a superCoolBG element in your stage XML, you'll be able to access it via scripts by using superCoolBG.

Methods

beatHit(curBeat:Int):Void

Triggered every beat.

Parameters:

curBeat

Current beat.

create():Void

Triggered after the characters has been created, during PlayState's creation.

inputPostUpdate(event:InputSystemEvent):Void

Triggered after the input system updates.

Parameters:

note

Event object with the pressed, justPressed and justReleased notes.

inputUpdate(event:InputSystemEvent):Void

Triggered whenever the input system updates.

Parameters:

note

Event object with the pressed notes, which allows you to alter which notes are being pressed during this frame, or simply cancel the input update.

onCountdown(event:CountdownEvent):Void

Triggered every countdown.

Parameters:

event

Countdown event.

onDadHit(event:NoteHitEvent):Void

Triggered whenever the opponent hits a note.

Parameters:

note

Event object with the note being pressed, the character who pressed it, and functions to alter or cancel the default behaviour.

onNoteCreation(event:NoteCreationEvent):Void

Triggered on each note creation

Parameters:

event

Event object containing information about the note.

onPlayerHit(event:NoteHitEvent):Void

Triggered whenever the player hits a note.

Parameters:

note

Event object with the note being pressed, the character who pressed it, and functions to alter or cancel the default behaviour.

onPostCountdown(event:CountdownEvent):Void

Triggered after every countdown.

Parameters:

event

Countdown event.

onStrumCreation(event:StrumCreationEvent):Void

Triggered on each strum creation

Parameters:

event

Event object containing information about the strum.

onSubstateClose(event:StateEvent):Void

Triggered on substate close.

Parameters:

event

Event object containing the substate, which is cancellable.

onSubstateOpen(event:StateEvent):Void

Triggered on substate open.

Parameters:

event

Event object containing the substate, which is cancellable.

postCreate():Void

Triggered at the very end of PlayState's creation

postUpdate(elapsed:Float):Void

Triggered at the end of every frame.

Parameters:

elapsed

Time elapsed since last frame.

stepHit(curStep:Int):Void

Triggered every step

Parameters:

curStep

Current step.

update(elapsed:Float):Void

Triggered every frame.

Parameters:

elapsed

Time elapsed since last frame.

\ No newline at end of file +

Ex: If you added a superCoolBG element in your stage XML, you'll be able to access it via scripts by using superCoolBG.

Methods

beatHit(curBeat:Int):Void

Triggered every beat.

Parameters:

curBeat

Current beat.

create():Void

Triggered after the characters has been created, during PlayState's creation.

inputPostUpdate(event:InputSystemEvent):Void

Triggered after the input system updates.

Parameters:

note

Event object with the pressed, justPressed and justReleased notes.

inputUpdate(event:InputSystemEvent):Void

Triggered whenever the input system updates.

Parameters:

note

Event object with the pressed notes, which allows you to alter which notes are being pressed during this frame, or simply cancel the input update.

onCountdown(event:CountdownEvent):Void

Triggered every countdown.

Parameters:

event

Countdown event.

onDadHit(event:NoteHitEvent):Void

Triggered whenever the opponent hits a note.

Parameters:

note

Event object with the note being pressed, the character who pressed it, and functions to alter or cancel the default behaviour.

onNoteCreation(event:NoteCreationEvent):Void

Triggered on each note creation

Parameters:

event

Event object containing information about the note.

onPlayerHit(event:NoteHitEvent):Void

Triggered whenever the player hits a note.

Parameters:

note

Event object with the note being pressed, the character who pressed it, and functions to alter or cancel the default behaviour.

onPostCountdown(event:CountdownEvent):Void

Triggered after every countdown.

Parameters:

event

Countdown event.

onStrumCreation(event:StrumCreationEvent):Void

Triggered on each strum creation

Parameters:

event

Event object containing information about the strum.

onSubstateClose(event:StateEvent):Void

Triggered on substate close.

Parameters:

event

Event object containing the substate, which is cancellable.

onSubstateOpen(event:StateEvent):Void

Triggered on substate open.

Parameters:

event

Event object containing the substate, which is cancellable.

postCreate():Void

Triggered at the very end of PlayState's creation

postUpdate(elapsed:Float):Void

Triggered at the end of every frame.

Parameters:

elapsed

Time elapsed since last frame.

stepHit(curStep:Int):Void

Triggered every step

Parameters:

curStep

Current step.

update(elapsed:Float):Void

Triggered every frame.

Parameters:

elapsed

Time elapsed since last frame.

\ No newline at end of file diff --git a/pages/scripting/index.html b/pages/scripting/index.html index 2fcbf26c..dec80e15 100644 --- a/pages/scripting/index.html +++ b/pages/scripting/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

scripting

..
CharacterScript

Contains all callbacks you can add in a Character script.

GlobalScript

A global script is a special kind of script that runs on everywhere on your mod: menus, game, etc...

PlayStateScript

Contains all callbacks you can add in modcharts and stage scripts.

\ No newline at end of file +

scripting

..
CharacterScript

Contains all callbacks you can add in a Character script.

GlobalScript

A global script is a special kind of script that runs on everywhere on your mod: menus, game, etc...

PlayStateScript

Contains all callbacks you can add in modcharts and stage scripts.

\ No newline at end of file diff --git a/source/funkin/game/Note.hx b/source/funkin/game/Note.hx index 9baa107f..b0112cbb 100644 --- a/source/funkin/game/Note.hx +++ b/source/funkin/game/Note.hx @@ -45,6 +45,11 @@ class Note extends FlxSprite */ public var nextSustain:Note; + /** + * Name of the splash. + */ + public var splash:String = "default"; + public var strumID(get, never):Int; private function get_strumID() { var id = noteData % 4; diff --git a/source/funkin/game/PlayState.hx b/source/funkin/game/PlayState.hx index 26264d0a..fd4217b4 100644 --- a/source/funkin/game/PlayState.hx +++ b/source/funkin/game/PlayState.hx @@ -1,5 +1,6 @@ package funkin.game; +import funkin.game.SplashHandler; import funkin.editors.CharacterEditor; import funkin.scripting.DummyScript; import funkin.menus.StoryMenuState.WeekData; @@ -190,6 +191,11 @@ class PlayState extends MusicBeatState */ public var cpuStrums:FlxTypedGroup; + /** + * Note splashes container + */ + public var splashHandler:SplashHandler; + /** * Whenever the vocals should be muted when a note is missed. */ @@ -581,6 +587,9 @@ class PlayState extends MusicBeatState cpuStrums = new FlxTypedGroup(); add(strumLineNotes); + splashHandler = new SplashHandler(); + add(splashHandler); + generateSong(SONG); if (prevCamFollow != null) @@ -868,6 +877,8 @@ class PlayState extends MusicBeatState swagNote.stepLength = stepCrochet; notes.add(swagNote); } + + splashHandler.getSplashGroup(swagNote.splash); } daBeats += 1; } @@ -1450,43 +1461,40 @@ class PlayState extends MusicBeatState function noteMiss(note:Note):Void { - if (!boyfriend.stunned) + var event:NoteHitEvent = scripts.event("onPlayerMiss", EventManager.get(NoteHitEvent).recycle(true, false, false, note, [boyfriend], true, note.noteType, "", "", "", note.strumID, -10, 0, -0.04, "shit")); + + if (event.cancelled) return; + + health += event.healthGain; + if (gf != null && combo > 5 && gf.animOffsets.exists('sad')) { - var event:NoteHitEvent = scripts.event("onPlayerMiss", EventManager.get(NoteHitEvent).recycle(true, false, false, note, [boyfriend], true, note.noteType, "", "", "", note.strumID, -10, 0, -0.04, "shit")); - - if (event.cancelled) return; - - health += event.healthGain; - if (gf != null && combo > 5 && gf.animOffsets.exists('sad')) - { - gf.playAnim('sad', true, MISS); - } - combo = 0; - - songScore -= 10; - misses++; - - FlxG.sound.play(Paths.soundRandom('missnote', 1, 3), FlxG.random.float(0.1, 0.2)); - - if (muteVocalsOnMiss) vocals.volume = 0; - - if (event.accuracy != null) { - accuracyPressedNotes++; - totalAccuracyAmount += event.accuracy; - - updateRating(); - } - - for(char in event.characters) { - if (char == null) continue; - - char.stunned = true; - char.playSingAnim(note.strumID, "miss", MISS); - } - // boyfriend.stunned = true; - - deleteNote(note); + gf.playAnim('sad', true, MISS); } + combo = 0; + + songScore -= 10; + misses++; + + FlxG.sound.play(Paths.soundRandom('missnote', 1, 3), FlxG.random.float(0.1, 0.2)); + + if (muteVocalsOnMiss) vocals.volume = 0; + + if (event.accuracy != null) { + accuracyPressedNotes++; + totalAccuracyAmount += event.accuracy; + + updateRating(); + } + + for(char in event.characters) { + if (char == null) continue; + + char.stunned = true; + char.playSingAnim(note.strumID, "miss", MISS); + } + // boyfriend.stunned = true; + + deleteNote(note); } public function getNoteType(id:Int):String { @@ -1529,9 +1537,9 @@ class PlayState extends MusicBeatState var event:NoteHitEvent; if (note.mustPress) // event = scripts.event("onPlayerHit", EventManager.get(NoteHitEvent).recycle(note, [boyfriend], true, note.noteType, note.strumID, note.noteData > 0 ? 0.023 : 0.004, score, note.animSuffix, daRating, note.isSustainNote ? null : accuracy, "game/score/", '')); - event = scripts.event("onPlayerHit", EventManager.get(NoteHitEvent).recycle(false, !note.isSustainNote, !note.isSustainNote, note, [boyfriend], true, note.noteType, "", "game/score/", "", note.strumID, score, note.isSustainNote ? null : accuracy, note.noteData > 0 ? 0.023 : 0.004, daRating)); + event = scripts.event("onPlayerHit", EventManager.get(NoteHitEvent).recycle(false, !note.isSustainNote, !note.isSustainNote, note, [boyfriend], true, note.noteType, "", "game/score/", "", note.strumID, score, note.isSustainNote ? null : accuracy, note.noteData > 0 ? 0.023 : 0.004, daRating, daRating == "sick")); else - event = scripts.event("onDadHit", EventManager.get(NoteHitEvent).recycle(false, false, false, note, [dad], false, note.noteType, "", "game/score/", "", note.strumID, 0, null, 0, daRating)); + event = scripts.event("onDadHit", EventManager.get(NoteHitEvent).recycle(false, false, false, note, [dad], false, note.noteType, "", "game/score/", "", note.strumID, 0, null, 0, daRating, false)); if (!event.cancelled) { if (event.accuracy != null) { @@ -1625,9 +1633,10 @@ class PlayState extends MusicBeatState if (char != null) char.playSingAnim(event.direction, event.animSuffix); - if (!event.strumGlowCancelled) (event.player ? playerStrums : cpuStrums).forEach(function(str:Strum) { + (event.player ? playerStrums : cpuStrums).forEach(function(str:Strum) { if (str.ID == Math.abs(note.strumID)) { - str.press(note.strumTime); + if (!event.strumGlowCancelled) str.press(note.strumTime); + if (event.showSplash) splashHandler.showSplash(note.splash, str); } }); } diff --git a/source/funkin/game/SplashGroup.hx b/source/funkin/game/SplashGroup.hx new file mode 100644 index 00000000..bac3b88f --- /dev/null +++ b/source/funkin/game/SplashGroup.hx @@ -0,0 +1,117 @@ +package funkin.game; + +import flixel.FlxG; +import openfl.utils.Assets; +import haxe.xml.Access; +import flixel.group.FlxGroup.FlxTypedGroup; + +class SplashGroup extends FlxTypedGroup { + /** + * Whenever the splash group has successfully loaded or not. + */ + public var valid:Bool = true; + + /** + * XML data for the note splashes. + */ + public var xml:Access; + + /** + * Animation names sorted by strum IDs. + * Use `getSplashAnim` to get one. + */ + public var animationNames:Array> = []; + + /** + * Creates a new Splash group + * @param path Path to the splash data (xml) + */ + public function new(path) { + super(); + + try { + xml = new Access(Xml.parse(Assets.getText(path)).firstElement()); + + if (!xml.has.sprite) throw "The element requires a sprite attribute."; + + var splashSprite = new FunkinSprite(); + splashSprite.antialiasing = true; + splashSprite.active = splashSprite.visible = false; + splashSprite.loadSprite(Paths.image(xml.att.sprite)); + + /** + * ANIMATIONS + */ + for(strum in xml.nodes.strum) { + var id:Null = Std.parseInt(strum.att.id); + if (id != null) { + animationNames[id] = []; + for(anim in strum.nodes.anim) { + if (!anim.has.name) continue; + XMLUtil.addXMLAnimation(splashSprite, anim, false); + animationNames[id].push(anim.att.name); + } + } + } + if (animationNames.length <= 0) + animationNames.push([]); + for(anim in xml.nodes.anim) { + if (!anim.has.name) continue; + XMLUtil.addXMLAnimation(splashSprite, anim, false); + for(a in animationNames) { + if (a == null) continue; + a.push(anim.att.name); + } + } + /** + * END OF ANIMATIONS + */ + splashSprite.animation.finishCallback = function(name) { + splashSprite.active = splashSprite.visible = false; + }; + + if (xml.has.scale) splashSprite.scale.scale(Std.parseFloat(xml.att.scale).getDefault(1)); + if (xml.has.alpha) splashSprite.alpha = Std.parseFloat(xml.att.alpha).getDefault(1); + if (xml.has.antialiasing) splashSprite.antialiasing = xml.att.antialiasing == "true"; + + add(splashSprite); + + for (i in 0...7) { + // make 7 additional splashes + var spr = FunkinSprite.copyFrom(splashSprite); + spr.animation.finishCallback = function(name) { + spr.active = spr.visible = false; + }; + add(spr); + } + + // immediatly draw once and put image in GPU to prevent freezes + splashSprite.draw(); + } catch(e) { + Logs.trace('Couldn\'t parse splash data for "${path}": ${e.toString()}', ERROR); + valid = false; + } + + maxSize = 8; + } + + public function getSplashAnim(id:Int):String { + if (animationNames.length <= 0) return null; + id %= animationNames.length; + if (animationNames[id] == null) return null; + if (animationNames[id].length <= 0) return null; + return animationNames[id][FlxG.random.int(0, animationNames[id].length-1)]; + } + + public function showOnStrum(strum:Strum) { + if (!valid) return null; + var splash = recycle(); + + splash.cameras = strum.lastDrawCameras; + splash.setPosition(strum.x + ((strum.width - splash.width) / 2), strum.y + ((strum.height - splash.height) / 2)); + splash.active = splash.visible = true; + splash.playAnim(getSplashAnim(strum.ID), true); + + return splash; + } +} \ No newline at end of file diff --git a/source/funkin/game/SplashHandler.hx b/source/funkin/game/SplashHandler.hx new file mode 100644 index 00000000..2c04d2bf --- /dev/null +++ b/source/funkin/game/SplashHandler.hx @@ -0,0 +1,42 @@ +package funkin.game; + +import flixel.group.FlxGroup.FlxTypedGroup; + +class SplashHandler extends FlxTypedGroup { + /** + * Map containing all of the splashes group. + */ + public var grpMap:Map = []; + + public function new() { + super(); + } + + /** + * Returns a group of splashes, and creates it if it doesn't exist. + * @param path Path to the splashes XML (`Paths.xml('splashes/splash')`) + */ + public function getSplashGroup(name:String) { + if (!grpMap.exists(name)) { + var grp = new SplashGroup(Paths.xml('splashes/$name')); + grpMap.set(name, grp); + } + return grpMap.get(name); + } + + public override function destroy() { + super.destroy(); + for(grp in grpMap) + grp.destroy(); + grpMap = null; + } + + public function showSplash(name:String, strum:Strum) { + var grp = getSplashGroup(name); + add(grp.showOnStrum(strum)); + + // max 8 rendered splashes + while(members.length > 8) + remove(members[0]); + } +} \ No newline at end of file diff --git a/source/funkin/scripting/events/NoteHitEvent.hx b/source/funkin/scripting/events/NoteHitEvent.hx index 0fa00d07..951383bd 100644 --- a/source/funkin/scripting/events/NoteHitEvent.hx +++ b/source/funkin/scripting/events/NoteHitEvent.hx @@ -75,6 +75,10 @@ class NoteHitEvent extends CancellableEvent { * Rating name. Defaults to "sick", "good", "bad" and "shit". Customisable. */ public var rating:String = "sick"; + /** + * Whenever a splash should be shown when the note is hit. + */ + public var showSplash:Bool = false; /** * Scale of combo numbers. */ diff --git a/source/funkin/system/FunkinSprite.hx b/source/funkin/system/FunkinSprite.hx index d9472291..f60295fc 100644 --- a/source/funkin/system/FunkinSprite.hx +++ b/source/funkin/system/FunkinSprite.hx @@ -41,6 +41,18 @@ class FunkinSprite extends FlxSprite implements IBeatReceiver implements IOffset @:noCompletion public var atlasPlayingAnim:String; @:noCompletion public var atlasPath:String; + public static function copyFrom(source:FunkinSprite) { + var spr = new FunkinSprite(); + spr.setPosition(source.x, source.y); + spr.frames = source.frames; + if (source.animateAtlas != null && source.atlasPath != null) + spr.loadSprite(source.atlasPath); + spr.animation.copyFrom(source.animation); + spr.visible = source.visible; + spr.alpha = source.alpha; + return spr; + } + public override function update(elapsed:Float) { super.update(elapsed); if (animateAtlas != null)