PlayerExitCheckpoint: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{ | {{ClientsideCsJsEvent}} | ||
Event triggered when a player leaves a checkpoint | Event triggered when a player leaves a checkpoint | ||
{{CSharpContainer| | |||
{{ | |||
<pre> | <pre> | ||
public delegate void OnPlayerExitCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel); | public delegate void OnPlayerExitCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel); | ||
</pre> | </pre> | ||
{{Parameters}} | |||
* '''checkpoint''': checkpoint, expects | * '''checkpoint''': checkpoint, expects '''RAGE.Elements.Checkpoint''' type. | ||
* '''cancel''': cancel, expects | * '''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. | The example below shows a message to player with the position of the checkpoint they just exited. | ||
| Line 27: | Line 24: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | |||
{{JSContainer| | |||
{{ | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
mp.events.add("playerExitCheckpoint", (player, checkpoint) => {}); | mp.events.add("playerExitCheckpoint", (player, checkpoint) => {}); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{Parameters}} | |||
* '''player''' | * '''player''' | ||
* '''checkpoint''' | * '''checkpoint''' | ||
{{Example}} | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
mp.events.add("playerExitCheckpoint", (player, checkpoint) => { | mp.events.add("playerExitCheckpoint", (player, checkpoint) => { | ||
| Line 45: | Line 41: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | |||
Revision as of 16:10, 27 November 2018
Client-Side Event
Event triggered when a player leaves a checkpoint
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", (player, checkpoint) => {});
Parameters
- player
- checkpoint
Example
mp.events.add("playerExitCheckpoint", (player, checkpoint) => {
// Do what you want.
});