PlayerExitCheckpoint: Difference between revisions

From RAGE Multiplayer Wiki
m (category)
No edit summary
Line 1: Line 1:
Event triggered when a player leaves a checkpoint
{{ServersideCsJsEvent}}
{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerExitCheckpoint on GTA Network Wiki].
}}
{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add("playerExitCheckpoint", eventHandler);
</syntaxhighlight>
'''eventHandler''' expects a function with:
{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] who exited checkpoint.
* '''checkpoint''': {{RageType|Checkpoint}} The [[:Category:Checkpoint API|checkpoint]] that player exited.
{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerExitCheckpoint", (player, checkpoint) => {
// Do what you want.
});
</syntaxhighlight>
}}
{{ClientsideCsJsEvent}}
{{ClientsideCsJsEvent}}
Event triggered when a player leaves a checkpoint


{{CSharpContainer|
{{CSharpContainer|
Line 14: Line 38:
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.


<syntaxhighlight lang="c#">
<syntaxhighlight lang="csharp">
Events.OnPlayerExitCheckpoint += OnPlayerExitCheckpoint;
Events.OnPlayerExitCheckpoint += OnPlayerExitCheckpoint;
</syntaxhighlight>
</syntaxhighlight>
<syntaxhighlight lang="c#">
<syntaxhighlight lang="csharp">
public void OnPlayerExitCheckpoint(RAGE.Elements.Checkpoint checkpoint, RAGE.Events.CancelEventArgs cancel)
public void OnPlayerExitCheckpoint(RAGE.Elements.Checkpoint checkpoint, RAGE.Events.CancelEventArgs cancel)
{
{
Line 28: Line 52:
{{JSContainer|
{{JSContainer|
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.events.add("playerExitCheckpoint", (player, checkpoint) => {});
mp.events.add("playerExitCheckpoint", (checkpoint) => {});
</syntaxhighlight>
</syntaxhighlight>


{{Parameters}}
{{Parameters}}
* '''player'''
* '''checkpoint''': {{RageType|Checkpoint}}
* '''checkpoint'''


{{Example}}
{{Example}}
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.events.add("playerExitCheckpoint", (player, checkpoint) => {
mp.events.add("playerExitCheckpoint", (checkpoint) => {
  // Do what you want.
  // Do what you want.
});
});

Revision as of 12:33, 23 May 2019

Event triggered when a player leaves a checkpoint

Server-Side
Event

 C#  JavaScript



C# Syntax


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#  JavaScript



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.
});