DisablePlayerCheckpoint
Description:
Function DisablePlayerCheckpoint disables (hides/destroys) a player's set checkpoint. Players can only have a single checkpoint set at a time. Checkpoints don't need to be disabled before setting another one.
Parameters:
(playerid)
int | playerid | The ID of the player whose checkpoint to disable. |
Return Values:
- 1: The function was executed successfully. Success is also returned if the player doesn't have a checkpoint shown already.
- 0: The function failed to execute. This means the player is not connected.
Examples:
public OnPlayerEnterCheckpoint(playerid) { GivePlayerMoney(playerid, 10000); DisablePlayerCheckpoint(playerid); return 1; }
Related Functions
The following functions may be useful, as they are related to this function in one way or another.
- SetPlayerCheckpoint: Create a checkpoint for a player.
- IsPlayerInCheckpoint: Check if a player is in a checkpoint.
- SetPlayerRaceCheckpoint: Create a race checkpoint for a player.
- IsPlayerInRaceCheckpoint: Check if a player is in a race checkpoint.
- DisablePlayerRaceCheckpoint: Disable the player's current race checkpoint.
Related Callbacks
The following callbacks might be useful as well, as they are related to this callback in one way or another.
- OnPlayerEnterCheckpoint: Called when a player enters a checkpoint.
- OnPlayerLeaveCheckpoint: Called when a player leaves a checkpoint.
- OnPlayerEnterRaceCheckpoint: Called when a player enters a race checkpoint.
- OnPlayerLeaveRaceCheckpoint: Called when a player leaves a race checkpoint.