News

get_article_script

Returns the script set used by the stage article. Will return -1 if the instance is not a stage article.

ArgumentTypeDescription
instance_id:realthe article ID to get the script set of.

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

 

//This code will destroy any normal stage article that uses scripts like "article4_update.gml", but leave ones that use other scripts (article3_update.gml, article5_update.gml, etc) intact.
if (wave_timer <= 0) {
with ( obj_stage_article ) {
if ( get_article_script( id ) == 4 ) {
instance_destroy();
}
}
}

is_aether_stage

Returns true if the current stage is set to Aether, and false if it’s Basic.

Example, called from a stage’s article1_update:

//This code will make a stage article shoot out a hitbox every 1/2 second (30 frames), but only if Aether mode is turned on.
if (shot_cooldown <= 0 && is_aether_stage() ) {
shot_cooldown = 30;
create_hitbox( AT_JAB, 0, x, y);
}

get_player_hud_color

Returns the hex value of the specified player’s HUD color.

ArgumentTypeDescription
player:realThe player slot to check. Should be between 1 and 4.

Example, called from update.gml:

//This code changes the player's outline to the same color as their HUD.
var _col = get_player_hud_color( player );
outline_color = [
color_get_red( _col ),
color_get_green( _col ),
color_get_blue( _col )
];

is_player_on

Checks whether the player slot is active or not.

ArgumentTypeDescription
setting:realThe player slot to check. Must be between 1 and 4.

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

//This code adds to a total player count in obj_stage_main for every active player in the match.
if ( player_is_on( player ) ) {
other.total_player_count += 1;
}

is_special_pressed

Returns whether the special button is pressed while also taking the right stick into account if it’s set to Special.

ArgumentTypeDescription
dir:realThe direction to check.

Indexes Reference

Example, called from attack_update.gml:

//This code triggers another attack if the player inputs a DSPECIAL during a certain portion of USPECIAL.
if ( attack == AT_USPECIAL && window == 4 && is_special_pressed( DIR_DOWN ) ) {
set_attack( AT_USPECIAL_2 );
}