Codename Logo Codename Logo

Global Scripts

APIWiki

Global Scripts

Global Scripts always run during the game, doesn't matter in which state or where, it always runs. (runs from when the mod is loaded/game opened up until the game is closed/different mod is loaded)
You can make one by creating a file in ./data/ called global.hx

Global Scripts are useful for certain things, for example, here's the default code in the base's global script:

function update(elapsed:Float)
    if (FlxG.keys.justPressed.F5) FlxG.resetState();

Which makes it so that pressing F5 will refresh any state you are currently in.

Or a different example:

static var cashAmount:Float = 0;
static var playerTitle = "poor";

function update(elapsed:Float) {
    if (cashAmount > 1000000) playerTitle = "millionaire";
}

This basic example shows how you can use static variables and trigger actions depending on them. As you can see, these variables are accessible in any script, so you can basically use them in any PlayState Scripts and State Scripts too.

Useful script snippets for modders contains a few useful code snippets that take advantage of Global Scripts.

Written by: Frakits
Last updated: 2024-08-31