From 8c9ea3281d1eac9755177d2dadbc7c98dd43b9d6 Mon Sep 17 00:00:00 2001 From: Yoshman29 Date: Sun, 30 Oct 2022 20:37:00 +0100 Subject: [PATCH] doc --- docs/doc.xml | 837 +++++++++++++----- pages/funkin/desktop/DesktopMain.html | 2 +- pages/funkin/desktop/editors/Butt.html | 10 + .../desktop/editors/CharacterEditor.html | 2 +- .../desktop/editors/EditorPlayState.html | 10 + pages/funkin/desktop/editors/HelloWorld.html | 2 +- pages/funkin/desktop/editors/MessageBox.html | 10 + .../desktop/editors/MessageBoxIcon.html | 10 + pages/funkin/desktop/editors/index.html | 2 +- pages/funkin/desktop/sprites/Button.html | 2 +- pages/funkin/desktop/sprites/WindowText.html | 10 + pages/funkin/desktop/sprites/index.html | 2 +- pages/funkin/desktop/theme/Theme.html | 2 +- pages/funkin/desktop/theme/ThemeData.html | 2 +- pages/funkin/desktop/windows/Window.html | 2 +- .../desktop/windows/WindowCaptionButton.html | 2 +- .../funkin/desktop/windows/WindowContent.html | 2 +- pages/funkin/game/Character.html | 2 +- pages/funkin/game/HudCamera.html | 10 + pages/funkin/game/Note.html | 2 +- pages/funkin/game/PlayState.html | 2 +- pages/funkin/game/Strum.html | 2 +- pages/funkin/game/index.html | 2 +- .../scripting/events/CancellableEvent.html | 2 +- .../scripting/events/NoteUpdateEvent.html | 12 + .../scripting/events/StrumCreationEvent.html | 12 + .../scripting/events/SubstateEvent.html | 12 + pages/funkin/scripting/events/index.html | 2 +- pages/funkin/system/Conductor.html | 2 +- pages/nav.js | 2 +- pages/scripting/PlayStateScript.html | 2 +- .../scripting/events/StrumCreationEvent.hx | 3 + .../funkin/scripting/events/SubstateEvent.hx | 5 +- 33 files changed, 756 insertions(+), 227 deletions(-) create mode 100644 pages/funkin/desktop/editors/Butt.html create mode 100644 pages/funkin/desktop/editors/EditorPlayState.html create mode 100644 pages/funkin/desktop/editors/MessageBox.html create mode 100644 pages/funkin/desktop/editors/MessageBoxIcon.html create mode 100644 pages/funkin/desktop/sprites/WindowText.html create mode 100644 pages/funkin/game/HudCamera.html create mode 100644 pages/funkin/scripting/events/NoteUpdateEvent.html create mode 100644 pages/funkin/scripting/events/StrumCreationEvent.html create mode 100644 pages/funkin/scripting/events/SubstateEvent.html diff --git a/docs/doc.xml b/docs/doc.xml index 2e80bcbe..48d79a0b 100644 --- a/docs/doc.xml +++ b/docs/doc.xml @@ -18766,9 +18766,9 @@ - <__touch get="inline" set="null" expr=""1.666794645e+012"" line="22" static="1"> + <__touch get="inline" set="null" expr=""1.667158547e+012"" line="22" static="1"> - "1.666794645e+012" + "1.667158547e+012" @@ -21146,11 +21146,11 @@ FlxRect.get() - + "`FlxCamera.defaultCameras` is deprecated, use `FlxG.cameras.setDefaultDrawTarget` instead" - + @@ -21592,7 +21592,7 @@ - + @@ -21637,31 +21637,39 @@ - + - + { smoothing : false } - + + + false + + + + false + + - + - + { smoothing : false } - + @@ -21676,7 +21684,7 @@ { smoothing : false, repeat : false } - + @@ -21685,7 +21693,7 @@ * @param rect rectangle to prepare for rendering * @return transformed rectangle with respect to camera's zoom factor - + @@ -21694,7 +21702,7 @@ * @param point point to prepare for rendering * @return transformed point with respect to camera's zoom factor - + @@ -21703,7 +21711,7 @@ * @param vector relative position to prepare for rendering * @return transformed vector with respect to camera's zoom factor - + @@ -21714,23 +21722,23 @@ * @param object display object to apply transformations to. * @return transformed object. - + * Clean up memory. - + * Updates the camera scroll as well as special effects like screen-shake or fades. - + * Updates (bounds) the camera scroll. * Called every frame by camera's `update()` method. - + @@ -21738,30 +21746,30 @@ * Updates camera's scroll. * Called every frame by camera's `update()` method (if camera's `target` isn't `null`). - + - + - - + + - + * Recalculates `flashSprite` position. * Called every frame by camera's `update()` method and every time you change camera's position. - + * Recalculates `_flashOffset` point, which is used for positioning flashSprite in the game. * It's called every time you resize the camera or the game. - + * Updates `_scrollRect` sprite to crop graphics of the camera: * 1) `scrollRect` property of this sprite @@ -21770,15 +21778,15 @@ * It takes camera's size and game's scale into account. * It's called every time you resize the camera or the game. - - + + * Modifies position of `_flashBitmap` in blit render mode and `canvas` and `debugSprite` * in tile render mode (these objects are children of `_scrollRect` sprite). * It takes camera's size and game's scale into account. * It's called every time you resize the camera or the game. - + @@ -21793,12 +21801,12 @@ * manually specify the deadzone after calling `follow()`. * @param Lerp How much lag the camera should have (can help smooth out the camera movement). - + * Snaps the camera to the current `target`. Useful to move the camera without * any easing when the `target` position changes and there is a `followLerp`. - + @@ -21807,7 +21815,7 @@ * * @param Point Where you want the camera to focus. - + @@ -21823,7 +21831,7 @@ * @param OnComplete A function you want to run when the flash finishes. * @param Force Force the effect to reset. - + @@ -21841,7 +21849,7 @@ * @param OnComplete A function you want to run when the fade finishes. * @param Force Force the effect to reset. - + @@ -21860,18 +21868,18 @@ * @param Force Force the effect to reset (default = `true`, unlike `flash()` and `fade()`!). * @param Axes On what axes to shake. Default value is `FlxAxes.XY` / both. - + * Just turns off all the camera effects instantly. - + * Sets the filter array to be applied to the camera. - + @@ -21881,7 +21889,7 @@ * @param Camera The camera you want to copy from. * @return A reference to this `FlxCamera` object. - + @@ -21895,17 +21903,17 @@ * @param Color The color to fill with in `0xAARRGGBB` hex format. * @param BlendAlpha Whether to blend the alpha value or just wipe the previous contents. Default is `true`. - + flixel.system.frontEnds.CameraFrontEnd * Internal helper function, handles the actual drawing of all the special effects. - + flixel.system.frontEnds.CameraFrontEnd - - + + @@ -21916,7 +21924,7 @@ * @param Width The new camera width. * @param Height The new camera height. - + @@ -21929,7 +21937,7 @@ * @param X The new x position. * @param Y The new y position. - + @@ -21947,7 +21955,7 @@ * @param Height The largest Y value of your level (usually the level height). * @param UpdateWorld Whether the global quad-tree's dimensions should be updated to match (default: `false`). - + @@ -21963,7 +21971,7 @@ * @param MinY The minimum Y value the camera can scroll to * @param MaxY The maximum Y value the camera can scroll to - + @@ -21975,12 +21983,12 @@ * @param X The new scale on x axis * @param Y The new scale of y axis - + * Called by camera front end every time you resize the game. * It triggers reposition of camera's internal display objects. - + @@ -21988,7 +21996,7 @@ * The size and position of this camera's screen * @since 4.11.0 - + @@ -22000,7 +22008,7 @@ * screen coordinates. * @since 4.3.0 - + @@ -22008,53 +22016,53 @@ * Checks whether this camera contains a given rectangle, in screen coordinates. * @since 4.11.0 - + - + - + - + - + - + - + - + - + - + - + - - - + + + @@ -25383,14 +25391,22 @@ - + <_flipX expr="false"> + + false + + <_flipY expr="false"> + + false + + - + @@ -25405,7 +25421,7 @@ * @param X The X coordinate of the brush's top left corner on this sprite. * @param Y They Y coordinate of the brush's top left corner on this sprite. - + @@ -25416,7 +25432,7 @@ * * @param Force Force the frame to redraw, even if its not flagged as necessary. - + @@ -25426,12 +25442,12 @@ * * @param AdjustPosition Adjusts the actual X and Y position just once to match the offset change. - + * Sets the sprite's origin to its center - useful after adjusting * `scale` to make sure rotations work as expected. - + @@ -25447,7 +25463,7 @@ * @param FetchPositions Whether we need to store positions of pixels which colors were replaced. * @return `Array` with replaced pixels positions - + @@ -25472,8 +25488,8 @@ * @param blueOffset The offset for the blue color channel value, in the range from `-255` to `255`. * @param alphaOffset The offset for alpha transparency channel value, in the range from `-255` to `255`. - - + + @@ -25489,7 +25505,7 @@ * @param Camera Specify which game camera you want. If `null`, it will just grab the first global camera. * @return Whether or not the point overlaps this object. - + @@ -25502,11 +25518,11 @@ * * @param RunOnCpp Whether the frame should also be recalculated if we're on a non-flash target - + * Retrieves the `BitmapData` of the current `FlxFrame`. Updates `framePixels`. - + @@ -25517,7 +25533,7 @@ * Otherwise a new one is created. * @return A `FlxPoint` containing the midpoint of this sprite's graphic in world coordinates. - + @@ -25528,7 +25544,7 @@ * @param Camera Specify which game camera you want. If `null`, it will just grab the first global camera. * @return Whether the object is on screen or not. - + @@ -25536,7 +25552,7 @@ * Returns the result of `isSimpleRenderBlit()` if `FlxG.renderBlit` is * `true`, or `false` if `FlxG.renderTile` is `true`. - + @@ -25548,7 +25564,7 @@ * * @param camera If a camera is passed its `pixelPerfectRender` flag is taken into account - + @@ -25561,7 +25577,7 @@ * @return A globally aligned `FlxRect` that fully contains the input object's width and height. * @since 4.11.0 - + @@ -25574,7 +25590,7 @@ * @return A globally aligned `FlxRect` that fully contains the input sprite. * @since 4.11.0 - + @@ -25590,7 +25606,7 @@ * @param FlipX Whether to flip the sprite on the X axis. * @param FlipY Whether to flip the sprite on the Y axis. - + @@ -25606,64 +25622,64 @@ * @param saveAnimations Whether to save animations in animation controller or not. * @return This sprite with loaded frames - + - + - + - + - + - + - + - + - + - + @@ -25672,14 +25688,14 @@ * Internal function for setting graphic property for this object. * It changes graphics' `useCount` also for better memory tracking. - + - + @@ -25691,39 +25707,39 @@ * @param Frames frames to load into this sprite. * @return loaded frames. - + - + - + - + - + - + @@ -77334,13 +77350,17 @@ - - - + + + + + + + - + @@ -77365,25 +77385,25 @@ false - - + + - + - + - + @@ -77465,7 +77485,12 @@ - + + + + + + @@ -77492,9 +77517,30 @@ + + + + + + + FlxPoint.get(FlxG.width, FlxG.height) + + + + + + + + + + + + + + - + + + + + + + + + + + + null + + <__buttons expr="null"> + + + + + null + + + + + + + + + + + + + + + + + + + + + + + + + + cast 0 + + + + + + + + cast 1 + + + + + + + + cast 2 + + + + + + + + cast 3 + + + + + + + + + + + + cast 0 + + + + + + + + cast 1 + + + + + + + + cast 2 + + + + + + + + cast 3 + + + + + + + + + + + + + @@ -77525,19 +77688,21 @@ - - + + + + - - + + - - + + @@ -77621,6 +77786,21 @@ + + + + + + + + + + + + + + + @@ -77634,10 +77814,14 @@ + + + new ThemeData() + + new ThemeData() - * CAPTION @@ -77664,7 +77848,7 @@ new ThemeData() - + @@ -77676,10 +77860,22 @@ "" - + + + "" + + + + 12 + + + + FlxColor.BLACK + + FlxColor.WHITE - + 4 @@ -77708,8 +77904,8 @@ FlxPoint.get(5, 5) - - + + @@ -77756,21 +77952,43 @@ true + + + true + + + + true + + + + false + + + + false + null - + - - + + + + + + + + - + @@ -77778,11 +77996,19 @@ { useResizeTechnique : true } - + + + + + + + + + - + @@ -77794,24 +78020,24 @@ { popout : false } - - + + - + - + - - - + + + @@ -77819,14 +78045,14 @@ - + - ["minimize", "maximize", "close", "restore", "help"] + ["close", "maximize", "minimize", "help", "restore"] - - + + @@ -78150,11 +78376,16 @@ * FOR GF DANCING SHIT - + + + true + * Whenever the character should dance on beat or not. Set to false for `gf`, since the dance animation is automatically handled by PlayState. + + - + @@ -78162,13 +78393,13 @@ false - + - - + + @@ -78179,9 +78410,9 @@ { Context : NONE, Frame : 0, Reversed : false, Force : false } - - - + + + @@ -78390,9 +78621,42 @@ + + + + + false + + + + + + + + + + + + + + + + + { smoothing : false } + + + + + + + + + + + - + 160 * 0.7 @@ -78435,13 +78699,21 @@ 0 + + + null + + + + null + - + true - + 0.5 @@ -78450,19 +78722,19 @@ 1 - + - + - + - + @@ -78552,11 +78824,11 @@ false - + 0 - + 6 @@ -78570,6 +78842,18 @@ 0 + + + + + + + hide + + + + hide + @@ -78632,16 +78916,12 @@ - + 0 - - - Options.downscroll - 0 @@ -78677,8 +78957,8 @@ "" - - + + @@ -78688,7 +78968,7 @@ 5 - + 0 @@ -78701,39 +78981,39 @@ 0 - - + + 0 - + - + - + - + - - + + - - - - + + + + false @@ -78746,18 +79026,18 @@ true - - - + + + - + false - + @@ -78765,8 +79045,8 @@ { score : 350 } - - + + @@ -78774,20 +79054,20 @@ [null] - + - + - + - - + + 0 @@ -78884,32 +79164,38 @@ false - - - - + + + + + + + + + + - + - + - - + + - + - + @@ -78917,7 +79203,7 @@ { force : true } - + @@ -80839,6 +81125,73 @@ + + + <__updateHitWindow public="1" expr="true"> + + + true + hide + + + <__autoCPUHit public="1" expr="true"> + + + true + hide + + + <__reposNote public="1" expr="true"> + + + true + hide + + + + + * Note that is being updated + + + + * Time elapsed since last frame + + + + * Note's strum (can be changed) + + + + * Cancels the hit window update. + + + + hide + + + + * Cancels the automatic CPU hit. + + + + hide + + + + * Cancels the note position update (note will freeze). + + + + hide + + + + + + + + + @@ -80962,6 +81315,55 @@ + + + + + + <__doAnimation public="1" expr="!PlayState.isStoryMode"> + + + !PlayState.isStoryMode + hide + + + + + * The strum that is being created + + + + * Player ID + + + + * Strum ID, for the sprite. + + + + * Cancels the animation that makes the strum "land" in the strumline. + + + + hide + + + + + + + + + + + + + + * Substate that is about to be opened/closed + + + + @@ -81128,7 +81530,8 @@ [] * Array of all BPM changes that have been mapped. - + + @@ -81136,7 +81539,7 @@ * Maps BPM changes from a song. * @param song Song to map BPM changes from. - + @@ -216102,6 +216505,30 @@ * Triggered on each note creation * @param event Event object containing information about the note. + + + + + + * Triggered on each strum creation + * @param event Event object containing information about the strum. + + + + + + + * Triggered on substate open. + * @param event Event object containing the substate, which is cancellable. + + + + + + + * Triggered on substate close. + * @param event Event object containing the substate, which is cancellable. + * Contains all callbacks you can add in modcharts and stage scripts. * * diff --git a/pages/funkin/desktop/DesktopMain.html b/pages/funkin/desktop/DesktopMain.html index 6396e938..4573f297 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

