LogOut: Difference between revisions
Jump to navigation
Jump to search
m (Removed "Needs example" category.) |
m (Added comments.) |
||
| Line 18: | Line 18: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function logoutAll () | function logoutAll () | ||
local players = getElementsByType ( "player" ) | local players = getElementsByType ( "player" ) -- Get every player | ||
for k, player in ipairs ( players ) do | for k, player in ipairs ( players ) do -- For every player do the follwing... | ||
account = getPlayerAccount ( player ) | account = getPlayerAccount ( player ) -- Get every player's account | ||
if ( not isGuestAccount ( account ) ) then | if ( not isGuestAccount ( account ) ) then -- For every player that's logged in.... | ||
logOut ( player ) | logOut ( player ) -- Log them out. | ||
end | end | ||
end | end | ||
end | end | ||
addEventHandler ( "onResourceStart", getResourceRootElement(getThisResource()), logoutAll ) | -- Trigger it when the resource (re)starts | ||
</syntaxhighlight> | addEventHandler ( "onResourceStart", getResourceRootElement(getThisResource()), logoutAll )</syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Account_functions}} | {{Account_functions}} | ||
Revision as of 18:59, 21 February 2010
This function logs the given player out of his current account.
Syntax
bool logOut ( player thePlayer )
Required Arguments
- thePlayer: The player to log out of his current account
Returns
Returns true if the player was successfully logged out, false or nil if it failed for some reason, ie. the player was never logged in.
Example
This example logs every player out of their account when the resource is (re)started. This would be handy for resources that show a login scren onClientResourceStart.
function logoutAll () local players = getElementsByType ( "player" ) -- Get every player for k, player in ipairs ( players ) do -- For every player do the follwing... account = getPlayerAccount ( player ) -- Get every player's account if ( not isGuestAccount ( account ) ) then -- For every player that's logged in.... logOut ( player ) -- Log them out. end end end -- Trigger it when the resource (re)starts addEventHandler ( "onResourceStart", getResourceRootElement(getThisResource()), logoutAll )
See Also
- addAccount
- copyAccountData
- getAccount
- getAccountData
- getAccountName
- getAccountPlayer
- getAccountSerial
- getAccounts
- getAccountsBySerial
- getAllAccountData
- getPlayerAccount
- isGuestAccount
- logIn
- logOut
- removeAccount
- setAccountData
- setAccountPassword
- getAccountByID
- getAccountID
- getAccountIP
- getAccountsByData
- getAccountsByIP
- setAccountName