PlayerEnterCheckpoint: Difference between revisions

From RAGE Multiplayer Wiki
m (Fixed spelling mistake)
No edit summary
 
(8 intermediate revisions by 4 users not shown)
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 ==
{{ServersideCsJsEvent}}
{{CSharp|
{{CSharpContainer|1=
See [[OnPlayerEnterCheckpoint]].
}}
 
{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", eventHandler);
</syntaxhighlight>
'''eventHandler''' expects function with:
 
{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] who entered checkpoint.
* '''checkpoint''': {{RageType|Checkpoint}} - The [[:Category:Checkpoint API|checkpoint]] that player entered.
 
{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {
// Do what you want.
});
</syntaxhighlight>
}}
 
{{ClientsideCsJsEvent}}
{{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 <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 ===
{{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 47:
}
}
</syntaxhighlight>
</syntaxhighlight>
}}


== JavaScript Syntax ==
{{JSContainer|
{{JS}}
{{Parameters}}
<syntaxhighlight lang="javascript">
* '''checkpoint''': {{RageType|Checkpoint}} The checkpoint.
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {});
</syntaxhighlight>


==Parameters==
{{Example}}
* '''checkpoint''' The checkpoint, expects <span style="color: #408DAE"><b>any</b></span> type.
 
==Example==
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {
mp.events.add("playerEnterCheckpoint", (checkpoint) => {
  // Do what you want.
  // Do what you want.
});
});
</syntaxhighlight>
</syntaxhighlight>
}}
== See also ==
* [[playerExitCheckpoint]]
[[Category:Player]]
[[Category:Checkpoint]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

Latest revision as of 12:03, 1 May 2024

Event triggered when a player enters into a checkpoint

Server-Side
Event

 C#  JavaScript



C# Syntax


JavaScript Syntax

mp.events.add("playerEnterCheckpoint", eventHandler);

eventHandler expects function with:

Parameters

  • player: Player - The player who entered checkpoint.
  • checkpoint: Checkpoint - The checkpoint that player entered.

Example

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


Client-Side Event

 C#  JavaScript


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

Parameters

  • checkpoint: Checkpoint The checkpoint.

Example

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


See also