OnPlayerJoined: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
|endpoint = server | |endpoint = server | ||
|type = event | |type = event | ||
|name = | |name = OnPlayerJoined | ||
|usage = a player has connected to the server | |usage = a player has connected to the server | ||
|callbackParameters = Event event, Client client | |callbackParameters = Event event, Client client |
Revision as of 11:27, 13 August 2021
Event
Server Only
Online and Offline
Not Cancellable
Available since Server 1.0.0
function(Event event, Client client)
The OnPlayerJoined event is invoked when a player has connected to the server.
Parameters
1) | Event | event | The event object for this event. |
2) | Client | client | The client that has connected to the server. |
Attributes
const | This event cannot be cancelled. |
Notes
- The chronological order of player connection events are:.
- OnPlayerConnect.
- OnPlayerJoin.
- OnPlayerJoined.
Examples
Example 1 - JavaScript - Server-Side:
addEventHandler('OnPlayerJoined', (event, client) => { messageClient(`Hello ${client.name}, welcome to my server! 👋`, client, COLOUR_YELLOW); });
Example 2 - Lua - Server-Side:
addEventHandler('OnPlayerJoined', function(event, client) messageClient('Hello ' .. client.name .. ', welcome to my server! 👋', client, COLOUR_YELLOW) end)
Compatibility
There isn't any compatibility information for this event.
Related
Server Related
OnPlayerChat
OnPlayerCommand
OnPlayerConnect
OnPlayerJoin
OnPlayerJoined
OnPlayerQuit