Pair: logIn

This function logs the given player out of his current account.

OOP Syntax Help! I don't understand this!

• Method: player:logOut(...)

Syntax

bool logOut ( player thePlayer )

Required Arguments

• thePlayer: The player to log out of his current account.

Returns

• bool: result

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.

Code Examples

Example 1 Example 2 (OOP)

server

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 screen onClientResourceStart.

function logoutAll ()
    local players = getElementsByType ( "player" ) -- Get every player
    for k, player in ipairs ( players ) do -- For every player do the following...
        local 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(), logoutAll )

server

OOP Required

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 screen onClientResourceStart.

function logoutAll ()
    local players = Element.getAllByType ( "player" ) -- Get every player
    for k, player in ipairs ( players ) do -- For every player do the following...
        local account = player.account -- Get every player's account
        if ( not account.guest ) then -- For every player that's logged in....
            player:logOut ( ) -- Log them out.
        end
    end
end
 -- Trigger it when the resource (re)starts
addEventHandler ( "onResourceStart", getResourceRootElement(), logoutAll )

See Also

Account Functions

• addAccount
• copyAccountData
• getAccountByID
• getAccount
• getAccountData
• getAccountID
• getAccountIP
• getAccountName
• getAccountPlayer
• getAccountSerial
• getAccountType
• getAccounts
• getAccountsByData
• getAccountsByIP
• getAccountsBySerial
• getAllAccountData
• getPlayerAccount
• isGuestAccount
• logIn
• removeAccount
• logOut
• setAccountData
• setAccountName
• setAccountPassword
• setAccountSerial

Account Events

• onAccountCreate
• onAccountDataChange
• onAccountRemove

Account Elements

• account

Reference

• Scripting Functions