Static variables

staticinstance:DesktopMain

@:value(null)statictheme:Theme = null

Constructor

new(?TransIn:TransitionData, ?TransOut:TransitionData)

Variables

@:value(new MouseInput())mouseInput:MouseInput = new MouseInput()

oldScaleMode:BaseScaleMode

screenSize:FlxPoint

wallpaper:FlxSprite

windows:WindowGroup<Window>

Methods

focusWindow(window:Window):Void

layerCameras():Void

updateScreenRes():Void

Inherited Variables

Defined by MusicBeatState

read onlycontrols:Controls

Game Controls.

@:value(0)curBeat:Int = 0

Current beat

@:value(0)curBeatFloat:Float = 0

Current beat, as a Float (ex: 1.24, instead of 1)

@:value(0)curStep:Int = 0

Current step

@:value(0)curStepFloat:Float = 0

Current step, as a Float (ex: 4.94, instead of 4)

Inherited Methods

Defined by MusicBeatState

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

© 2022  

\ No newline at end of file +

class DesktopMain

package funkin.desktop

extends MusicBeatState

@:directlyUsed

Static variables

staticinstance:DesktopMain

@:value(null)statictheme:Theme = null

Constructor

new(?TransIn:TransitionData, ?TransOut:TransitionData)

Variables

