PlayerSpawn: Difference between revisions

From RAGE Multiplayer Wiki
(Created page with "This event is triggered when a player spawns. ==Parameters== * '''player''' - player, which has spawned ==Example== This example outputs a console chat message, when a playe...")
 
No edit summary
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
This event is triggered when a player spawns.
This event is triggered when a player spawns.


==Parameters==
{{ServersideCsJsEvent}}
* '''player''' - player, which has spawned


==Example==
{{CSharpContainer|1=
See [[OnPlayerSpawn]].
}}
 
{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which has spawned
 
{{Example}}
This example outputs a console chat message, when a player spawns.
This example outputs a console chat message, when a player spawns.
<syntaxhighlight lang="javascript">
<pre>
   function playerSpawn(player) {
   function playerSpawn(player) {
     console.log(player.name + " has spawned");
     console.log(`${player.name} has spawned`);
   }
   }


   mp.events.add("playerSpawn", playerSpawn);
   mp.events.add("playerSpawn", playerSpawn);
</pre>
}}
{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerSpawnDelegate(CancelEventArgs cancel);
</syntaxhighlight>
</syntaxhighlight>
{{Parameters}}
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.
{{Example}}
The example below shows a chat message to the client when they spawn.
<syntaxhighlight lang="csharp">
Events.OnPlayerSpawn += OnPlayerSpawn;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerSpawn(RAGE.Events.CancelEventArgs cancel)
{
    RAGE.Chat.Output($"You just spawned");
}
</syntaxhighlight>
}}
{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which has spawned (always the same as mp.players.local, only works with local player)
{{Example}}
This example outputs a console chat message to the client when they spawns.
<pre>
mp.events.add("playerSpawn", (player) => {
    mp.gui.chat.push("Hey " + player.name + ", you just spawned");
});
</pre>
}}


==See also==
==See also==
[[Category:Player Events API]]
{{Player_events}}
 
[[Category:Player]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

Latest revision as of 19:02, 15 May 2024

This event is triggered when a player spawns.

Server-Side
Event

 C#  JavaScript




C# Syntax


JavaScript Syntax

Parameters

  • player: Player - player, which has spawned

Example

This example outputs a console chat message, when a player spawns. 

  function playerSpawn(player) {
    console.log(`${player.name} has spawned`);
  }

  mp.events.add("playerSpawn", playerSpawn);


Client-Side Event

 C#  JavaScript



C# Syntax

public delegate void OnPlayerSpawnDelegate(CancelEventArgs cancel);

Parameters

  • cancel: cancel, expects RAGE.Events.CancelEventArgs type.

Example

The example below shows a chat message to the client when they spawn. 

Events.OnPlayerSpawn += OnPlayerSpawn;

public void OnPlayerSpawn(RAGE.Events.CancelEventArgs cancel)
{
     RAGE.Chat.Output($"You just spawned");
}


JavaScript Syntax

Parameters

  • player: Player - player, which has spawned (always the same as mp.players.local, only works with local player)

Example

This example outputs a console chat message to the client when they spawns. 

mp.events.add("playerSpawn", (player) => {
     mp.gui.chat.push("Hey " + player.name + ", you just spawned");
});


See also

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint

Retrieved from "https://wiki.rage.mp/w/index.php?title=PlayerSpawn&oldid=25462"