From 413cf6e2c04e1dd5b5c0ac1b4d81ea89e290161c Mon Sep 17 00:00:00 2001 From: Yoshman29 Date: Tue, 11 Oct 2022 13:47:52 +0200 Subject: [PATCH] doc --- assets/data/characters/bf.hx | 4 +- buildnumber.txt | 2 +- docs/doc.xml | 1578 +++++++++-------- pages/funkin/debug/AnimationDebug.html | 10 + pages/funkin/debug/index.html | 10 + pages/funkin/editors/ChartingState.html | 10 + pages/funkin/editors/index.html | 10 + pages/funkin/game/Character.html | 2 +- pages/funkin/game/GameOverSubstate.html | 2 +- pages/funkin/game/HealthIcon.html | 11 + pages/funkin/game/Highscore.html | 10 + pages/funkin/game/PlayState.html | 2 +- pages/funkin/game/index.html | 2 +- pages/funkin/index.html | 2 +- pages/funkin/menus/FreeplayState.html | 2 +- pages/funkin/menus/GitarooPause.html | 2 +- pages/funkin/menus/MainMenuState.html | 2 +- pages/funkin/menus/PauseSubState.html | 2 +- pages/funkin/menus/StoryMenuState.html | 2 +- pages/funkin/menus/TitleState.html | 2 +- .../scripting/events/CancellableEvent.html | 2 +- pages/funkin/scripting/events/DanceEvent.html | 12 + .../scripting/events/DirectionAnimEvent.html | 12 + pages/funkin/scripting/events/PointEvent.html | 12 + pages/funkin/scripting/events/index.html | 2 +- pages/funkin/system/Action.html | 10 + pages/funkin/system/Control.html | 14 + pages/funkin/system/Controls.html | 16 + pages/funkin/system/Device.html | 10 + pages/funkin/system/DiscordClient.html | 10 + pages/funkin/system/KeyboardScheme.html | 10 + pages/funkin/system/MusicBeatState.html | 2 +- pages/funkin/system/MusicBeatSubstate.html | 2 +- pages/funkin/system/Paths.html | 2 +- pages/funkin/system/index.html | 7 +- pages/funkin/ui/AlphaCharacter.html | 10 + pages/funkin/ui/Alphabet.html | 10 + pages/funkin/ui/index.html | 10 + pages/nav.js | 2 +- pages/scripting/CharacterScript.html | 12 + pages/scripting/PlayStateScript.html | 4 +- pages/scripting/index.html | 2 +- 42 files changed, 1048 insertions(+), 792 deletions(-) create mode 100644 pages/funkin/debug/AnimationDebug.html create mode 100644 pages/funkin/debug/index.html create mode 100644 pages/funkin/editors/ChartingState.html create mode 100644 pages/funkin/editors/index.html create mode 100644 pages/funkin/game/HealthIcon.html create mode 100644 pages/funkin/game/Highscore.html create mode 100644 pages/funkin/scripting/events/DanceEvent.html create mode 100644 pages/funkin/scripting/events/DirectionAnimEvent.html create mode 100644 pages/funkin/scripting/events/PointEvent.html create mode 100644 pages/funkin/system/Action.html create mode 100644 pages/funkin/system/Control.html create mode 100644 pages/funkin/system/Controls.html create mode 100644 pages/funkin/system/Device.html create mode 100644 pages/funkin/system/DiscordClient.html create mode 100644 pages/funkin/system/KeyboardScheme.html create mode 100644 pages/funkin/ui/AlphaCharacter.html create mode 100644 pages/funkin/ui/Alphabet.html create mode 100644 pages/funkin/ui/index.html create mode 100644 pages/scripting/CharacterScript.html diff --git a/assets/data/characters/bf.hx b/assets/data/characters/bf.hx index 61a5dd74..2ef5ef2e 100644 --- a/assets/data/characters/bf.hx +++ b/assets/data/characters/bf.hx @@ -1,11 +1,11 @@ trace("Hello, World!"); function createPost() { - // globalOffset.y -= 150; + globalOffset.y -= 150; } function update(elapsed:Float) { - // y = y + Math.sin(Conductor.songPosition / 1000 * Math.PI) * 125 * elapsed; + y = y + Math.sin(Conductor.songPosition / 1000 * Math.PI) * 125 * elapsed; } function onGetCamPos(deezNuts:Dynamic) { diff --git a/buildnumber.txt b/buildnumber.txt index 059361f2..1a7d3a1c 100644 --- a/buildnumber.txt +++ b/buildnumber.txt @@ -1 +1 @@ -317 \ No newline at end of file +318 \ No newline at end of file diff --git a/docs/doc.xml b/docs/doc.xml index 32c6c3ff..67648c62 100644 --- a/docs/doc.xml +++ b/docs/doc.xml @@ -13547,7 +13547,7 @@ lime._internal.macros.AssetsMacro.embedBytes() lime._internal.macros.AssetsMacro.embedBytes() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets/sounds/beep.ogg" + "E:/Dev/HaxeFlixel/flixel/assets/sounds/beep.ogg" @@ -13566,7 +13566,7 @@ lime._internal.macros.AssetsMacro.embedBytes() lime._internal.macros.AssetsMacro.embedBytes() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets/sounds/flixel.ogg" + "E:/Dev/HaxeFlixel/flixel/assets/sounds/flixel.ogg" @@ -13585,7 +13585,7 @@ lime._internal.macros.AssetsMacro.embedBytes() lime._internal.macros.AssetsMacro.embedBytes() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets/sounds/type.ogg" + "E:/Dev/HaxeFlixel/flixel/assets/sounds/type.ogg" @@ -13601,7 +13601,7 @@ lime._internal.macros.AssetsMacro.embedFont() lime._internal.macros.AssetsMacro.embedFont() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets/fonts/nokiafc22.ttf" + "E:/Dev/HaxeFlixel/flixel/assets/fonts/nokiafc22.ttf" @@ -13617,7 +13617,7 @@ lime._internal.macros.AssetsMacro.embedFont() lime._internal.macros.AssetsMacro.embedFont() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets/fonts/monsterrat.ttf" + "E:/Dev/HaxeFlixel/flixel/assets/fonts/monsterrat.ttf" @@ -14294,7 +14294,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets/images/ui/button.png" + "E:/Dev/HaxeFlixel/flixel/assets/images/ui/button.png" @@ -14318,7 +14318,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets/images/logo/default.png" + "E:/Dev/HaxeFlixel/flixel/assets/images/logo/default.png" @@ -14342,7 +14342,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/box.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/box.png" @@ -14366,7 +14366,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/button.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/button.png" @@ -14390,7 +14390,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/button_arrow_down.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/button_arrow_down.png" @@ -14414,7 +14414,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/button_arrow_left.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/button_arrow_left.png" @@ -14438,7 +14438,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/button_arrow_right.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/button_arrow_right.png" @@ -14462,7 +14462,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/button_arrow_up.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/button_arrow_up.png" @@ -14486,7 +14486,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/button_thin.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/button_thin.png" @@ -14510,7 +14510,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/button_toggle.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/button_toggle.png" @@ -14534,7 +14534,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/check_box.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/check_box.png" @@ -14558,7 +14558,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/check_mark.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/check_mark.png" @@ -14582,7 +14582,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/chrome.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/chrome.png" @@ -14606,7 +14606,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/chrome_flat.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/chrome_flat.png" @@ -14630,7 +14630,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/chrome_inset.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/chrome_inset.png" @@ -14654,7 +14654,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/chrome_light.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/chrome_light.png" @@ -14678,7 +14678,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/dropdown_mark.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/dropdown_mark.png" @@ -14702,7 +14702,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/finger_big.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/finger_big.png" @@ -14726,7 +14726,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/finger_small.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/finger_small.png" @@ -14750,7 +14750,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/hilight.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/hilight.png" @@ -14774,7 +14774,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/invis.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/invis.png" @@ -14798,7 +14798,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/minus_mark.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/minus_mark.png" @@ -14822,7 +14822,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/plus_mark.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/plus_mark.png" @@ -14846,7 +14846,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/radio.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/radio.png" @@ -14870,7 +14870,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/radio_dot.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/radio_dot.png" @@ -14894,7 +14894,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/swatch.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/swatch.png" @@ -14918,7 +14918,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/tab.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/tab.png" @@ -14942,7 +14942,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/tab_back.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/tab_back.png" @@ -14966,7 +14966,7 @@ lime._internal.macros.AssetsMacro.embedImage() lime._internal.macros.AssetsMacro.embedImage() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/images/tooltip_arrow.png" + "E:/Dev/HaxeFlixel/flixel/assets-ui/images/tooltip_arrow.png" @@ -14985,7 +14985,7 @@ lime._internal.macros.AssetsMacro.embedBytes() lime._internal.macros.AssetsMacro.embedBytes() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/xml/defaults.xml" + "E:/Dev/HaxeFlixel/flixel/assets-ui/xml/defaults.xml" @@ -15004,7 +15004,7 @@ lime._internal.macros.AssetsMacro.embedBytes() lime._internal.macros.AssetsMacro.embedBytes() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/xml/default_loading_screen.xml" + "E:/Dev/HaxeFlixel/flixel/assets-ui/xml/default_loading_screen.xml" @@ -15023,7 +15023,7 @@ lime._internal.macros.AssetsMacro.embedBytes() lime._internal.macros.AssetsMacro.embedBytes() - "C:/HaxeToolkit/haxe/lib/flixel-yc29/git/assets-ui/xml/default_popup.xml" + "E:/Dev/HaxeFlixel/flixel/assets-ui/xml/default_popup.xml" @@ -15613,11 +15613,11 @@ "hxMath.h" - + - + @@ -15766,19 +15766,19 @@ * `FlxGroup` extend this class. Has no size, position or graphical data. - + <_inPool> - + - + <_pool expr="new FlxPool<FlxRect>(FlxRect)" line="15" static="1"> @@ -16080,7 +16080,7 @@ * Stores a rectangle. - + @@ -16833,7 +16833,7 @@ * sizes, scrolling, and basic physics and motion. - + @@ -17257,14 +17257,22 @@ - + <__drawComplexFlipX expr="false"> + + false + + <__drawComplexFlipY expr="false"> + + false + + - + @@ -17279,7 +17287,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. - + @@ -17290,7 +17298,7 @@ * * @param Force Force the frame to redraw, even if its not flagged as necessary. - + @@ -17300,12 +17308,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. - + @@ -17321,7 +17329,7 @@ * @param FetchPositions Whether we need to store positions of pixels which colors were replaced. * @return `Array` with replaced pixels positions - + @@ -17346,8 +17354,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`. - - + + @@ -17363,7 +17371,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. - + @@ -17376,11 +17384,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`. - + @@ -17391,7 +17399,7 @@ * Otherwise a new one is created. * @return A `FlxPoint` containing the midpoint of this sprite's graphic in world coordinates. - + @@ -17402,7 +17410,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. - + @@ -17410,7 +17418,7 @@ * Returns the result of `isSimpleRenderBlit()` if `FlxG.renderBlit` is * `true`, or `false` if `FlxG.renderTile` is `true`. - + @@ -17422,7 +17430,7 @@ * * @param camera If a camera is passed its `pixelPerfectRender` flag is taken into account - + @@ -17435,7 +17443,7 @@ * @return A globally aligned `FlxRect` that fully contains the input object's width and height. * @since 4.11.0 - + @@ -17448,7 +17456,7 @@ * @return A globally aligned `FlxRect` that fully contains the input sprite. * @since 4.11.0 - + @@ -17464,7 +17472,7 @@ * @param FlipX Whether to flip the sprite on the X axis. * @param FlipY Whether to flip the sprite on the Y axis. - + @@ -17480,64 +17488,64 @@ * @param saveAnimations Whether to save animations in animation controller or not. * @return This sprite with loaded frames - + - + - + - + - + - + - + - + - + - + @@ -17546,14 +17554,14 @@ * Internal function for setting graphic property for this object. * It changes graphics' `useCount` also for better memory tracking. - + - + @@ -17565,39 +17573,39 @@ * @param Frames frames to load into this sprite. * @return loaded frames. - + - + - + - + - + - + @@ -17638,7 +17646,7 @@ - + @@ -18448,7 +18456,7 @@ - + @@ -20669,7 +20677,7 @@ - + @@ -20744,7 +20752,7 @@ - + @@ -22686,7 +22694,7 @@ "void" - + <_onRequest set="method" line="159" static="1"> @@ -22712,7 +22720,7 @@ <_onReady set="method" line="150" static="1"> - + * Called once Discord has connected and is ready to start. @@ -22795,7 +22803,7 @@ - + <_init set="method" static="1"> @@ -22879,20 +22887,20 @@ - <__touch get="inline" set="null" expr=""1.665473362e+012"" line="22" static="1"> + <__touch get="inline" set="null" expr=""1.66548851e+012"" line="22" static="1"> - "1.665473362e+012" + "1.66548851e+012" - \n"]]> + \n"]]> "linc_discord_rpc.h" linc.Linc.touch() linc.Linc.xml("discord_rpc") - + @@ -22904,21 +22912,21 @@ - - + + - + - + - + @@ -22966,7 +22974,7 @@ - + @@ -23044,12 +23052,12 @@ - + - + @@ -23077,7 +23085,7 @@ - + @@ -23164,11 +23172,11 @@ - + * Types of flixel objects - mainly for collisions. - + @@ -23212,7 +23220,7 @@ - + @@ -23255,7 +23263,7 @@ - + @@ -23311,8 +23319,8 @@ - - + + <_pool expr="new FlxPool<FlxPoint>(FlxPoint)" line="17" static="1"> @@ -24748,7 +24756,7 @@ - + @@ -25310,7 +25318,7 @@ { smoothing : false } - + @@ -25319,9 +25327,11 @@ + + - { smoothing : false } + { flipY : false, flipX : false, smoothing : false } @@ -25748,7 +25758,7 @@ * |-> `debugLayer:Sprite` (this sprite is used in tile render mode for rendering debug info, like bounding boxes)]]> - + * Camera has no deadzone, just tracks the focus object directly. * Camera's deadzone is narrow but tall. * Camera's deadzone is a medium-size square around the focus object. @@ -25760,7 +25770,7 @@ - + "" @@ -25787,7 +25797,7 @@ flixel.system.macros.FlxGitSHA.buildGitSHA("flixel") - + * Gets max texture size for native targets @@ -26006,7 +26016,7 @@ * Accessed via `FlxG.bitmap`. - + @@ -26039,7 +26049,7 @@ * Accessed via `FlxG.bitmapLog`. - + [] @@ -26251,7 +26261,7 @@ * Accessed via `FlxG.cameras`. - + true @@ -26313,7 +26323,7 @@ * Accessed via `FlxG.console`. - + 3 @@ -26428,7 +26438,7 @@ * Accessed via `FlxG.debugger`. - + [] @@ -26468,7 +26478,7 @@ * Accessed via `FlxG.inputs`. - + @@ -26573,7 +26583,7 @@ - + @@ -26789,7 +26799,7 @@ * A class containing a set of functions for random generation. Should be accessed via `FlxG.random`. - + @@ -26904,7 +26914,7 @@ * handles some annoying storage request stuff too. - + @@ -26950,7 +26960,7 @@ * * The default behavior of `BaseScaleMode` matches that of `FillScaleMode`. - + @@ -26974,7 +26984,7 @@ * This is the default scaling mode used by HaxeFlixel. - + new FlxSignal() @@ -27070,7 +27080,7 @@ * Accessed via `FlxG.signals`. - + @@ -27154,7 +27164,7 @@ * Accessed via `FlxG.watch`. - + false @@ -27615,7 +27625,7 @@ * Global helper class for audio, input, the camera system, the debugger and other global properties. - + @@ -27623,7 +27633,7 @@ - + @@ -27786,38 +27796,42 @@ * Internal method to create a new instance of `_initialState` and reset the game. * This gets called when the game is created, as well as when a new state is requested. - + + + false + + <__firstSwitch expr="true"> true - - + + * If there is a state change requested during the update loop, * this function handles actual destroying the old state and related processes, * and calls creates on the new state and plugs it into the game object. - - + + * This is the main game update logic section. * The `onEnterFrame()` handler is in charge of calling this * the appropriate number of times each frame. * This block handles state changes, replays, all that good stuff. - - + + * This function is called by `step()` and updates the actual game state. * May be called multiple times per "frame" or draw call. - - - + + + * Goes through the game state and draws all the game objects and special effects. - - + + @@ -27853,7 +27867,7 @@ flixel.FlxG - + @@ -27954,7 +27968,7 @@ { Y : 0, X : 0 } - + @@ -28381,7 +28395,7 @@ * add itself to the global collisions quad tree, it will only add its members. - + @@ -28565,7 +28579,7 @@ - + @@ -28608,7 +28622,7 @@ * * WARNING: This class is EXTREMELY slow on Flash! - + @@ -28673,7 +28687,7 @@ * By default, it also stops the parent state from updating, * making it convenient for pause screens or menus. - + [] @@ -28686,7 +28700,7 @@ - + 0 @@ -29204,7 +29218,7 @@ * var gameid = 1; // Replace "1" with your game ID, visible if you go to https://gamejolt.com/dashboard/ -> Click on your game under "Manage Games" -> Click on "Achievements" in the menu. * FlxGameJolt.init(gameid, keystring); // Use this if your game is embedded as Flash on GameJolt's site, or run via Quick Play.]]> - + <_ppoint> <_scrollW expr="0"> @@ -29304,7 +29318,7 @@ * @author Chevy Ray - + @@ -29705,13 +29719,13 @@ * @author Richard Davey / Photon Storm - + - + @@ -29784,7 +29798,7 @@ * @author Richard Davey / Photon Storm - + @@ -29857,7 +29871,7 @@ - + @@ -30000,7 +30014,7 @@ * It can contain only other FlxNestedSprites. * @author Zaphod - + <_shadedScrollRect expr="new Sprite()"> @@ -30115,7 +30129,7 @@ * * @since 2.9.0]]> - + @@ -30365,7 +30379,7 @@ * @author Zaphod * @since 2.1.0 - + @@ -30419,7 +30433,7 @@ * @author Simon Etienne Rozner / Gameonaut.com, ported to Haxe by Sam Batista * @author Slightly updated by Beeblerox. - + @@ -30459,7 +30473,7 @@ - + @@ -30479,7 +30493,7 @@ { StarAmount : 300, Height : 0, Width : 0, Y : 0, X : 0 } - +
@@ -30499,7 +30513,7 @@ { StarAmount : 300, Height : 0, Width : 0, Y : 0, X : 0 } - + @@ -30509,7 +30523,7 @@ - + @@ -30607,7 +30621,7 @@ * @author Zaphod * @since 2.1.0 - + @@ -30652,7 +30666,7 @@ * @author greglieberman * @email greg@kwarp.com - + @@ -30718,11 +30732,11 @@ * * @author MrCdK - + - + @@ -30742,7 +30756,7 @@ - + @@ -30761,7 +30775,7 @@ - + @@ -30790,7 +30804,7 @@ * (original by Matt Tuttle based on Thomas Jahn's. Haxe port by Adrien Fischer) * This content is released under the MIT License. - + @@ -30830,7 +30844,7 @@ * This content is released under the MIT License. - + @@ -30848,7 +30862,7 @@ - + @@ -30862,7 +30876,7 @@ * This content is released under the MIT License. - + @@ -30872,7 +30886,7 @@ - + @@ -30962,11 +30976,11 @@ * (original by Matt Tuttle based on Thomas Jahn's. Haxe port by Adrien Fischer) * This content is released under the MIT License. - + - + 0x40000000 @@ -31061,7 +31075,7 @@ * This content is released under the MIT License. - + @@ -31079,7 +31093,7 @@ * This content is released under the MIT License. - + @@ -31107,7 +31121,7 @@ * This content is released under the MIT License. - + 0x80000000 @@ -31162,7 +31176,7 @@ - + @@ -31196,14 +31210,14 @@ - + @since 2.2.0 - + @@ -31230,7 +31244,7 @@ @since 2.2.0 - + @@ -31291,12 +31305,12 @@ * This content is released under the MIT License. - - + + - + @@ -31457,7 +31471,7 @@ * * @author adrianulima - + @@ -31467,12 +31481,12 @@ - + - + @@ -31518,7 +31532,7 @@ * @author Zaphod - + @@ -31682,7 +31696,7 @@ * Feel free to use this class and adjust it to your needs. * @author Gama11 - + @@ -31845,7 +31859,7 @@ * add it to the display. Then add all sprites that should have a trail effect via the add function. * @author KeyMaster - + @@ -31908,7 +31922,7 @@ * Use this class to chain bitmap effects to your target FlxSprite frame. * @author adrianulima - + @@ -31921,7 +31935,7 @@ - + @@ -32000,7 +32014,7 @@ * @author Tim Hely / tims-world.com * @author adrianulima - + @@ -32008,7 +32022,7 @@ - + @@ -32120,7 +32134,7 @@ * @author red__hara * @author adrianulima - + @@ -32130,7 +32144,7 @@ - + @@ -32201,7 +32215,7 @@ * @author Tim Hely / tims-world.com * @author adrianulima - + @@ -32290,7 +32304,7 @@ * * @author adrianulima - + @@ -32391,7 +32405,7 @@ * * @author adrianulima - + @@ -32494,7 +32508,7 @@ * @author Tim Hely / tims-world.com * @author adrianulima - + @@ -32503,7 +32517,7 @@ - + @@ -32511,7 +32525,7 @@ - + @@ -32853,7 +32867,7 @@ - + @@ -32974,7 +32988,7 @@ * @author Richard Davey / Photon Storm * @co-author Ungar Djordje / ArtBIT (Haxe port) - + @@ -32990,7 +33004,7 @@ - + @@ -33077,7 +33091,7 @@ * @link http://www.photonstorm.com * @author Richard Davey / Photon Storm - + 0 @@ -33776,7 +33790,7 @@ * @author Richard Davey / Photon Storm - + <_hotkeys static="1"> @@ -33866,7 +33880,7 @@ * @link http://www.photonstorm.com * @author Richard Davey / Photon Storm - + @@ -33905,7 +33919,7 @@ * @since 11.19.2012 - + @@ -34067,7 +34081,7 @@ * @author Zaphod * @since 11.19.2012 - + @@ -34455,7 +34469,7 @@ * though. Also does nice pixel-perfect centering on pixel fonts as long as they are only one-liners. - + @@ -34997,7 +35011,7 @@ openfl.utils._internal.AssetsMacro.embedSound() - + @@ -35015,7 +35029,7 @@ "assets/sounds/type.ogg" - + @@ -35261,7 +35275,7 @@ * @author Noel Berry]]> - + @@ -35347,7 +35361,7 @@ * to generate very sexy caves. * (Coded by Eddie Lee, October 16, 2010) - + @@ -35399,7 +35413,7 @@ - + @@ -35506,7 +35520,7 @@ - + @@ -37390,7 +37404,7 @@ openfl.utils._internal.AssetsMacro.embedBitmap() - + @@ -37413,7 +37427,7 @@ "assets/images/transitions/circle.png" - + @@ -37437,7 +37451,7 @@ "assets/images/transitions/diamond.png" - + @@ -37460,7 +37474,7 @@ "assets/images/transitions/square.png" - + <_delay> <_count> @@ -37518,10 +37532,10 @@ * @author Tim Hely - + - + @@ -37565,7 +37579,7 @@ - + @@ -37608,7 +37622,7 @@ - + @@ -37704,7 +37718,7 @@ * ``` - + <_effect> @@ -37739,10 +37753,10 @@ * @author Tim Hely, larsiusprime - + - + @@ -37770,7 +37784,7 @@ - + @@ -37797,7 +37811,7 @@ - + @@ -37806,7 +37820,7 @@ - + @@ -37834,7 +37848,7 @@ * @author larsiusprime - + @@ -37872,7 +37886,7 @@ * @author larsiusprime flixel.addons.transition.Transition - + @@ -37896,7 +37910,7 @@ "assets/images/transitions/diagonal_gradient.png" - + @@ -37953,7 +37967,7 @@ * @author larsiusprime - + <_grpSprites> <_isCenter expr="false"> @@ -37981,7 +37995,7 @@ * @author larsiusprime - + @@ -38038,7 +38052,7 @@ * A class that describes how some object should be positioned relative to another - + 0 @@ -38059,7 +38073,7 @@ - + @@ -38085,7 +38099,7 @@ - + null @@ -38115,7 +38129,7 @@ - + @@ -38171,7 +38185,7 @@ * Makes it easier to check if, say, SHIFT+Tab is being pressed rather than just Tab by itself - + @@ -38325,7 +38339,7 @@ * @link http://www.photonstorm.com * @author Richard Davey / Photon Storm - + @@ -38398,7 +38412,7 @@ * Trimmed-down button, invisible click area, only responds to onUP - + @@ -38773,7 +38787,7 @@ * @link http://creativecommons.org/licenses/by/3.0/us/ - + @@ -38799,7 +38813,7 @@ * @author larsiusprime - + @@ -38834,7 +38848,7 @@ * @author larsiusprime - + @@ -38842,12 +38856,12 @@ - + - + @@ -38870,7 +38884,7 @@ * @author larsiusprime - + @@ -39081,7 +39095,7 @@ * A slider GUI element for float and integer manipulation. * @author Gama11 - + @@ -39125,7 +39139,7 @@ * @author Lars Doucet - + @@ -39190,7 +39204,7 @@ * @author Lars Doucet - + @@ -39206,7 +39220,7 @@ - + @@ -40284,14 +40298,14 @@ * @author Lars Doucet - + - + @@ -40301,38 +40315,38 @@ - + - + - + - + - + - + - + - + @@ -40378,7 +40392,7 @@ * @author Lars Doucet - + @@ -41012,7 +41026,7 @@ - + @@ -41227,11 +41241,11 @@ * @author Lars Doucet - + - + "flixel/flixel-ui/img/button.png" @@ -41380,7 +41394,7 @@ null - + @@ -41796,7 +41810,7 @@ * @author Richard Davey / Photon Storm - + @@ -41804,7 +41818,7 @@ - + @@ -41862,7 +41876,7 @@ * @author larsiusprime - + @@ -41873,7 +41887,7 @@ - + @@ -41907,7 +41921,7 @@ - + - + * The cursor can point to one of these * @author Lars Doucet - + @@ -42132,7 +42146,7 @@ - + @@ -42263,7 +42277,7 @@ flixel.ui.FlxButton - + @@ -42607,7 +42621,7 @@ - + @@ -42617,7 +42631,7 @@ * @author Lars Doucet - + @@ -42752,7 +42766,7 @@ * state just by adjusting a few public variables - + @@ -42876,7 +42890,7 @@ * @author Lars Doucet - + @@ -42974,7 +42988,7 @@ - + @@ -43087,12 +43101,12 @@ * ... * @author larsiusprime - + - + @@ -43403,26 +43417,26 @@ * TODO: need to support gamepad and/or deal with absence of mouse - + - + - + - + @@ -43586,7 +43600,7 @@ * @author larsiusprime - + @@ -43620,7 +43634,7 @@ * Header for a FlxUIDropDownMenu - + @@ -43629,7 +43643,7 @@ - + @@ -43678,7 +43692,7 @@ * @author Lars Doucet - + @@ -43724,7 +43738,7 @@ * @author larsiusprime - + @@ -43732,7 +43746,7 @@ - + @@ -43854,7 +43868,7 @@ - + @@ -43866,7 +43880,7 @@ <_tongue> - + @@ -43998,7 +44012,7 @@ * * @author Lars Doucet - + @@ -44171,7 +44185,7 @@ - + @@ -44289,7 +44303,7 @@ * * @author larsiusprime - + <_cachedPoint expr="new FlxPoint()" line="19" static="1"> new FlxPoint() @@ -44397,7 +44411,7 @@ - + @@ -44405,7 +44419,7 @@ flixel.system.frontEnds.InputFrontEnd - + @@ -44654,7 +44668,7 @@ * Normally accessed via `FlxG.mouse`. - + @@ -44673,7 +44687,7 @@ * like using the keyboard to control mouse moving/clicking - + @@ -44825,7 +44839,7 @@ - + @@ -45046,7 +45060,7 @@ * @author Lars Doucet - + @@ -45069,7 +45083,7 @@ - + @@ -45096,7 +45110,7 @@ * A scalable object with width and height that isn't used for display purposes - + @@ -45123,7 +45137,7 @@ - + @@ -45158,7 +45172,7 @@ * accordingly. - + @@ -45330,7 +45344,7 @@ * @author Lars Doucet - + @@ -45496,7 +45510,7 @@ * @author Lars Doucet - + @@ -45541,7 +45555,7 @@ * @author Lars Doucet - + @@ -45615,7 +45629,7 @@ * This is mostly just for testing purposes, it is NOT a replacement for FlxTileMap - + @@ -45726,7 +45740,7 @@ * @author larsiusprime - + @@ -45800,7 +45814,7 @@ - + @@ -46015,7 +46029,7 @@ * @author larsiusprime - + @@ -46036,7 +46050,7 @@ - + <c path="String"/>

class AnimationDebug

package funkin.debug

extends FlxState

@:directlyUsed

DEBUG MODE

Constructor

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

Methods

© 2022  

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

funkin.debug

..
AnimationDebug

DEBUG MODE

© 2022  

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

class ChartingState

package funkin.editors

extends MusicBeatState

@:directlyUsed

Static variables

@:value(0)staticlastSection:Int = 0

Constructor

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

Methods

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/editors/index.html b/pages/funkin/editors/index.html new file mode 100644 index 00000000..6f7bf826 --- /dev/null +++ b/pages/funkin/editors/index.html @@ -0,0 +1,10 @@ + + + +funkin.editors

funkin.editors

..
ChartingState

© 2022  

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

@:value(false)stunned:Bool = false

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({ suffix : "" })playSingAnim(direction:Int, suffix:String = ""):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(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

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/GameOverSubstate.html b/pages/funkin/game/GameOverSubstate.html index fcc29834..938f3622 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

Constructor

new(x:Float, y:Float)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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 MusicBeatSubstate

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

package funkin.game

extends MusicBeatSubstate

@:directlyUsed

Constructor

new(x:Float, y:Float)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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 MusicBeatSubstate

@: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/HealthIcon.html b/pages/funkin/game/HealthIcon.html new file mode 100644 index 00000000..df6aa364 --- /dev/null +++ b/pages/funkin/game/HealthIcon.html @@ -0,0 +1,11 @@ + + + +funkin.game.HealthIcon

class HealthIcon

package funkin.game

extends FlxSprite

@:directlyUsed

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

© 2022  

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

class Highscore

package funkin.game

@:directlyUsed

Static variables

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

Static methods

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

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

staticgetWeekScore(week:Int, diff:Int):Int

staticload():Void

@:value({ diff : 0, score : 0 })staticsaveScore(song:String, score:Int = 0, diff:Int = 0):Void

@:value({ diff : 0, score : 0, week : 1 })staticsaveWeekScore(week:Int = 1, score:Int = 0, diff:Int = 0):Void

© 2022  

\ No newline at end of file diff --git a/pages/funkin/game/PlayState.html b/pages/funkin/game/PlayState.html index 79b50461..0f6d3f20 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

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

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(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(8)lightningOffset:Int = 8

@:value(0)lightningStrikeBeat:Int = 0

@:value(true)muteVocalsOnMiss:Bool = true

notes:FlxTypedGroup<Note>

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

@:value([])unspawnNotes:Array<Note> = []

vocals:FlxSound

Methods

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

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

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(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(8)lightningOffset:Int = 8

@:value(0)lightningStrikeBeat:Int = 0

@:value(true)muteVocalsOnMiss:Bool = true

notes:FlxTypedGroup<Note>

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

@:value([])unspawnNotes:Array<Note> = []

vocals:FlxSound

Methods

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/index.html b/pages/funkin/game/index.html index 51f9baa5..a9c5e90f 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

Note

PlayState

Stage

StageSprite

Strum

© 2022  

\ No newline at end of file +

funkin.game

..
Character

GameOverSubstate

HealthIcon

Highscore

Note

PlayState

Stage

StageSprite

Strum

© 2022  

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

funkin

..
data
game
interfaces
macros
menus
mods
scripting
system

© 2022  

\ No newline at end of file +

funkin

..
data
debug
editors
game
interfaces
macros
menus
mods
scripting
system
ui

© 2022  

\ No newline at end of file diff --git a/pages/funkin/menus/FreeplayState.html b/pages/funkin/menus/FreeplayState.html index 7500ba13..7ccfb031 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

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(?TransIn:TransitionData, ?TransOut:TransitionData)

Methods

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 FreeplayState

package funkin.menus

extends MusicBeatState

@:directlyUsed

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(?TransIn:TransitionData, ?TransOut:TransitionData)

Methods

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/menus/GitarooPause.html b/pages/funkin/menus/GitarooPause.html index 68fb4f6e..8a1ca665 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

Constructor

new()

Methods

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 GitarooPause

package funkin.menus

extends MusicBeatState

@:directlyUsed

Constructor

new()

Methods

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/menus/MainMenuState.html b/pages/funkin/menus/MainMenuState.html index e7592d73..0dac5151 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

Constructor

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

Methods

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 MainMenuState

package funkin.menus

extends MusicBeatState

@:directlyUsed

Constructor

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

Methods

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/menus/PauseSubState.html b/pages/funkin/menus/PauseSubState.html index 831a9989..4723a314 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

Constructor

new(x:Float, y:Float)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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 MusicBeatSubstate

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

package funkin.menus

extends MusicBeatSubstate

@:directlyUsed

Constructor

new(x:Float, y:Float)

Methods

Inherited Variables

Defined by MusicBeatSubstate

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 MusicBeatSubstate

@: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/menus/StoryMenuState.html b/pages/funkin/menus/StoryMenuState.html index 5f55fd35..7b8ece53 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

Static variables

@:value([true, true, true, true, true, true, true])staticweekUnlocked:Array<Bool> = [true, true, true, true, true, true, true]

Constructor

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

Methods

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 StoryMenuState

package funkin.menus

extends MusicBeatState

@:directlyUsed

Static variables

@:value([true, true, true, true, true, true, true])staticweekUnlocked:Array<Bool> = [true, true, true, true, true, true, true]

Constructor

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

Methods

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/menus/TitleState.html b/pages/funkin/menus/TitleState.html index 32396854..2d2e4ee4 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

Constructor

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

Methods

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 TitleState

package funkin.menus

extends MusicBeatState

@:directlyUsed

Constructor

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

Methods

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/scripting/events/CancellableEvent.html b/pages/funkin/scripting/events/CancellableEvent.html index b1eb4093..043acf0a 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 InputSystemEvent, NoteHitEvent, PlayAnimEvent

@:allow(ScriptPack)

Constructor

new()

Creates a new cancellable event. +

class CancellableEvent

package funkin.scripting.events

extended by DanceEvent, DirectionAnimEvent, InputSystemEvent, NoteHitEvent, PlayAnimEvent, PointEvent

@: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/DanceEvent.html b/pages/funkin/scripting/events/DanceEvent.html new file mode 100644 index 00000000..dc5cb177 --- /dev/null +++ b/pages/funkin/scripting/events/DanceEvent.html @@ -0,0 +1,12 @@ + + + +funkin.scripting.events.DanceEvent

class DanceEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed

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 : 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/DirectionAnimEvent.html b/pages/funkin/scripting/events/DirectionAnimEvent.html new file mode 100644 index 00000000..f1aa349d --- /dev/null +++ b/pages/funkin/scripting/events/DirectionAnimEvent.html @@ -0,0 +1,12 @@ + + + +funkin.scripting.events.DirectionAnimEvent

class DirectionAnimEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed

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 : 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/PointEvent.html b/pages/funkin/scripting/events/PointEvent.html new file mode 100644 index 00000000..850a0f6d --- /dev/null +++ b/pages/funkin/scripting/events/PointEvent.html @@ -0,0 +1,12 @@ + + + +funkin.scripting.events.PointEvent

class PointEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed

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 : 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 c8c26972..cc6f1a49 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

InputSystemEvent

NoteHitEvent

PlayAnimContext

Contains all contexts possible for PlayAnimEvent.

PlayAnimEvent

© 2022  

\ No newline at end of file +

funkin.scripting.events

..
CancellableEvent

DanceEvent

DirectionAnimEvent

InputSystemEvent

NoteHitEvent

PlayAnimContext

Contains all contexts possible for PlayAnimEvent.

PlayAnimEvent

PointEvent

© 2022  

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

enum abstract Action(String)

package funkin.system

from String to String

import funkin.system.Controls

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/system/Control.html b/pages/funkin/system/Control.html new file mode 100644 index 00000000..407a61a7 --- /dev/null +++ b/pages/funkin/system/Control.html @@ -0,0 +1,14 @@ + + + +funkin.system.Control

enum Control

package funkin.system

import funkin.system.Controls

@:directlyUsed@:flatEnum

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

RESET

ACCEPT

BACK

PAUSE

CHEAT

© 2022  

\ No newline at end of file diff --git a/pages/funkin/system/Controls.html b/pages/funkin/system/Controls.html new file mode 100644 index 00000000..9529c46a --- /dev/null +++ b/pages/funkin/system/Controls.html @@ -0,0 +1,16 @@ + + + +funkin.system.Controls

class Controls

package funkin.system

extends FlxActionSet

@:directlyUsed

A list of actions that a player would invoke via some input device. +Uses FlxActions to funnel various inputs to a single action.

Constructor

@:value({ scheme : None })new(name:String, scheme:KeyboardScheme = None)

Variables

read onlyACCEPT:Bool

read onlyBACK:Bool

read onlyCHEAT:Bool

read onlyDOWN:Bool

read onlyDOWN_P:Bool

read onlyDOWN_R:Bool

read onlyLEFT:Bool

read onlyLEFT_P:Bool

read onlyLEFT_R:Bool

read onlyPAUSE:Bool

read onlyRESET:Bool

read onlyRIGHT:Bool

read onlyRIGHT_P:Bool

read onlyRIGHT_R:Bool

read onlyUP:Bool

read onlyUP_P:Bool

read onlyUP_R:Bool

@:value([])gamepadsAdded:Array<Int> = []

@:value(KeyboardScheme.None)keyboardScheme:KeyboardScheme = KeyboardScheme.None

Methods

addDefaultGamepad(id:Int):Void

addGamepad(id:Int, ?buttonMap:Map<Control, Array<FlxGamepadInputID>>):Void

bindButtons(control:Control, id:Int, buttons:Array<FlxGamepadInputID>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. +If binder is a literal you can inline this

bindKeys(control:Control, keys:Array<FlxKey>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. +If binder is a literal you can inline this

checkByName(name:Action):Bool

copyFrom(controls:Controls, ?device:Device):Void

inlinecopyTo(controls:Controls, ?device:Device):Void

getDialogueName(action:FlxActionDigital):String

getDialogueNameFromToken(token:String):String

getInputsFor(control:Control, device:Device, ?list:Array<Int>):Array<Int>

removeDevice(device:Device):Void

@:value({ deviceID : FlxInputDeviceID.ALL })removeGamepad(deviceID:Int = FlxInputDeviceID.ALL):Void

replaceBinding(control:Control, device:Device, ?toAdd:Int, ?toRemove:Int):Void

@:value({ reset : true })setKeyboardScheme(scheme:KeyboardScheme, reset:Bool = true):Void

unbindButtons(control:Control, gamepadID:Int, buttons:Array<FlxGamepadInputID>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. +If binder is a literal you can inline this

unbindKeys(control:Control, keys:Array<FlxKey>):Void

Sets all actions that pertain to the binder to trigger when the supplied keys are used. +If binder is a literal you can inline this

© 2022  

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

enum Device

package funkin.system

import funkin.system.Controls

Values

Keys

Gamepad(id:Int)

© 2022  

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

class DiscordClient

package funkin.system

import funkin.system.Discord

@:directlyUsed

Static methods

staticchangePresence(details:String, state:Null<String>, ?smallImageKey:String, ?hasStartTimestamp:Bool, ?endTimestamp:Float):Void

staticinitialize():Void

staticshutdown():Void

Constructor

new()

© 2022  

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

enum KeyboardScheme

package funkin.system

import funkin.system.Controls

@:directlyUsed

Values

Solo

Duo(first:Bool)

None

Custom

© 2022  

\ No newline at end of file diff --git a/pages/funkin/system/MusicBeatState.html b/pages/funkin/system/MusicBeatState.html index 73e3cae2..02896cfc 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

extended by PlayState, FreeplayState, GitarooPause, MainMenuState, StoryMenuState, TitleState

Constructor

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

Variables

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)

Methods

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

package funkin.system

extends FlxUIState

extended by ChartingState, PlayState, FreeplayState, GitarooPause, MainMenuState, StoryMenuState, TitleState

Constructor

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

Variables

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)

Methods

@: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/system/MusicBeatSubstate.html b/pages/funkin/system/MusicBeatSubstate.html index 89ce8acc..a084a40e 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

extended by GameOverSubstate, PauseSubState

Constructor

new()

Variables

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)

Methods

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

package funkin.system

extends FlxSubState

extended by GameOverSubstate, PauseSubState

Constructor

new()

Variables

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)

Methods

@: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/system/Paths.html b/pages/funkin/system/Paths.html index afa646c4..eee7eacb 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

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.

Static methods

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

@:value({ type : TEXT })staticinlinefile(file:String, type:AssetType = TEXT, ?library:String):String

staticinlinefont(key:String):String

@:value({ scanSource : false, addPath : false, includeSource : true })staticgetFolderContent(key:String, includeSource:Bool = true, addPath:Bool = false, scanSource:Bool = false):Array<String>

@:value({ library : "preload" })staticgetLibraryPath(file:String, library:String = "preload"):String

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

@:value({ skipModsVerification : false })staticgetPath(file:String, type:AssetType, library:Null<String>, skipModsVerification:Bool = false):String

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

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

staticinlineinst(song:String):String

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

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

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

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

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

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

staticinlinevoices(song:String):String

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

© 2022  

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

Static methods

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

@:value({ type : TEXT })staticinlinefile(file:String, type:AssetType = TEXT, ?library:String):String

staticinlinefont(key:String):String

@:value({ scanSource : false, addPath : false, includeSource : true })staticgetFolderContent(key:String, includeSource:Bool = true, addPath:Bool = false, scanSource:Bool = false):Array<String>

@:value({ library : "preload" })staticgetLibraryPath(file:String, library:String = "preload"):String

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

@:value({ skipModsVerification : false })staticgetPath(file:String, type:AssetType, library:Null<String>, skipModsVerification:Bool = false):String

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

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

staticinlineinst(song:String):String

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

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

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

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

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

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

staticinlinevoices(song:String):String

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

© 2022  

\ No newline at end of file diff --git a/pages/funkin/system/index.html b/pages/funkin/system/index.html index ce27d9cb..262e9226 100644 --- a/pages/funkin/system/index.html +++ b/pages/funkin/system/index.html @@ -7,5 +7,8 @@ float: none; text-shadow: 0 0 0 transparent; } -

funkin.system

..
AnimData

BPMChangeEvent

... -@author

Conductor

CoolUtil

ErrorCode

MusicBeatState

MusicBeatSubstate

Paths

Song

SwagSong

XMLUtil

Class made to make XML parsing easier.

© 2022  

\ No newline at end of file +

funkin.system

..
Action

AnimData

BPMChangeEvent

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

Device

DiscordClient

ErrorCode

KeyboardScheme

MusicBeatState

MusicBeatSubstate

Paths

Song

SwagSong

XMLUtil

Class made to make XML parsing easier.

© 2022  

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

class AlphaCharacter

package funkin.ui

extends FlxSprite

import funkin.ui.Alphabet

@:directlyUsed

Static variables

@:value("abcdefghijklmnopqrstuvwxyz")staticalphabet:String = "abcdefghijklmnopqrstuvwxyz"

@:value("1234567890")staticnumbers:String = "1234567890"

@:value("|~#$%()*+-:;<=>@[]^_.,'!?")staticsymbols:String = "|~#$%()*+-:;<=>@[]^_.,'!?"

Constructor

new(x:Float, y:Float)

Variables

@:value(0)row:Int = 0

Methods

createBold(letter:String):Void

createLetter(letter:String):Void

createNumber(letter:String):Void

createSymbol(letter:String):Void

© 2022  

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

class Alphabet

package funkin.ui

extends FlxTypedSpriteGroup

@:directlyUsed

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

startTypedText():Void

© 2022  

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

funkin.ui

..
AlphaCharacter

Alphabet

Loosley based on FlxTypeText lolol

© 2022  

\ No newline at end of file diff --git a/pages/nav.js b/pages/nav.js index dc79cab4..1617da6f 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/CharacterScript.html b/pages/scripting/CharacterScript.html new file mode 100644 index 00000000..fcfe5bfc --- /dev/null +++ b/pages/scripting/CharacterScript.html @@ -0,0 +1,12 @@ + + + +scripting.CharacterScript

interface CharacterScript

package scripting

@:hxGen

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.

createPost():Void

Triggered after the character has been entirely 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.

stepHit(curStep:Int):Void

Triggered every step

update(elapsed:Float):Void

Triggered every frame.

© 2022  

\ No newline at end of file diff --git a/pages/scripting/PlayStateScript.html b/pages/scripting/PlayStateScript.html index ae2f42ff..94cf5258 100644 --- a/pages/scripting/PlayStateScript.html +++ b/pages/scripting/PlayStateScript.html @@ -8,5 +8,5 @@ text-shadow: 0 0 0 transparent; }

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(note: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(note:InputSystemEvent):Void

Triggered after the input system updates.

Parameters:

note

Event object with the pressed, justPressed and justReleased notes.

onDadHit(note: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.

onPlayerHit(note: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 +

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(note: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(note:InputSystemEvent):Void

Triggered after the input system updates.

Parameters:

note

Event object with the pressed, justPressed and justReleased notes.

onDadHit(note: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.

onPlayerHit(note: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 diff --git a/pages/scripting/index.html b/pages/scripting/index.html index c80d9457..5208cdc9 100644 --- a/pages/scripting/index.html +++ b/pages/scripting/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

scripting

..
PlayStateScript

Contains all callbacks you can add in modcharts and stage scripts.

© 2022  

\ No newline at end of file +

scripting

..
CharacterScript

Contains all callbacks you can add in a Character script.

PlayStateScript

Contains all callbacks you can add in modcharts and stage scripts.

© 2022  

\ No newline at end of file