@:value(new MouseInput())mouseInput:MouseInput = new MouseInput()

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

read onlycontrols:Controls

Game Controls.

@:value(0)curBeat:Int = 0

Current beat

@:value(0)curBeatFloat:Float = 0

Current beat, as a Float (ex: 1.24, instead of 1)

@:value(0)curStep:Int = 0

Current step

@:value(0)curStepFloat:Float = 0

Current step, as a Float (ex: 4.94, instead of 4)

Inherited Methods

Defined by MusicBeatState

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/Butt.html b/pages/funkin/desktop/editors/Butt.html new file mode 100644 index 00000000..12644c00 --- /dev/null +++ b/pages/funkin/desktop/editors/Butt.html @@ -0,0 +1,10 @@ + + + +funkin.desktop.editors.Butt

typedef Butt

package funkin.desktop.editors

import funkin.desktop.editors.MessageBox

Fields

label:String

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/CharacterEditor.html b/pages/funkin/desktop/editors/CharacterEditor.html index c68368d5..53d42288 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

Constructor

new(curCharacter:String)

Variables

camFollow:FlxObject

camHUD:FlxCamera

char:Character

curCharacter:String

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

Inherited Methods

Defined by WindowContent

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

© 2022  

\ No newline at end of file +

class CharacterEditor

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed

