-
Notifications
You must be signed in to change notification settings - Fork 0
Parties
FORCETOC Clients are able to form parties with each other by using the /add command. When in a party, the party object can be referenced by using PARTY.KEY from the client object. The following tables detail the various properties of parties in SphereServer:
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.
{| border="1" cellspacing="4" cellpadding="4" | Name || Read/Write || Description |- | MASTER || R || Gets the party master, the character who originally formed the party. |- | MEMBER.n || R || Gets the nth party member. (zero-based) |}
Here is a list of all party properties and functions. If a function is marked as readable then it can return a value when used as . Click on the name for more detailed information such as usage and examples.
{| border="1" cellspacing="4" cellpadding="4" | Name || Read/Write || Description |- | ADDMEMBER character_uid || W || Adds a character to the party. |- | ADDMEMBERFORCED character_uid || W || Adds a character to the party. If the character is already in a party then they will be forced out of it. The character will be added even if the party has reached the maximum size of 10. |- | CLEARTAGS || W || Removes all TAGs from the party. |- | DISBAND || W || Disbands the party. |- | ISSAMEPARTYOF character_uid || R || Returns 1 if a specified character is a member of this party. |- | MEMBERS || R || Gets the total number of characters in the party. |- | REMOVEMEMBER character_uid || W || Removes a character from the party. |- | REMOVEMEMBER @n || W || Removes the nth character from the party. (zero-based) |- | SPEECHFILTER || RW || Gets or sets a function that will be called every time a party member speaks to the party. |- | SYSMESSAGE character_uid, message || W || Sends a message to a party member (0 = Entire party). |- | SYSMESSAGE @n, message || W || Sends a message to the nth party member. |- | TAG || RW || Gets or sets the value of a TAG. |- | TAGAT.index || R || Gets a TAG at the given zero-based index. |- | TAGAT.index.KEY || R || Gets the name of the TAG at the given zero-based index. |- | TAGAT.index.VAL || R || Gets the value of the TAG at the given zero-based index. |- | TAGCOUNT || R || Gets the number of TAGs stored on the party. |- | TAGLIST || W || Displays a list of all TAGs to SRC. |}
Category: Reference Compendium Category: Objects