MrSugarCube at 23:22, 7 June 2009

2009-06-07T23:22:22Z

MrSugarCube: Created page with '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''' fro...'

2009-06-07T15:41:19Z

Created page with '__FORCETOC__ Clients are able to form parties with each other by using the <tt>/add</tt> command. When in a party, the party object can be referenced by using '''PARTY.KEY''' fro...'

New page

__FORCETOC__
Clients are able to form parties with each other by using the <tt>/add</tt> command. When in a party, the party object can be referenced by using '''PARTY.KEY''' from the [[Characters#Clients|client]] object. The following tables detail the various properties of parties in SphereServer:

==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.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[MASTER]] || R || Gets the party master, the [[Characters|character]] who originally formed the party.
|-
| [[MEMBER]]''.n'' || R || Gets the nth [[Characters|party member]]. (zero-based)
|}

==Properties and Functions==
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 <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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.
|-
| [[SPEECHFILTER]] || RW || Gets or sets a function that will be called every time a party member speaks to the party.
|-
| [[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.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]

@@ Line 20: / Line 20: @@
 {| border="1" cellspacing="4" cellpadding="4"
 | '''Name''' || '''Read/Write''' || '''Description'''
 |-
 | [[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.
 |-
 | [[SPEECHFILTER]] || RW || Gets or sets a function that will be called every time a party member speaks to the party.
 |-
 | [[TAG]] || RW || Gets or sets the value of a TAG.
@@ Line 36: / Line 52: @@
 |-
 | [[TAGCOUNT]] || R || Gets the number of TAGs stored on the party.
 |}
 [[Category: Reference Compendium]]
 [[Category: Objects]]

Parties - Revision history

MrSugarCube at 23:22, 7 June 2009

MrSugarCube: Created page with '__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''' fro...'

MrSugarCube: Created page with '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''' fro...'