Constructor

new(curCharacter:String)

Variables

camFollow:FlxObject

camHUD:FlxCamera

char:Character

curCharacter:String

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

Inherited Methods

Defined by WindowContent

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

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/EditorPlayState.html b/pages/funkin/desktop/editors/EditorPlayState.html new file mode 100644 index 00000000..d86fa3f5 --- /dev/null +++ b/pages/funkin/desktop/editors/EditorPlayState.html @@ -0,0 +1,10 @@ + + + +funkin.desktop.editors.EditorPlayState

class EditorPlayState

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed

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

Inherited Methods

Defined by WindowContent

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

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/HelloWorld.html b/pages/funkin/desktop/editors/HelloWorld.html index 2f73f1a4..4c533c08 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

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

Inherited Methods

Defined by WindowContent

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

© 2022  

\ No newline at end of file +

class HelloWorld

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed

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

Inherited Methods

Defined by WindowContent

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

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/MessageBox.html b/pages/funkin/desktop/editors/MessageBox.html new file mode 100644 index 00000000..b9c3cfaf --- /dev/null +++ b/pages/funkin/desktop/editors/MessageBox.html @@ -0,0 +1,10 @@ + + + +funkin.desktop.editors.MessageBox

class MessageBox

package funkin.desktop.editors

extends WindowContent › WindowGroup

@:directlyUsed

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

Inherited Methods

Defined by WindowContent

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

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

Defined by WindowGroup

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/MessageBoxIcon.html b/pages/funkin/desktop/editors/MessageBoxIcon.html new file mode 100644 index 00000000..6a0b93c8 --- /dev/null +++ b/pages/funkin/desktop/editors/MessageBoxIcon.html @@ -0,0 +1,10 @@ + + + +funkin.desktop.editors.MessageBoxIcon

enum abstract MessageBoxIcon(Int)

package funkin.desktop.editors

import funkin.desktop.editors.MessageBox

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/editors/index.html b/pages/funkin/desktop/editors/index.html index ebe5dac7..4ea655d6 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

..
CharacterEditor

HelloWorld

© 2022  

\ No newline at end of file +

funkin.desktop.editors

..
Butt

CharacterEditor

EditorPlayState

HelloWorld

MessageBox

MessageBoxIcon

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/Button.html b/pages/funkin/desktop/sprites/Button.html index d21ac036..92b7842b 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

Constructor

@:value({ text : "" })new(x:Float, y:Float, text:String = "", callback:() ‑> Void)

Variables

@:value(false)disabled:Bool = false

disabledSprite:SpliceSprite

@:value(0)frame:Int = 0

hoverSprite:SpliceSprite

label:FlxUIText

normalSprite:SpliceSprite

pressedSprite:SpliceSprite

callback:() ‑> Void

Methods

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

© 2022  

\ No newline at end of file +

class Button

package funkin.desktop.sprites

extends FlxObject

@:directlyUsed

Constructor

