This command sets the stage objective text message index to use.

Context

This command should be called between calls to AddStage and CloseStage.

Syntax

SetStageMessageIndex( index );

Game.SetStageMessageIndex( index )

• index: The index to use. Valid values are from 0-299.
  • This uses the text strings that begin with MISSION_OBJECTIVE_ out of the text bible and Custom Text configuration files.

Examples

AddStage();
    SetStageMessageIndex(174);

    AddObjective("dummy");
    CloseObjective();
CloseStage();

Game.AddStage()
    Game.SetStageMessageIndex(174)

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

Notes

When used in locked stages, this command uses the text strings that begin with INGAME_MESSAGE_ out of the text bible and Custom Text configuration files.

• Starting a locked stage will update the HUD icon, but the MISSION_OBJECTIVE_ will only appear if the player pauses.
• A stage using SetIrisWipe will play the audio cue, but omit the INGAME_MESSAGE_ popup.