OnClientLogout: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Changed "DeprecatedWithAlt" template to "Deprecated") |
||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Server event}} | {{Server event}} | ||
{{Deprecated|onPlayerLogout|}} | |||
This event is triggered when a user logs out of their account in-game. | This event is triggered when a user logs out of their account in-game. | ||
== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
account thePreviousAccount, account theCurrentAccount | account thePreviousAccount, account theCurrentAccount | ||
| Line 10: | Line 12: | ||
*'''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 client [[element]] that logged out. For example a player. | |||
==Example== | ==Example== | ||
This example | This example displays a message if the client logs out. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function loggedOut() | |||
outputChatBox( "You have successfully logged out!", source ) | |||
end | |||
addEventHandler("onClientLogout",getRootElement(),loggedOut) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Client events}} | |||
Latest revision as of 16:21, 13 February 2015
|
This event is deprecated. This means that its use is discouraged and that it might not exist in future versions. |
Please use onPlayerLogout instead. |
This event is triggered when a user logs out of their account in-game.
Parameters
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)
Source
The source of this event is the client element that logged out. For example a player.
Example
This example displays a message if the client logs out.
function loggedOut()
outputChatBox( "You have successfully logged out!", source )
end
addEventHandler("onClientLogout",getRootElement(),loggedOut)
See Also
Client events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getCancelReason
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerClientEvent
- triggerLatentClientEvent
- wasEventCancelled