PlayerEnterCheckpoint: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
Line 1: Line 1:
{{ClientSide}}
Event triggered when a player enters into a checkpoint
Event triggered when a player enters into a checkpoint
== C# Syntax ==
{{CSharp|
<pre>
public delegate void OnPlayerEnterCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel);
</pre>
}}
=== Parameters ===
* '''checkpoint''': checkpoint, expects <span style="color: #408DAE"><b>RAGE.Elements.Checkpoint</b></span> type.
* '''cancel''': cancel, expects <span style="color: #408DAE"><b>RAGE.Events.CancelEventArgs</b></span> type.
=== Examples ===
The example below shows a message to player with the position of the checkpoint they entered.
<syntaxhighlight lang="c#">
Events.OnPlayerEnterCheckpoint += OnPlayerEnterCheckpoint;
</syntaxhighlight>
<syntaxhighlight lang="c#">
public void OnPlayerEnterCheckpoint(RAGE.Elements.Checkpoint checkpoint, RAGE.Events.CancelEventArgs cancel)
{
    Vector3 pos = checkpoint.Position;
    RAGE.Chat.Output($"Player just entered the checpoint at X{pos.X} Y{pos.Y} Z{pos.Z} ");
}
</syntaxhighlight>


== JavaScript Syntax ==
== JavaScript Syntax ==

Revision as of 23:31, 26 November 2018

Client-Side

Event triggered when a player enters into a checkpoint

C# Syntax

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

Parameters

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

Examples

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 checpoint at X{pos.X} Y{pos.Y} Z{pos.Z} ");
}

JavaScript Syntax

JavaScript
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {});

Parameters

  • checkpoint The checkpoint, expects any type.

Example

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