@:value({ text : "" })new(x:Float, y:Float, text:String = "", callback:() ‑> Void)

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/WindowText.html b/pages/funkin/desktop/sprites/WindowText.html new file mode 100644 index 00000000..7e6bf703 --- /dev/null +++ b/pages/funkin/desktop/sprites/WindowText.html @@ -0,0 +1,10 @@ + + + +funkin.desktop.sprites.WindowText

class WindowText

package funkin.desktop.sprites

extends FlxText

@:directlyUsed

Constructor

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

Methods

applyFontSettings(data:ThemeData):Void

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/sprites/index.html b/pages/funkin/desktop/sprites/index.html index a5885047..f5bfc42f 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

SpliceSprite

© 2022  

\ No newline at end of file +

funkin.desktop.sprites

..
Button

SpliceSprite

WindowText

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/theme/Theme.html b/pages/funkin/desktop/theme/Theme.html index 916a541c..04215f5a 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

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

CAPTION

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

@:value(new ThemeData())captionInactive: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()

© 2022  

\ No newline at end of file +

class Theme

package funkin.desktop.theme

@:directlyUsed

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())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())window:ThemeData = new ThemeData()

CAPTION & WINDOW

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/theme/ThemeData.html b/pages/funkin/desktop/theme/ThemeData.html index 1018a51a..96a7cc99 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

Constructor

new()

Variables

@:value(4)bottom: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(FlxColor.WHITE)textColor:FlxColor = FlxColor.WHITE

@:value(4)top:Float = 4

Methods

destroy():Void

© 2022  

\ No newline at end of file +

class ThemeData

package funkin.desktop.theme

implements IFlxDestroyable

import funkin.desktop.theme.Theme

@:directlyUsed

Constructor

new()

Variables

@:value(4)bottom:Float = 4

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

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

@:value(12)fontSize:Float = 12

@: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(FlxColor.BLACK)textColor:FlxColor = FlxColor.BLACK

@:value(4)top:Float = 4

Methods

destroy():Void

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/Window.html b/pages/funkin/desktop/windows/Window.html index 700b71df..a09be5f8 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

Constructor

new(content:WindowContent)

Variables

caption:FlxUIText

captionButtons:FlxTypedSpriteGroup<WindowCaptionButton>

content:WindowContent

@:value(null)curDialog:Window = null

dragHitbox:WindowDragHitbox

read onlyfocused:Bool

icon:FlxSprite

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

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

openDialog(window:Window):Void

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

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

updateWindowFrame():Void

© 2022  

\ No newline at end of file +

class Window

package funkin.desktop.windows

extends FlxTypedGroup

@:directlyUsed

Constructor

new(content:WindowContent)

Variables

@:value(true)canClose:Bool = true

@:value(false)canHelp:Bool = false

@:value(true)canMinimize:Bool = true

caption:FlxUIText

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/WindowCaptionButton.html b/pages/funkin/desktop/windows/WindowCaptionButton.html index d3dfcfc6..73da383c 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

Static variables

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

Constructor

new(window:Window, i:Int)

Variables

icon:FlxSprite

window:Window

Methods

© 2022  

\ No newline at end of file +

class WindowCaptionButton

package funkin.desktop.windows

extends FlxSprite

@:directlyUsed

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/desktop/windows/WindowContent.html b/pages/funkin/desktop/windows/WindowContent.html index 3526a6ac..df446963 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, HelloWorld

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

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

Inherited Variables

Inherited Methods

Defined by WindowGroup

© 2022  

\ No newline at end of file +

class WindowContent

package funkin.desktop.windows

extends WindowGroup

extended by CharacterEditor, EditorPlayState, HelloWorld, MessageBox

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

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

Inherited Variables

Inherited Methods

Defined by WindowGroup

© 2022  

\ No newline at end of file diff --git a/pages/funkin/game/Character.html b/pages/funkin/game/Character.html index 63fb320b..505ca097 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

Constructor

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

Variables

animOffsets:Map<String, FlxPoint>

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

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

@:value(false)debugMode:Bool = false

