PlayerEnterCheckpoint

From RAGE Multiplayer Wiki
Jump to navigation Jump to search

Event triggered when a player enters into a checkpoint

Server-Side
Event

C.png C# Js.png JavaScript



C# Syntax
C.png


JavaScript Syntax
Jslogo.png

mp.events.add("playerEnterCheckpoint", eventHandler);

eventHandler expects function with:

Parameters

  • player: Player - The player who entered checkpoint.
  • checkpoint: Checkpoint - The checkpoint that player entered.

Example

mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {
 // Do what you want.
});


Client-Side Event

C.png C# Js.png JavaScript


C# Syntax
C.png

public delegate void OnPlayerEnterCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel);

Parameters

  • checkpoint: checkpoint, expects RAGE.Elements.Checkpoint type.
  • cancel: cancel, expects RAGE.Events.CancelEventArgs type.

Example

The example below shows a message to player with the position of the checkpoint they entered.

Events.OnPlayerEnterCheckpoint += OnPlayerEnterCheckpoint;
public void OnPlayerEnterCheckpoint(RAGE.Elements.Checkpoint checkpoint, RAGE.Events.CancelEventArgs cancel)
{
    Vector3 pos = checkpoint.Position;
    RAGE.Chat.Output($"Player just entered the checkpoint at X{pos.X} Y{pos.Y} Z{pos.Z}");
}


JavaScript Syntax
Jslogo.png

Parameters

  • checkpoint: Checkpoint The checkpoint.

Example

mp.events.add("playerEnterCheckpoint", (checkpoint) => {
 // Do what you want.
});


See also