GetAccount: Difference between revisions
Jump to navigation
Jump to search
(Added incomplete page (syntax only)) |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function returns an account for a specific user. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 8: | Line 8: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''username:''' | *'''username:''' The username of the account you want to retrieve | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''password:''' | *'''password:''' The password for the account. If this argument is not specified, you can get the account whatever password it is, otherwise the password must match the account's. | ||
===Returns=== | ===Returns=== | ||
An ''account'' value or ''false'' if an account matching the username specified (and password, if specified) could not be found. | |||
==Example== | ==Example== | ||
| Line 21: | Line 22: | ||
==See Also== | ==See Also== | ||
{{Account functions}} | {{Account functions}} | ||
Revision as of 05:27, 1 January 2008
This function returns an account for a specific user.
Syntax
account getAccount ( string username, [ string password ] )
Required Arguments
- username: The username of the account you want to retrieve
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- password: The password for the account. If this argument is not specified, you can get the account whatever password it is, otherwise the password must match the account's.
Returns
An account value or false if an account matching the username specified (and password, if specified) could not be found.
Example
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