@: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(-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({ Context : NONE, Frame : 0, Reversed : false, Force : false })playAnim(AnimName:String, Force:Bool = false, Reversed:Bool = false, Frame:Int = 0, Context:PlayAnimContext = NONE):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

© 2022  

\ No newline at end of file +

class Character

package funkin.game

extends FlxSprite

implements IOffsetCompatible, IBeatReceiver

@:directlyUsed

Constructor

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

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(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(-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({ Context : NONE, Frame : 0, Reversed : false, Force : false })playAnim(AnimName:String, Force:Bool = false, Reversed:Bool = false, Frame:Int = 0, Context:PlayAnimContext = NONE):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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/game/HudCamera.html b/pages/funkin/game/HudCamera.html new file mode 100644 index 00000000..e4a9d21a --- /dev/null +++ b/pages/funkin/game/HudCamera.html @@ -0,0 +1,10 @@ + + + +funkin.game.HudCamera

class HudCamera

package funkin.game

extends FlxCamera

@:directlyUsed

Constructor

new(?X:Int, ?Y:Int, ?Width:Int, ?Height:Int, ?Zoom:Float)

Variables

@:value(false)downscroll:Bool = false

Methods

© 2022  

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

class Note

package funkin.game

extends FlxSprite

@:directlyUsed

Static variables

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

Constructor

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

Variables

@:value(true)angleOffsets:Bool = true

@:value(false)canBeHit:Bool = false

@:value(0.5)earlyPressWindow:Float = 0.5

@:value(false)isSustainNote:Bool = false

@:value(1)latePressWindow:Float = 1

@:value(false)mustPress:Bool = false

@:value(0)noteData:Int = 0

read onlynoteType:String

@:value(0)noteTypeID:Int = 0

prevNote:Note

read onlystrumID:Int

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

updateClipRect(strum:Strum):Void

© 2022  

\ No newline at end of file +

class Note

package funkin.game

extends FlxSprite

@:directlyUsed

Static variables

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

Constructor

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

Variables

@:value(true)angleOffsets:Bool = true

@:value(false)canBeHit:Bool = false

@:value(0.5)earlyPressWindow:Float = 0.5

@:value(false)isSustainNote:Bool = false

@:value(1)latePressWindow:Float = 1

@:value(false)mustPress:Bool = false

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

@:value(0)noteData:Int = 0

read onlynoteType:String

@:value(0)noteTypeID:Int = 0

prevNote:Note

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

read onlystrumID:Int

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

updateClipRect(strum:Strum):Void

© 2022  

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

class PlayState

package funkin.game

extends MusicBeatState

@:directlyUsed

Static variables

staticSONG:SwagSong

SONG METADATA

@:value(0)staticcampaignScore:Int = 0

@:value(6)staticdaPixelZoom:Float = 6

@:value(false)staticfromMods:Bool = false

@:value(null)staticinstance:PlayState = null

@:value(false)staticisStoryMode:Bool = false

@:value(1)staticstoryDifficulty:Int = 1

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

@:value(0)staticstoryWeek:Int = 0

Constructor

new(?TransIn:TransitionData, ?TransOut:TransitionData)

Variables

accuracyTxt:FlxText

boyfriend:Character

camFollow:FlxObject

camGame:FlxCamera

camHUD:FlxCamera

@:value(false)camZooming:Bool = false

@:value(4)camZoomingInterval:Int = 4

@:value(true)canPause:Bool = true

@:value(0)combo:Int = 0

@:value(false)comboBreaks:Bool = false

cpuStrums:FlxTypedGroup<Strum>

@:value(0)curLight:Int = 0

@:value(0)curSection:Int = 0

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

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

dad:Character

@:value(0)debugNum:Int = 0

@:value(1.05)defaultCamZoom:Float = 1.05

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

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

@:value(Options.downscroll)downscroll:Bool = Options.downscroll

@:value(false)endingSong:Bool = false

@:value(false)generatedMusic:Bool = false

gf:Character

@:value(1)gfSpeed:Int = 1

@:value(false)halloweenLevel:Bool = false

@:value(1)health:Float = 1

healthBar:FlxBar

healthBarBG:FlxSprite

iconP1:HealthIcon

iconP2:HealthIcon

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

@:value(false)inCutscene:Bool = false

@:value(5)introLength:Int = 5

@:value(0)lastReportedPlayheadPosition:Int = 0

@:value(0)misses:Int = 0

missesTxt:FlxText

@:value(true)muteVocalsOnMiss:Bool = true

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

notes:NoteGroup

@:value(false)paused:Bool = false

@:value(false)perfectMode:Bool = false

playerStrums:FlxTypedGroup<Strum>

@:value(0)previousFrameTime:Int = 0

scoreTxt:FlxText

scripts:ScriptPack

@:value(0)scrollSpeed:Float = 0

@:value(0)songLength:Float = 0

@:value(0)songScore:Int = 0

@:value(0)songTime:Float = 0

stage:Stage

startTimer:FlxTimer

@:value(false)startedCountdown:Bool = false

@:value(false)startingSong:Bool = false

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

strumLine:FlxSprite

strumLineNotes:FlxTypedGroup<Strum>

vocals:FlxSound

Methods

addNoteType(name:String):Int

deleteNote(note:Note):Void

getNoteType(id:Int):String

pauseGame():Void

updateDiscordStatus():Void

Inherited Variables

Defined by MusicBeatState

read onlycontrols:Controls

Game Controls.

@:value(0)curBeat:Int = 0

Current beat

@:value(0)curBeatFloat:Float = 0

Current beat, as a Float (ex: 1.24, instead of 1)

@:value(0)curStep:Int = 0

Current step

@:value(0)curStepFloat:Float = 0

Current step, as a Float (ex: 4.94, instead of 4)

Inherited Methods

Defined by MusicBeatState

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

© 2022  

\ No newline at end of file +

class PlayState

package funkin.game

extends MusicBeatState

@:directlyUsed

Static variables

staticSONG:SwagSong

SONG METADATA

@:value(0)staticcampaignScore:Int = 0

@:value(6)staticdaPixelZoom:Float = 6

@:value(false)staticfromMods:Bool = false

@:value(null)staticinstance:PlayState = null

@:value(false)staticisStoryMode:Bool = false

@:value(1)staticstoryDifficulty:Int = 1

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

@:value(0)staticstoryWeek:Int = 0

Constructor

new(?TransIn:TransitionData, ?TransOut:TransitionData)

Variables

accuracyTxt:FlxText

boyfriend:Character

camFollow:FlxObject

camGame:FlxCamera

camHUD:HudCamera

@:value(false)camZooming:Bool = false

@:value(4)camZoomingInterval:Int = 4

@:value(true)canPause:Bool = true

@:value(0)combo:Int = 0

@:value(false)comboBreaks:Bool = false

cpuStrums:FlxTypedGroup<Strum>

@:value(0)curLight:Int = 0

@:value(0)curSection:Int = 0

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

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

dad:Character

@:value(0)debugNum:Int = 0

@:value(1.05)defaultCamZoom:Float = 1.05

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

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

downscroll:Bool

@:value(false)endingSong:Bool = false

@:value(false)generatedMusic:Bool = false

gf:Character

@:value(1)gfSpeed:Int = 1

@:value(false)halloweenLevel:Bool = false

@:value(1)health:Float = 1

healthBar:FlxBar

healthBarBG:FlxSprite

iconP1:HealthIcon

iconP2:HealthIcon

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

@:value(false)inCutscene:Bool = false

@:value(5)introLength:Int = 5

@:value(0)lastReportedPlayheadPosition:Int = 0

@:value(0)misses:Int = 0

missesTxt:FlxText

@:value(true)muteVocalsOnMiss:Bool = true

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

notes:NoteGroup

@:value(false)paused:Bool = false

@:value(false)perfectMode:Bool = false

playerStrums:FlxTypedGroup<Strum>

@:value(0)previousFrameTime:Int = 0

scoreTxt:FlxText

scripts:ScriptPack

@:value(0)scrollSpeed:Float = 0

@:value(0)songLength:Float = 0

@:value(0)songScore:Int = 0

@:value(0)songTime:Float = 0

stage:Stage

startTimer:FlxTimer

@:value(false)startedCountdown:Bool = false

@:value(false)startingSong:Bool = false

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

strumLine:FlxSprite

strumLineNotes:FlxTypedGroup<Strum>

vocals:FlxSound

Methods

addNoteType(name:String):Int

deleteNote(note:Note):Void

getNoteType(id:Int):String

pauseGame():Void

updateDiscordStatus():Void

Inherited Variables

Defined by MusicBeatState

read onlycontrols:Controls

Game Controls.

@:value(0)curBeat:Int = 0

Current beat

@:value(0)curBeatFloat:Float = 0

Current beat, as a Float (ex: 1.24, instead of 1)

@:value(0)curStep:Int = 0

Current step

@:value(0)curStepFloat:Float = 0

Current step, as a Float (ex: 4.94, instead of 4)

Inherited Methods

Defined by MusicBeatState

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/game/Strum.html b/pages/funkin/game/Strum.html index a9e7a6c0..a8eecb97 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

Constructor

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

Variables

@:value(false)cpu:Bool = false

@:value(false)downscroll:Null<Bool> = false

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

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

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

Methods

getAnim():Null<String>

getDownscroll():Null<Bool>

getNotesAngle():Null<Float>

getScrollSpeed():Null<Float>

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

press(time:Float):Void

updateClipRect(daNote:Note):Void

updateNotePosition(daNote:Note):Void

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

© 2022  

\ No newline at end of file +

class Strum

package funkin.game

extends FlxSprite

@:directlyUsed

Constructor

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

Variables

@:value(false)cpu:Bool = false

@:value(false)downscroll:Null<Bool> = false

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

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

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

Methods

getAnim():Null<String>

getDownscroll():Null<Bool>

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/game/index.html b/pages/funkin/game/index.html index f7a1e612..ffde18c2 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

GameOverSubstate

HealthIcon

Highscore

Note

NoteGroup

PlayState

Stage

StageSprite

Strum

© 2022  

\ No newline at end of file +

funkin.game

..
Character

GameOverSubstate

HealthIcon

Highscore

HudCamera

Note

NoteGroup

PlayState

Stage

StageSprite

Strum

© 2022  

\ No newline at end of file diff --git a/pages/funkin/scripting/events/CancellableEvent.html b/pages/funkin/scripting/events/CancellableEvent.html index 66d0ac70..489aca05 100644 --- a/pages/funkin/scripting/events/CancellableEvent.html +++ b/pages/funkin/scripting/events/CancellableEvent.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

class CancellableEvent

package funkin.scripting.events

extended by CountdownEvent, DanceEvent, DirectionAnimEvent, InputSystemEvent, NoteCreationEvent, NoteHitEvent, PlayAnimEvent, PointEvent, SimpleNoteEvent

@:allow(ScriptPack)

Constructor

new()

Creates a new cancellable event. +

class CancellableEvent

package funkin.scripting.events

extended by CountdownEvent, DanceEvent, DirectionAnimEvent, InputSystemEvent, NoteCreationEvent, NoteHitEvent, NoteUpdateEvent, PlayAnimEvent, PointEvent, SimpleNoteEvent, StrumCreationEvent, SubstateEvent

@: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 : true })preventDefault(c:Bool = true):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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/scripting/events/NoteUpdateEvent.html b/pages/funkin/scripting/events/NoteUpdateEvent.html new file mode 100644 index 00000000..75409e66 --- /dev/null +++ b/pages/funkin/scripting/events/NoteUpdateEvent.html @@ -0,0 +1,12 @@ + + + +funkin.scripting.events.NoteUpdateEvent

class NoteUpdateEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed

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 : true })preventDefault(c:Bool = true):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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/scripting/events/StrumCreationEvent.html b/pages/funkin/scripting/events/StrumCreationEvent.html new file mode 100644 index 00000000..a3eb91b9 --- /dev/null +++ b/pages/funkin/scripting/events/StrumCreationEvent.html @@ -0,0 +1,12 @@ + + + +funkin.scripting.events.StrumCreationEvent

class StrumCreationEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed

Constructor

new(strum:Strum, player:Int, strumID:Int)

Variables

player:Int

Player ID

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 : true })preventDefault(c:Bool = true):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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/scripting/events/SubstateEvent.html b/pages/funkin/scripting/events/SubstateEvent.html new file mode 100644 index 00000000..9e88c22d --- /dev/null +++ b/pages/funkin/scripting/events/SubstateEvent.html @@ -0,0 +1,12 @@ + + + +funkin.scripting.events.SubstateEvent

class SubstateEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed

Constructor

new(substate:FlxSubState)

Variables

substate:FlxSubState

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 : true })preventDefault(c:Bool = true):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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/scripting/events/index.html b/pages/funkin/scripting/events/index.html index 467506da..34a37b9e 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

..
CancellableEvent

CountdownEvent

DanceEvent

DirectionAnimEvent

InputSystemEvent

NoteCreationEvent

NoteHitEvent

PlayAnimContext

Contains all contexts possible for PlayAnimEvent.

PlayAnimEvent

PointEvent

SimpleNoteEvent

© 2022  

\ No newline at end of file +

funkin.scripting.events

..
CancellableEvent

CountdownEvent

DanceEvent

DirectionAnimEvent

InputSystemEvent

NoteCreationEvent

