Accounts

From SphereWiki

Player characters are attached to accounts. The account object can be referenced by using ACCOUNT.KEY from the character object or ACCOUNT.name_or_index.KEY from the server object. The following tables detail the various properties of accounts in SphereServer:

Contents 1 References 2 Properties and Functions

References

References return pointers to other objects (e.g. the CHAR.n reference allows you to access the characters that are attached to the account). These can either be accessed by using <REFNAME> to return the UID (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using <REFNAME.KEY> where KEY is a valid property/function/reference for the REFNAME object. Click on the name for more detailed information such as usage and examples.

Name	Read/Write	Description
CHAR.n	R	Gets the nth character attached to the account. (zero-based)

Properties and Functions

Here is a list of all account properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

Name	Read/Write	Description
ACCOUNT	R	Gets the name of the account.
BLOCK	RW	Gets or sets whether or the not the account is blocked.
CHARS	R	Gets how many characters are attached to the account.
CHATNAME	RW	Gets the name the account uses in chat.
FIRSTCONNECTDATE	RW	Gets the date and time on which the account first connected.
FIRSTIP	RW	Gets the IP address that the account first connected with.
GUEST	RW	Gets whether or not the account is a guest account.
JAIL	RW	Gets whether or not the account is jailed.
LANG	RW	Gets or sets the account's language.
LASTCHARUID	RW	Gets the UID of the last character used on the account.
LASTCONNECTDATE	RW	Gets the date and time on which the account most recently connected.
LASTIP	RW	Gets the IP address that the account most recently connected with.
MAXCHARS	RW	Gets or sets the maximum number of characters that the player can create on the account.
NAME	R	Gets the name of the account.
NEWPASSWORD	RW	Gets or sets a new password that will be set on the account.
PASSWORD	RW	Gets or sets the current password for the account.
PLEVEL	RW	Gets or sets the account's privelege level.
PRIV	RW	Gets or sets account flags.
RESDISP	RW	Gets or sets the account's expansion level.
TAG.name	RW	Gets or sets the value of a TAG.
TAGCOUNT	R	Gets the number of TAGs on the account.
TOTALCONNECTTIME	RW	Gets the total number of minutes that the account has been connected for.