OnClientPlayerQuit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(12 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
__NOTOC__
{{Client event}}
This event is triggered when a '''remote''' player quits the game or leaves the server. It '''will not''' get triggered on the source player's client. (Use [[onClientResourceStop]] to save client side data when the local player quits.)


__NOTOC__
==Parameters==
This event is blahblah and is used for blahblah.
 
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
oid onClientPlayerQuit ( string reason )
string reason
</syntaxhighlight>  
</syntaxhighlight>  
*'''reason''': A string representing the reason why the player quit.
** "Unknown"
** "Quit"
** "Kicked"
** "Banned"
** "Bad Connection"
** "Timed out"
==Source==
The [[event system#Event source|source]] of this event is the [[player]] that quit the game.


==Example==  
==Example==  
This example does...
This example prints a message in the chatbox when a remote player leaves the server.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function onQuitGame( reason )
blabhalbalhb --abababa
    outputChatBox ( getPlayerName( source ).." has left the server ("..reason..")" )
--This line does this...
end
mooo
addEventHandler( "onClientPlayerQuit", getRootElement(), onQuitGame )
</syntaxhighlight>
</syntaxhighlight>
==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

Latest revision as of 17:15, 23 August 2014

This event is triggered when a remote player quits the game or leaves the server. It will not get triggered on the source player's client. (Use onClientResourceStop to save client side data when the local player quits.)

Parameters

string reason
  • reason: A string representing the reason why the player quit.
    • "Unknown"
    • "Quit"
    • "Kicked"
    • "Banned"
    • "Bad Connection"
    • "Timed out"

Source

The source of this event is the player that quit the game.

Example

This example prints a message in the chatbox when a remote player leaves the server.

function onQuitGame( reason )
    outputChatBox ( getPlayerName( source ).." has left the server ("..reason..")" )
end
addEventHandler( "onClientPlayerQuit", getRootElement(), onQuitGame )

See Also

Client player events


Client event functions