IsGuestAccount: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (10 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
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. | {{Server function}} | ||
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. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool isGuestAccount ( account theAccount ) | bool isGuestAccount ( account theAccount ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[account]]:isGuest|guest|}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theAccount:''' The account you want to check to see if it is a guest account. | *'''theAccount:''' The account you want to check to see if it is a guest account. | ||
| Line 16: | Line 17: | ||
This example shows how you could create a ''call_admin'' function that only could be run by registered users. | This example shows how you could create a ''call_admin'' function that only could be run by registered users. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function callAdmin ( playerSource ) | |||
function callAdmin ( playerSource | -- get the account of the user trying to use this function first | ||
sourceAccount = getPlayerAccount ( playerSource ) | |||
-- if they're a guest | |||
outputConsole ( "Please register to use this function!", playerSource ) | if isGuestAccount ( sourceAccount ) then | ||
-- tell them to register | |||
outputConsole ( "Please register to use this function!", playerSource ) | |||
else | else | ||
-- | -- your code to call the admin would go here | ||
end | end | ||
end | end | ||
-- attach the function 'callAdmin' as a handler to the command "call_admin" | |||
addCommandHandler ( "call_admin", callAdmin ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Account_functions}} | {{Account_functions}} | ||
[[en:isGuestAccount]] | |||
[[ru:isGuestAccount]] | |||
[[ar:isGuestAccount]] | |||
[[zh-cn:isGuestAccount]] | |||
Latest revision as of 14:49, 11 April 2021
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.
Syntax
bool isGuestAccount ( account theAccount )
OOP Syntax Help! I don't understand this!
- Method: account:isGuest(...)
- Variable: .guest
Required Arguments
- theAccount: The account you want to check to see if it is a guest account.
Returns
Returns true if the account is a guest account, false otherwise.
Example
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
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 )
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