NoteHitEvent

NoteUpdateEvent

PlayAnimContext

Contains all contexts possible for PlayAnimEvent.

PlayAnimEvent

PointEvent

SimpleNoteEvent

StrumCreationEvent

SubstateEvent

© 2022  

\ No newline at end of file diff --git a/pages/funkin/system/Conductor.html b/pages/funkin/system/Conductor.html index b1f080b0..92229b2a 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

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.

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

staticmapBPMChanges(song:SwagSong):Void

Maps BPM changes from a song.

Parameters:

song

Song to map BPM changes from.

© 2022  

\ No newline at end of file +

class Conductor

package funkin.system

@:directlyUsed

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.

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

staticmapBPMChanges(song:SwagSong):Void

Maps BPM changes from a song.

Parameters:

song

Song to map BPM changes from.

staticreset():Void

© 2022  

\ No newline at end of file diff --git a/pages/nav.js b/pages/nav.js index 8fee91dd..377ecbeb 100644 --- a/pages/nav.js +++ b/pages/nav.js @@ -1 +1 @@ -var navContent=''; \ No newline at end of file +var navContent=''; \ No newline at end of file diff --git a/pages/scripting/PlayStateScript.html b/pages/scripting/PlayStateScript.html index cf764292..af9b9f47 100644 --- a/pages/scripting/PlayStateScript.html +++ b/pages/scripting/PlayStateScript.html @@ -9,4 +9,4 @@ }

interface PlayStateScript

package scripting

@:hxGen

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.

createPost():Void

Triggered at the very end of PlayState's creation

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.

inputUpdatePost(event:InputSystemEvent):Void

Triggered after the input system updates.

Parameters:

note

Event object with the pressed, justPressed and justReleased notes.

onCountdown(event:CountdownEvent):Void

Triggered every countdown.

Parameters:

event

Countdown event.

onCountdownPost(event:CountdownEvent):Void

Triggered after 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.

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.

updatePost(elapsed:Float):Void

Triggered at the end of every frame.

Parameters:

elapsed

Time elapsed since last frame.

© 2022  

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

createPost():Void

Triggered at the very end of PlayState's creation

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.

inputUpdatePost(event:InputSystemEvent):Void

Triggered after the input system updates.

Parameters:

note

Event object with the pressed, justPressed and justReleased notes.

onCountdown(event:CountdownEvent):Void

Triggered every countdown.

Parameters:

event

Countdown event.

onCountdownPost(event:CountdownEvent):Void

Triggered after 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.

onStrumCreation(event:StrumCreationEvent):Void

Triggered on each strum creation

Parameters:

event

Event object containing information about the strum.

onSubstateClose(event:SubstateEvent):Void

Triggered on substate close.

Parameters:

event

Event object containing the substate, which is cancellable.

onSubstateOpen(event:SubstateEvent):Void

Triggered on substate open.

Parameters:

event

Event object containing the substate, which is cancellable.

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.

updatePost(elapsed:Float):Void

Triggered at the end of every frame.

Parameters:

elapsed

Time elapsed since last frame.

© 2022  

\ No newline at end of file diff --git a/source/funkin/scripting/events/StrumCreationEvent.hx b/source/funkin/scripting/events/StrumCreationEvent.hx index a8cce6c8..290f3d47 100644 --- a/source/funkin/scripting/events/StrumCreationEvent.hx +++ b/source/funkin/scripting/events/StrumCreationEvent.hx @@ -1,5 +1,7 @@ package funkin.scripting.events; +import funkin.game.Strum; + class StrumCreationEvent extends CancellableEvent { @:dox(hide) public var __doAnimation = !PlayState.isStoryMode; @@ -20,6 +22,7 @@ class StrumCreationEvent extends CancellableEvent { public var strumID:Int; public function new(strum:Strum, player:Int, strumID:Int) { + super(); this.strum = strum; this.player = player; this.strumID = strumID; diff --git a/source/funkin/scripting/events/SubstateEvent.hx b/source/funkin/scripting/events/SubstateEvent.hx index 3aac0499..541db4fe 100644 --- a/source/funkin/scripting/events/SubstateEvent.hx +++ b/source/funkin/scripting/events/SubstateEvent.hx @@ -1,12 +1,15 @@ package funkin.scripting.events; -class SubstateEvent { +import flixel.FlxSubState; + +class SubstateEvent extends CancellableEvent { /** * Substate that is about to be opened/closed */ public var substate:FlxSubState; public function new(substate:FlxSubState) { + super(); this.substate = substate; } } \ No newline at end of file