PlayerExitCheckpoint: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 14: | Line 14: | ||
{{Parameters}} | {{Parameters}} | ||
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] who exited checkpoint. | * '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] who exited checkpoint. | ||
* '''checkpoint''': {{RageType|Checkpoint}} The [[:Category:Checkpoint API|checkpoint]] that player exited. | * '''checkpoint''': {{RageType|Checkpoint}} - The [[:Category:Checkpoint API|checkpoint]] that player exited. | ||
{{Example}} | {{Example}} | ||
Revision as of 12:34, 23 May 2019
Event triggered when a player leaves a checkpoint
Server-Side Event
C# Syntax
See on GTA Network Wiki.
JavaScript Syntax
mp.events.add("playerExitCheckpoint", eventHandler);
eventHandler expects a function with:
Parameters
- player: Player - The player who exited checkpoint.
- checkpoint: Checkpoint - The checkpoint that player exited.
Example
mp.events.add("playerExitCheckpoint", (player, checkpoint) => {
// Do what you want.
});
Client-Side Event
C# Syntax
public delegate void OnPlayerExitCheckpointDelegate(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 just exited.
Events.OnPlayerExitCheckpoint += OnPlayerExitCheckpoint;
public void OnPlayerExitCheckpoint(RAGE.Elements.Checkpoint checkpoint, RAGE.Events.CancelEventArgs cancel)
{
Vector3 pos = checkpoint.Position;
RAGE.Chat.Output($"Player just left the checkpoint at X{pos.X} Y{pos.Y} Z{pos.Z}");
}
JavaScript Syntax
mp.events.add("playerExitCheckpoint", (checkpoint) => {});
Parameters
- checkpoint: Checkpoint
Example
mp.events.add("playerExitCheckpoint", (checkpoint) => {
// Do what you want.
});