This command adds a checkpoint to a stage.

Scope

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

Syntax

CHECKPOINT_HERE();

Game.CHECKPOINT_HERE()

Examples

AddStage();
	CHECKPOINT_HERE();

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

Game.AddStage()
	Game.CHECKPOINT_HERE()

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

Notes

Where the player spawns, the ped group, the traffic group and more can be configured when a stage is resumed from a checkpoint with the following commands:

• SetCheckpointDynaLoadData
• SetCheckpointPedGroup
• SetCheckpointResetPlayerInCar
• SetCheckpointResetPlayerOutCar
• SetCheckpointTrafficGroup

Any parameters set with those commands also affect the defaults for subsequent checkpoints.

Furthermore, you can also use the IfCurrentCheckpoint conditional command to only execute certain commands when resuming from a checkpoint.

What checkpoint is resumed from when failing or restarting is remembered by its index. So if you reached the second checkpoint, you will resume from the second checkpoint regardless of if its on the same stage.