PlayerExitCheckpoint: Difference between revisions

From RAGE Multiplayer Wiki
mNo edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
Event triggered when a player leaves a checkpoint
Event triggered when a player leaves a checkpoint
{{ServersideCsJsEvent}}
{{CSharpContainer|
{{#tag:syntaxhighlight|
[ServerEvent(Event.PlayerExitCheckpoint)]
|lang=csharp
}}


{{ServersideCsJsEvent}}
{{Parameters}}
{{CSharpContainer|1=
*'''checkpoint:''' parameter input should be in '''Checkpoint''' type
See [https://wiki.gtanet.work/index.php?title=OnPlayerExitCheckpoint on GTA Network Wiki].
*'''player:''' parameter input should be in '''Player''' type
 
{{Example}}
{{#tag:syntaxhighlight|
[ServerEvent(Event.PlayerExitCheckpoint)]
public void OnPlayerExitCheckpoint(Checkpoint checkpoint, Player player)
{
player.SendChatMessage($"You exited checkpoint: {checkpoint.Id}.");
}
|lang=csharp}}
}}
}}


Line 51: Line 66:


{{JSContainer|
{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add("playerExitCheckpoint", (checkpoint) => {});
</syntaxhighlight>
{{Parameters}}
{{Parameters}}
* '''checkpoint''': {{RageType|Checkpoint}}
* '''checkpoint''': {{RageType|Checkpoint}}
Line 66: Line 77:
}}
}}


 
== See also ==
[[Category:Player]]
[[Category:Checkpoint]]
[[Category:Checkpoint]]
[[Category:Serverside Events]]
[[Category:Server-side Event]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]
[[Category:Client-side Event]]
* [[playerEnterCheckpoint]]

Latest revision as of 03:50, 25 April 2024

Event triggered when a player leaves a checkpoint

Server-Side
Event

 C#  JavaScript



C# Syntax

[ServerEvent(Event.PlayerExitCheckpoint)]

Parameters

  • checkpoint: parameter input should be in Checkpoint type
  • player: parameter input should be in Player type

Example

[ServerEvent(Event.PlayerExitCheckpoint)]
public void OnPlayerExitCheckpoint(Checkpoint checkpoint, Player player)
{
	player.SendChatMessage($"You exited checkpoint: {checkpoint.Id}.");
}


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

Parameters

  • checkpoint: Checkpoint

Example

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


See also