OnClientPlayerJoin: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (not cancellable)
 
(15 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
This event is when a player joins.
{{Client event}}
This event is triggered when a [[player]] joins a server. It is triggered for all players except the local player, as the local player joins the server before their client-side resources are started. It would also be possible for two players to join within a few seconds of each other and for the two players' scripts may not receive onClientPlayerJoin events as their scripts wouldn't have started yet.


==Syntax==  
This event is not cancellable.
<syntaxhighlight lang="lua">
 
void onClientPlayerJoin ( void )
==Parameters==
</syntaxhighlight>
''None''
 
==Source==
The [[event system#Event source|source]] of this event is the [[player]] that joined the server.


==Example==  
==Example==
This example does...
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onPlayerJoin () --When the player joins
function remotePlayerJoin()
showTextForPlayer ( source, 5000, 0, 0, 180, 1.5, "We be gangstas!" ) --Shows text for the player
outputChatBox("* " .. getPlayerName(source) .. " has joined the server")
end
end
addEventHandler ( "onPlayerJoin", root, onPlayerJoin ) --Event is triggered
addEventHandler("onClientPlayerJoin", getRootElement(), remotePlayerJoin)
</syntaxhighlight>
</syntaxhighlight>
==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

Latest revision as of 05:14, 6 June 2019

This event is triggered when a player joins a server. It is triggered for all players except the local player, as the local player joins the server before their client-side resources are started. It would also be possible for two players to join within a few seconds of each other and for the two players' scripts may not receive onClientPlayerJoin events as their scripts wouldn't have started yet.

This event is not cancellable.

Parameters

None

Source

The source of this event is the player that joined the server.

Example

function remotePlayerJoin()
	outputChatBox("* " .. getPlayerName(source) .. " has joined the server")
end
addEventHandler("onClientPlayerJoin", getRootElement(), remotePlayerJoin)

See Also

Client player events


Client event functions