Skip to content

Commit

Permalink
Update 01 - scripting.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Joalor64GH authored Nov 18, 2024
1 parent a9ed248 commit 56407c9
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/01 - scripting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# How to Use the Scripting System
This will teach you how to use Rhythmo's special scripting system. Basically, you can use this to make custom backgrounds, add special functions, make cool mechanics, etc.
This will teach you how to use Rhythmo's scripting system. Basically, you can use this to make custom backgrounds, add special functions, make cool mechanics, etc.

Your script should either be located in `assets/scripts/[name].hxs`, or in `assets/songs/[song-name]/[name].hxs`. <br>
However, if your script is a scripted state or substate, it should be located in `assets/classes/[name].hxs`.
Expand All @@ -17,7 +17,6 @@ The following are not supported:
* Access modifiers (e.g., `private`, `public`)
* Multi-line comments (`/* ... */`)


## Default Variables
* `Function_Stop` - Cancels functions (e.g., `startCountdown`, `endSong`).
* `Function_Continue` - Continues the game like normal.
Expand Down Expand Up @@ -204,7 +203,7 @@ function new(/* arguments, if any */) {

Additionally, if you want to load your custom state from the main menu, navigate to `assets/menuList.txt` and add in your state's name, as well as a main menu asset for it in `assets/images/menu/mainmenu/[name].png`.

And just in case your script doesn't load or something goes wrong, press `F4` to be sent to `MainMenuState.hx`
And just in case your script doesn't load or something goes wrong, press `F4` to be sent to `MainMenuState.hx`.

### Using Imported Scripts
Script 1:
Expand Down

0 comments on commit 56407c9

Please sign in to comment.