News

Calls the scripts user_event0.gml – user_event15.gml from the mod’s scripts folder, within the context of the instance using this function and the script it’s used in.

Example, called from attack_update.gml:

//This code runs a custom event during certain points in USPECIAL and FSPECIAL. This could be things like building meter or activating a status effect, but really it's up to you.
if (attack == AT_USPECIAL && window == 2 && window_timer == 1) {
user_event( 2 );
}
if (attack == AT_FSPECIAL && window == 4 == window_timer == 1) {
user_event( 2 );
}

Prints a custom message to the error log. The error log can be toggled by pressing Ctrl+F8 anywhere in the game.

Example, called from init.gml:

print_debug( “Hello, world!” );

Temporarily suppresses the volume of the stage music on every frame this function is called, allowing custom characters to draw attention to special moves or animations. Once the function stops being called, the stage music will return to its original volume.

Both arguments are optional; by default, the stage music is suppressed to 25% volume.

Example 1, called from animation.gml:

// suppress stage music to 25% volume at a rate of 0.01 per frame:
suppress_stage_music();

Example 2, called from animation.gml:

// suppress stage music to 50% volume at a rate of 0.005 per frame:
suppress_stage_music( 0.5, 0.005 );

Returns true if all active players have 1 stock remaining during a stock match.

Example, called from a stage’s update.gml:

// if everyone has 1 stock remaining, crossfade into laststock music:
if (is_laststock()) {
music_crossfade();
}

When called in a stage article, gradually crossfades the music to its laststock counterpart if a valid _laststock music file is detected in the /sounds folder. (A valid laststock counterpart to music_loop.ogg would be named music_loop_laststock.ogg, for example.) Both arguments are optional. This function can be used in conjunction with is_laststock() to replicate the music change on the Aethereal Gates stage.

Example 1, called from a stage’s update.gml:

// if everyone has 1 stock remaining, crossfade into laststock music at a rate of 0.01 per frame:
if (is_laststock()) {
music_crossfade();
}

Example 2, called from a stage’s update.gml:

// if everyone has 1 stock remaining, crossfade into laststock music at a rate of 0.025 per frame:
if (is_laststock()) {
music_crossfade( 1, 0.025 );
}