PlayerEnterCheckpoint: Difference between revisions
m (Fixed spelling mistake) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{ | {{ClientsideCsJsEvent}} | ||
Event triggered when a player enters into a checkpoint | Event triggered when a player enters into a checkpoint | ||
{{CSharpContainer| | |||
{{ | |||
<pre> | <pre> | ||
public delegate void OnPlayerEnterCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel); | public delegate void OnPlayerEnterCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel); | ||
</pre> | </pre> | ||
{{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. | The example below shows a message to player with the position of the checkpoint they entered. | ||
| Line 27: | Line 24: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | |||
{{JSContainer| | |||
{{ | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {}); | mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {}); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{Parameters}} | |||
* '''checkpoint''' The checkpoint, expects | * '''checkpoint''' The checkpoint, expects '''any''' type. | ||
{{Example}} | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => { | mp.events.add("playerEnterCheckpoint", (player, checkpoint) => { | ||
| Line 43: | Line 40: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | |||
Revision as of 16:07, 27 November 2018
Client-Side Event
Event triggered when a player enters into a checkpoint
C# Syntax
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
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {});
Parameters
- checkpoint The checkpoint, expects any type.
Example
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {
// Do what you want.
});