Set the player character's model for the stage.

Scope

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

Syntax

SetStageCharacterModel( model, [animation_set] );

Game.SetStageCharacterModel( model, [animation_set] )

• model: The character model to use.
• animation_set: The animation set to use.
  • Optional, defaults to the current player character's animation set as of 1.19.
  • Using anything else can cause issues.

Examples

AddStage();
    // Switch to Homer's Muumuu costume for the stage.
	SetStageCharacterModel("h_fat");

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

Game.AddStage()
    -- Switch to Homer's Muumuu costume for the stage.
	Game.SetStageCharacterModel("h_fat")

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

Notes

No additional notes.

Version History

Version 1.19

Updated to default the second argument to SetStageCharacterModel to default the player's current animation set instead of requiring the argument.

Version 1.18.1

Fixed an issue where calling SetStageCharacterModel in a stage that also calls RESET_TO_HERE that is preceded by another stage that calls this command (with the same model and animation set) didn't work.