PlayerEnterCheckpoint: Difference between revisions
mNo edit summary |
No edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Event triggered when a player enters into a checkpoint | Event triggered when a player enters into a checkpoint | ||
{{ServersideCsJsEvent}} | |||
{{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| | {{CSharpContainer| | ||
<pre> | <pre> | ||
| Line 27: | Line 50: | ||
{{JSContainer| | {{JSContainer| | ||
{{Parameters}} | {{Parameters}} | ||
* '''checkpoint''' The checkpoint | * '''checkpoint''': {{RageType|Checkpoint}} The checkpoint. | ||
{{Example}} | {{Example}} | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
mp.events.add("playerEnterCheckpoint", ( | mp.events.add("playerEnterCheckpoint", (checkpoint) => { | ||
// Do what you want. | // Do what you want. | ||
}); | }); | ||
| Line 42: | Line 61: | ||
}} | }} | ||
== See also == | |||
* [[playerExitCheckpoint]] | |||
[[Category:Player]] | |||
[[Category:Checkpoint]] | [[Category:Checkpoint]] | ||
[[Category:Server-side Event]] | [[Category:Server-side Event]] | ||
[[Category:Client-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# 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# 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.
});