OnPlayerLogout: Difference between revisions

Latest revision as of 03:01, 27 September 2018

This event is triggered when a user logs out of their account in-game.

account thePreviousAccount, account theCurrentAccount

thePreviousAccount: the account the client was logged in as.
theCurrentAccount: the account the client is a part of now (usually a guest account).

The source of this event is the player that logged out.

If you cancel this event the player will not be logged out.

This example displays a message if the player logs out.

function loggedOut()
	outputChatBox( "You have successfully logged out!", source )
end
addEventHandler("onPlayerLogout",getRootElement(),loggedOut)

@@ Line 8: / Line 8: @@
 </syntaxhighlight>
-*'''thePreviousAccount''': The account the client was logged in as
+*'''thePreviousAccount''': the [[account]] the client was logged in as.
-*'''theCurrentAccount''': The account the client is a part of now (usually a guest account)
+*'''theCurrentAccount''': the [[account]] the client is a part of now (usually a guest account).
 ==Source==
 The [[event system#Event source|source]] of this event is the player that logged out.
+==Cancel effect==
+If you cancel this event the player will not be logged out.
 ==Example==
@@ Line 23: / Line 26: @@
 </syntaxhighlight>
-{{See also/Server event|Client events}}
+{{See also/Server event|Player events}}