Triggers a mission music event upon reaching a stage.

Scope

This command should be called between calls to AddStage and CloseStage in a mission's initialisation script.

Syntax

StageStartMusicEvent( event );

Game.StageStartMusicEvent( event )

• event: The name of a music event.

Examples

AddStage();
	AddObjective("dummy");
	CloseObjective();

	StageStartMusicEvent("M3_drama");
CloseStage();

Game.AddStage()
	Game.AddObjective("dummy")
	Game.CloseObjective()

	Game.StageStartMusicEvent("M3_drama")
Game.CloseStage()

Notes

This command causes the game to trigger the CHANGE_MUSIC Event, which itself can only actually trigger a limited subset of all available music events.

Substituting "X" for a number from 0 to 7, this command can trigger the following events:

• MX_start
• MX_drama
• MX_win
• MX_lose
• MX_get_out_of_car
• MX_10sec_to_go

As well as these events:

• Bonus_start
• Bonus_drama
• Bonus_win
• Bonus_lose
• Bonus_get_out_of_car
• Bonus_10sec_to_go

For a command that can trigger any music event, use the SetStageMusicEvent command provided by the Additional Script Functionality hack.