This function checks to see if an account is a guest account. A guest account is an account automatically created for a user when they join the server and deleted when they quit or login to another account. Data stored in a guest account is not stored after the player has left the server. As a consequence, this function will check if a player is logged in or not.

OOP Syntax Help! I don't understand this!

• Method: account:isGuest(...)
• Variable: .guest

Syntax

bool isGuestAccount ( account theAccount )

Required Arguments

• theAccount: The account you want to check to see if it is a guest account.

Returns

• bool: result

Returns true if the account is a guest account, false otherwise.

Code Examples

Example 1 Example 2 (OOP)

server

This example shows how you could create a call_admin function that only could be run by registered users.

function callAdmin ( playerSource )
    -- get the account of the user trying to use this function first
    local sourceAccount = getPlayerAccount ( playerSource )
    -- if they're a guest
    if isGuestAccount ( sourceAccount ) then
        -- tell them to register
        outputConsole ( "Please register to use this function!", playerSource )
    else
        -- your code to call the admin would go here
    end
end
-- attach the function 'callAdmin' as a handler to the command "call_admin"
addCommandHandler ( "call_admin", callAdmin )

server

OOP Required

This example shows how you could create a call_admin function that only could be run by registered users.

function callAdmin ( playerSource )
    -- get the account of the user trying to use this function first
    local sourceAccount = playerSource.account
    -- if they're a guest
    if sourceAccount.guest then
        -- tell them to register
        outputConsole ( "Please register to use this function!", playerSource )
    else
        -- your code to call the admin would go here
    end
end
-- attach the function 'callAdmin' as a handler to the command "call_admin"
addCommandHandler ( "call_admin", callAdmin )

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