Documentation
Accounts

Accounts

All Lua functions and events in the Accounts category, on the server and the client.

Server functions 24

addAccountCreates a new account on the server. The password is stored as a secure hash, never in plain text.
copyAccountDataCopies all data from one account to another.
getAccountReturns the account with the given name. With a password it returns false when the password does not match.
getAccountByIDReturns the account with the given number (getAccountID).
getAccountDataReturns account data stored under a key. Account data is persistent: it stays after the player leaves and after a server restart.
getAccountIDReturns the account's permanent number. Assigned on the first request and never changes afterwards.
getAccountIPReturns the IP address remembered at the last login.
getAccountNameReturns the account name.
getAccountPlayerReturns the player logged into this account. An account can be logged in by only one player at a time.
getAccountsReturns all accounts on the server.
getAccountsByDataReturns the accounts whose data under a key equals the given value.
getAccountsByIPReturns the accounts last used from the given IP address.
getAccountsBySerialReturns the accounts used from the given Client ID.
getAccountSerialReturns the Client ID remembered when logging into this account.
getAccountTypeReturns the account type: "guest" (not logged in) or "player".
getAllAccountDataReturns all account data as a key-value table.
isGuestAccountChecks whether the account is a guest account, i.e. the player is not logged in.
logInLogs a player into an account. Fires onPlayerLogin. An account can be logged in by only one player at a time.
logOutLogs a player out of their account. Fires onPlayerLogout.
removeAccountDeletes an account together with its data.
setAccountDataStores account data under a key. The value is kept permanently (also after a server restart).
setAccountNameRenames an account, moving all its data.
setAccountPasswordChanges an account's password.
setAccountSerialStores the Client ID assigned to the account.

Server functions 24

Server events 3