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.
Argument | Type | Description |
---|---|---|
volume | :real | [optional] The target music volume, with a range of 0 to 1. |
amount_per_frame | :real | [optional] Determines how much the volume decrements or increments per frame, with a range of 0 to 1. |
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 );