PlayerJoin: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
 
(16 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Shared}}
This event is triggered when a player '''joins''' the server.


This event is triggered when a player joins the server.
{{ServersideJsEvent}}


'''NOTE: ''' This event is not called for the local player who joined the server (when it's used in client-side).
{{CSharpContainer|1=
See [[OnPlayerConnected]].
}}


== Syntax ==
{{Parameters}}


{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - The player who joined.
{{Example}}
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.events.add('playerJoin', player => {
mp.events.add('playerJoin', (player) => {
     //do stuff here
     console.log(`[SERVER]: ${player.name} has joined the server!`);
});
});
</syntaxhighlight>
}}
{{ClientsideCsJsEvent}}
This event is '''not''' called for the '''local player''' who joined the server.
{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerJoinDelegate(Player player);
</syntaxhighlight>
</syntaxhighlight>


=== Attributes ===
{{Parameters}}
* '''player''': The player who joined.
* '''player''': The player joining the server, expects '''RAGE.Elements.Player''' type.


{{Example}}
The example below shows up a message to the client when another player joins the server.


== Examples ==
<syntaxhighlight lang="csharp">
Events.OnPlayerJoin += OnPlayerJoin;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerJoin(RAGE.Elements.Player player)
{
    RAGE.Chat.Output($"Player {player.Name} has joined");
}
</syntaxhighlight>
}}


This is a basic explanation about what does the example below do.
{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - Another player who joined the server.


{{Example}}
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.events.add('playerJoin', player => {
mp.events.add("playerJoin", (player) => {
     mp.gui.chat.push(`[SERVER]: ${player.name} has joined the server!`);
     mp.gui.chat.push(`${player.name} has joined the server!`);
});
});
</syntaxhighlight>
</syntaxhighlight>
}}
==See also==
{{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 joins the server.

Server-Side
Event

 JavaScript




C# Syntax


Parameters

JavaScript Syntax

Parameters

  • player: Player - The player who joined.

Example

mp.events.add('playerJoin', (player) => {
    console.log(`[SERVER]: ${player.name} has joined the server!`);
});


Client-Side Event

 C#  JavaScript


This event is not called for the local player who joined the server.


C# Syntax

public delegate void OnPlayerJoinDelegate(Player player);

Parameters

  • player: The player joining the server, expects RAGE.Elements.Player type.

Example

The example below shows up a message to the client when another player joins the server. 

Events.OnPlayerJoin += OnPlayerJoin;

public void OnPlayerJoin(RAGE.Elements.Player player)
{
    RAGE.Chat.Output($"Player {player.Name} has joined");
}


JavaScript Syntax

Parameters

  • player: Player - Another player who joined the server.

Example

mp.events.add("playerJoin", (player) => {
    mp.gui.chat.push(`${player.name} has joined the server!`);
});


See also

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint

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