Repository navigation
Scripting
Scripts in Rhythmo can be active in only one song, or be applied globally to every song. You can use scripts 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.
However, if your script is a scripted state or substate, it should be located in assets/classes/[name].hxs.
The following are not supported:
- Keywords:
package-
import(there's another function that emulates the purpose of this function) classtypedefmetadatafinal
- Wildcard imports
- Access modifiers (e.g.,
private,public)
-
Function_Stop- Cancels functions (e.g.,startCountdown,endSong). -
Function_Continue- Continues the game like normal. -
platform- Returns the current platform (e.g., Windows, Linux). -
version- Returns the current game version.
-
import- See Imports for more. -
trace(_)- The equivalent oftracein normal Haxe. -
stopScript()- Stops the current script. -
addScript(path:String)- Adds a new script toscriptArray(Used in PlayState only). -
importScript(source:String)- Gives the given script's local functions and variables.
To import a class, use:
import('package.Class');To import an enumerator, use:
import('package.Enum');To put an import under an alias name, use:
import('package.Class', 'Name');You can basically use this to import any class/enum you'd like.
Otherwise, here is a list of the current classes you can use that are already imported:
ArrayBoolDateDateToolsDynamicERegFloatIntLambdaMathReflectStdStringStringBufStringToolsSysTypeXml
AchievementsApplicationAssetsBarConductorExtendableStateExtendableSubStateFileFileSystemFlxAtlasFramesFlxBackdropFlxBasicFlxCamera-
FlxColor- Fun Fact,
FlxColoris actually an abstract type which isn't normally supported byhscript. Luckily, I figured out a little workaround so you can still useFlxColornormally, or you can just use plain hex color values.
- Fun Fact,
FlxEaseFlxGFlxGroupFlxMathFlxObjectFlxSaveFlxSortFlxSoundFlxSpriteFlxSpriteGroupFlxStringUtilFlxTextFlxTextBorderStyleFlxTimerFlxTweenFlxTypedGroupGameSpriteHighScoreInputJsonLibLocalizationMainModHandlerNotePathPathsPlayStateRatingSaveDataScriptedStateScriptedSubStateSongUtilities
Some useful templates. For the default template, use this.
import('flixel.FlxSprite');
import('states.PlayState');
function create() {
var spr:FlxSprite = new FlxSprite(0, 0).makeGraphic(50, 50, FlxColor.BLACK);
PlayState.instance.add(spr);
}import('flixel.text.FlxText');
import('states.PlayState');
function create() {
var text:FlxText = new FlxText(0, 0, 0, "Hello World", 64);
text.screenCenter();
PlayState.instance.add(text);
}import('sys.FileSystem');
import('sys.io.File');
import('haxe.Json');
var json:Dynamic;
function create() {
if (FileSystem.exists('assets/data.json'))
json = Json.parse(File.getContent('assets/data.json'));
trace(json);
}import('states.ScriptedState');
import('substates.ScriptedSubState');
import('backend.ExtendableState');
import('backend.Input');
import('flixel.FlxG');
var state = FlxG.state;
function update(elapsed:Float) {
if (Input.justPressed('accept'))
ExtendableState.switchState(new ScriptedState('name', [])); // load custom state
if (Input.justPressed('exit'))
state.openSubState(new ScriptedSubState('name', [])); // load custom substate
}Additional template for scripted substates:
function new(/* arguments, if any */) {
// code goes here...
}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 the main menu.
Script 1:
// assets/helpers/spriteHandler.hxs
import('flixel.FlxSprite');
import('backend.Paths');
import('flixel.FlxG');
var state = FlxG.state;
function createSprite(x:Float, y:Float, graphic:String) {
var spr:FlxSprite = new FlxSprite(x, y);
spr.loadGraphic(Paths.image(graphic));
state.add(spr);
trace("sprite " + sprite + " created");
}Script 2:
var otherScript = importScript('assets.helpers.spriteHandler');
function create() {
otherScript.createSprite(0, 0, 'sprite');
}As long as you've done everything correctly, your script should functioning. Otherwise, report an issue.