OnPlayerJoined: Difference between revisions
Jump to navigation
Jump to search
(Since the event doesn't exist client-side, I made it server-side only. I also added an example) |
No edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{ScriptItem2 | ||
| | |name = OnPlayerJoined | ||
|side = server | |||
|type = event | |type = event | ||
| | |games = iii vc sa iv | ||
| | |desc = a player has connected to the server | ||
| | |arg1 = Client client The client that has connected to the server. | ||
|note = {{Shared/PlayerConnectionEvents}} | |||
|cancel = false | |||
| | |exampleJS = addEventHandler('OnPlayerJoined', (event, client) => { | ||
| | |||
addEventHandler('OnPlayerJoined', (event, client) => { | |||
messageClient(`Hello ${client.name}, welcome to my server! 👋`, client, COLOUR_YELLOW); | messageClient(`Hello ${client.name}, welcome to my server! 👋`, client, COLOUR_YELLOW); | ||
}); | }); | ||
|exampleLua = addEventHandler('OnPlayerJoined', function(event, client) | |||
messageClient('Hello ' .. client.name .. ', welcome to my server! 👋', client, COLOUR_YELLOW) | |||
end) | |||
}} | }} | ||
Latest revision as of 12:29, 2 September 2023
Event Server Only 
Online and Offline Not Cancellable
Available since Server 1.0.0
OnPlayerJoined(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:
Examples
Example 1 - JavaScript:
addEventHandler('OnPlayerJoined', (event, client) => {
messageClient(`Hello ${client.name}, welcome to my server! 👋`, client, COLOUR_YELLOW);
});
Example 2 - Lua:
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