SphereWiki - User contributions [en]

LIST

2013-10-01T18:36:10Z

Rattlehead: /* LIST Functions */

__FORCETOC__

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| '''SERV.'''[[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| '''SERV.'''[[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in LIST.''xxx''
|-
| '''SERV.'''[[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| '''SERV.'''[[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| '''SERV.'''[[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| '''SERV.'''[[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| '''SERV.'''[[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| '''SERV.'''[[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| '''SERV.'''[[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

==Examples==
Below are examples of the use of the '''LIST''' functions:

===Adding to LIST===
This example shows how to add elements to your LIST.''xxx'' :

<spherescript>
[FUNCTION f_add_to_mylist]
SERV.LIST.MyList.ADD MyElement1
SERV.LIST.MyList.ADD MyElement2
SERV.LIST.MyList.ADD MyElement3
SERV.LIST.MyList.ADD MyElement4
</spherescript>

===Referencing the LIST===
To reference your LIST.''xxx'' :

<spherescript>
[FUNCTION f_show_mylist]
serv.log <serv.list.MyList>
</spherescript>

''displays; "MyElement1","MyElement2","MyElement3","MyElement4"''

===Referencing Single Elements===
in the LIST above, in order to reference by index :

<spherescript>
serv.list.MyList.0 - outputs "MyElement1"
serv.list.MyList.1 - outputs "MyElement2"
. . .
</spherescript>

[[Category: Reference Compendium]]
[[Category: Scripts]]

LIST

2013-10-01T18:35:09Z

Rattlehead: /* LIST Functions */

__FORCETOC__

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| SERV.[[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| SERV.[[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in LIST.''xxx''
|-
| SERV.[[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| SERV.[[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| SERV.[[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| SERV.[[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| SERV.[[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| SERV.[[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| SERV.[[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

==Examples==
Below are examples of the use of the '''LIST''' functions:

===Adding to LIST===
This example shows how to add elements to your LIST.''xxx'' :

<spherescript>
[FUNCTION f_add_to_mylist]
SERV.LIST.MyList.ADD MyElement1
SERV.LIST.MyList.ADD MyElement2
SERV.LIST.MyList.ADD MyElement3
SERV.LIST.MyList.ADD MyElement4
</spherescript>

===Referencing the LIST===
To reference your LIST.''xxx'' :

<spherescript>
[FUNCTION f_show_mylist]
serv.log <serv.list.MyList>
</spherescript>

''displays; "MyElement1","MyElement2","MyElement3","MyElement4"''

===Referencing Single Elements===
in the LIST above, in order to reference by index :

<spherescript>
serv.list.MyList.0 - outputs "MyElement1"
serv.list.MyList.1 - outputs "MyElement2"
. . .
</spherescript>

[[Category: Reference Compendium]]
[[Category: Scripts]]

LIST

2013-10-01T18:33:55Z

Rattlehead: /* Referencing Single Elements */

__FORCETOC__

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| [[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in LIST.''xxx''
|-
| [[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| [[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| [[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| [[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

==Examples==
Below are examples of the use of the '''LIST''' functions:

===Adding to LIST===
This example shows how to add elements to your LIST.''xxx'' :

<spherescript>
[FUNCTION f_add_to_mylist]
SERV.LIST.MyList.ADD MyElement1
SERV.LIST.MyList.ADD MyElement2
SERV.LIST.MyList.ADD MyElement3
SERV.LIST.MyList.ADD MyElement4
</spherescript>

===Referencing the LIST===
To reference your LIST.''xxx'' :

<spherescript>
[FUNCTION f_show_mylist]
serv.log <serv.list.MyList>
</spherescript>

''displays; "MyElement1","MyElement2","MyElement3","MyElement4"''

===Referencing Single Elements===
in the LIST above, in order to reference by index :

<spherescript>
serv.list.MyList.0 - outputs "MyElement1"
serv.list.MyList.1 - outputs "MyElement2"
. . .
</spherescript>

[[Category: Reference Compendium]]
[[Category: Scripts]]

LIST

2013-10-01T18:33:40Z

Rattlehead: /* Referencing the LIST */

__FORCETOC__

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| [[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in LIST.''xxx''
|-
| [[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| [[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| [[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| [[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

==Examples==
Below are examples of the use of the '''LIST''' functions:

===Adding to LIST===
This example shows how to add elements to your LIST.''xxx'' :

<spherescript>
[FUNCTION f_add_to_mylist]
SERV.LIST.MyList.ADD MyElement1
SERV.LIST.MyList.ADD MyElement2
SERV.LIST.MyList.ADD MyElement3
SERV.LIST.MyList.ADD MyElement4
</spherescript>

===Referencing the LIST===
To reference your LIST.''xxx'' :

<spherescript>
[FUNCTION f_show_mylist]
serv.log <serv.list.MyList>
</spherescript>

''displays; "MyElement1","MyElement2","MyElement3","MyElement4"''

===Referencing Single Elements===
in the LIST above, in order to reference by index :

<spherescript>
src.list.MyList.0 - outputs "MyElement1"
src.list.MyList.1 - outputs "MyElement2"
. . .
</spherescript>

[[Category: Reference Compendium]]
[[Category: Scripts]]

LIST

2013-10-01T18:33:16Z

Rattlehead: /* Adding to LIST */

__FORCETOC__

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| [[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in LIST.''xxx''
|-
| [[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| [[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| [[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| [[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

==Examples==
Below are examples of the use of the '''LIST''' functions:

===Adding to LIST===
This example shows how to add elements to your LIST.''xxx'' :

<spherescript>
[FUNCTION f_add_to_mylist]
SERV.LIST.MyList.ADD MyElement1
SERV.LIST.MyList.ADD MyElement2
SERV.LIST.MyList.ADD MyElement3
SERV.LIST.MyList.ADD MyElement4
</spherescript>

===Referencing the LIST===
To reference your LIST.''xxx'' :

<spherescript>
[FUNCTION f_show_mylist]
serv.log <src.list.MyList>
</spherescript>

''displays; "MyElement1","MyElement2","MyElement3","MyElement4"''

===Referencing Single Elements===
in the LIST above, in order to reference by index :

<spherescript>
src.list.MyList.0 - outputs "MyElement1"
src.list.MyList.1 - outputs "MyElement2"
. . .
</spherescript>

[[Category: Reference Compendium]]
[[Category: Scripts]]

LIST

2013-10-01T17:55:12Z

Rattlehead: /* Examples */

__FORCETOC__

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| [[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in LIST.''xxx''
|-
| [[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| [[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| [[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| [[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

==Examples==
Below are examples of the use of the '''LIST''' functions:

===Adding to LIST===
This example shows how to add elements to your LIST.''xxx'' :

<spherescript>
[FUNCTION f_add_to_mylist]
SRC.LIST.MyList.ADD MyElement1
SRC.LIST.MyList.ADD MyElement2
SRC.LIST.MyList.ADD MyElement3
SRC.LIST.MyList.ADD MyElement4
</spherescript>

===Referencing the LIST===
To reference your LIST.''xxx'' :

<spherescript>
[FUNCTION f_show_mylist]
serv.log <src.list.MyList>
</spherescript>

- ''displays; "MyElement1","MyElement2","MyElement3","MyElement4"''

===Referencing Single Elements===
in the LIST above, in order to reference by index :

<spherescript>
src.list.MyList.0 - outputs "MyElement1"
src.list.MyList.1 - outputs "MyElement2"
. . .
</spherescript>

[[Category: Reference Compendium]]
[[Category: Scripts]]

LIST

2013-10-01T17:53:16Z

Rattlehead: /* Examples */

__FORCETOC__

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| [[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in LIST.''xxx''
|-
| [[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| [[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| [[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| [[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

==Examples==
Below are examples of the use of the '''LIST''' functions:

This example shows how to add elements to your LIST.''xxx'' :

<spherescript>
[FUNCTION f_add_to_mylist]
SRC.LIST.MyList.ADD MyElement1
SRC.LIST.MyList.ADD MyElement2
SRC.LIST.MyList.ADD MyElement3
SRC.LIST.MyList.ADD MyElement4
</spherescript>

To reference your LIST.''xxx'' :

<spherescript>
[FUNCTION f_show_mylist]
serv.log <src.list.MyList>

- ''displays; "MyElement1","MyElement2","MyElement3","MyElement4"''
</spherescript>

in the LIST above, in order to reference by index :

<spherescript>
src.list.MyList.0 - outputs "MyElement1"
src.list.MyList.1 - outputs "MyElement2"
. . .
</spherescript>

[[Category: Reference Compendium]]
[[Category: Scripts]]

LIST

2013-10-01T17:26:47Z

Rattlehead:

LIST

2013-10-01T17:22:22Z

Rattlehead: /* LIST Functions */

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| [[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in LIST.''xxx''
|-
| [[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| [[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| [[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| [[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

==Examples==
Below are examples of the use of the '''LIST''' functions:

LIST

2013-10-01T16:59:11Z

Rattlehead: /* LIST Functions */

LIST

2013-10-01T16:56:57Z

Rattlehead:

==LIST Functions==

These functions will allow the insertion and referencing of elements in a list, this is a global property much like VAR and can be referenced or set globally.

{| border="1" cellspacing="4" cellpadding="4"
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
|-
| [[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in the list
|-
| [[LIST]].''xxx''.CLEAR || W || Clears LIST.''xxx''
|-
| [[LIST]].''xxx''.''n'' || R || References the ''nth'' zero based index of the LIST.''xxx''
|-
| [[LIST]].''xxx''.COUNT || R || Gets the total number of elements in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.REMOVE || W || Removes the ''nth'' element in LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.INSERT ''<args>'' || W || Inserts ''<args>'' at the ''nth'' index of LIST.''xxx''
|-
| [[LIST]].''xxx''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the beginning of LIST.''xxx''
|-
| [[LIST]].''xxx''.''n''.FINDELEM ''<args>'' || W || Searches LIST.''xxx'' for ''<args>'' starting from the ''nth'' index of LIST.''xxx''
|-
| '''SERV.PRINTLISTS''' || R || Prints all LIST''s'' and their respective ELEMENTS
|-
| '''SERV.CLEARLISTS''' || W || Clears all LIST''s''. If used with mask parameter, then it will clear LIST''s'' with specified name
|}

Category:Variables

2013-09-30T06:18:22Z

Rattlehead: /* Properties and Functions */

==References==
The following table lists all object references that are available from any script.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[DB]] || R || Gets the server's [[Database|database]] object.
|-
| [[FILE]] || R || Gets the server's [[Files|file]] object.
|-
| [[I]] || R || Gets the current object.
|-
| [[LIST]] || R || Gets the server's list object.
|-
| [[NEW]] || RW || Gets or sets the last [[Characters|character]] or [[Items|item]] created on the server.
|-
| [[OBJ]] || RW || Gets or sets a reference to a [[Characters|character]] or [[Items|item]]
|-
| [[SRC]] || R || Gets the source [[Characters|character]] of an event.
|-
| [[UID]].''object_uid'' || R || Gets a reference to the [[Characters|character]] or [[Items|item]] with the specified [[UID]].
|}

==Properties and Functions==
The following table lists all properties and functions that are available from any script.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ASC]] ''text'' || R || Converts ''text'' into a series of ASCII values.
|-
| [[ASCPAD]] ''size,text'' || R || Converts ''text'' into a series of ASCII values, padded with 0s untill ''size'' is reached.
Will also truncate the ''text'' if longer then ''size''
|-
| [[BETWEEN]] ''min, max, numerator, denominator'' || R || Returns the value that's ''numerator/denominator'' between ''min'' and ''max''
|-
| [[BETWEEN2]] ''min, max, numerator, denominator'' || R || Returns the value that's ''numerator/denominator'' between ''max'' and ''min''
|-
| [[CHR]] ''ascii_code'' || R || Returns the character represented by the given ASCII code.
|-
| [[CLEARVARS]] ''prefix'' || W || Removes all server VARs whose name start with ''prefix''.
|-
| [[CLRBIT]] ''value, bit'' || R || Returns the value of ''value'' with ''bit'' not set.
|-
| [[D]]''property_or_function'' || R || Forces a property or function to return a decimal value.
|-
| [[DEFMSG]]''.name'' || W || Sets the value of a DEFMESSAGE. (see sphere_msgs.scp)
|-
| [[EXPLODE]] ''separators'', ''text'' || R || Splits ''text'' by the given separator characters.
|-
| [[EVAL]] ''expression'' || R || Evaluates an expression and returns the result as an integer.
|-
| [[FEVAL]] ''expression'' || R ||| Evaluates an expression and returns the result as an integer, supports floating point values.
|-
| [[FHVAL]] ''expression'' || R ||| Evaluates an expression and returns the result as a hexadecimal value, supports floating point values.
|-
| [[FLOATVAL]] ''expression'' || R || Evaluates an expression and returns the result as a floating point value.
|-
| [[FVAL]] ''expression'' || R || Evaluates an expression and formats the result with a single decimal point. ("1000" becomes "100.0")
|-
| ''ref''.[[GETREFTYPE]] || R || Returns a code representing what type of object ''ref'' is.
|-
| [[HVAL]] ''expression'' || R || Evaluates an expression and returns the result as a hexadecimal value.
|-
| [[ISBIT]] ''value, bit'' || R || Returns non-zero if ''bit'' is set in ''value''.
|-
| [[ISEMPTY]] ''value'' || R || Returns 1 if ''value'' is empty/blank text.
|-
| [[ISNUM]] ''value'' || R || Returns 1 if ''value'' is a numeric value.
|-
| [[LISTCOL]] || R || Returns the alternating colour in webpage tables.
|-
| [[MD5HASH]] ''text'' || R || Returns an MD5 hash for ''text''.
|-
| [[MULDIV]] ''num, mul, div'' || R || Returns (''num'' * ''mul'') / ''div''.
|-
| [[NEWDUPE]] ''object_uid'' || W || Clones the character or item with the specified [[UID]].
|-
| [[NEWITEM]] ''item_defname, amount, container, equip'' || W || Creates a new item.
|-
| [[NEWNPC]] ''character_defname'' || W || Creates a new character.
|-
| [[QVAL]] ''expression''? ''value_true'':''value_false'' || R || Evaluates an expression and returns ''value_true'' if the result is true, otherwise returns ''value_false''.
There is another variant of QVAL in the [[Intrinsic Functions]] category.
|-
| [[R]]''x'' || R || Returns a random number between 0 and ''x - 1''.
|-
| [[R]]''x, y'' || R || Returns a random number between ''x'' and ''y''.
|-
| [[SETBIT]] ''value, bit'' || R || Returns the value of ''value'' with ''bit'' set.
|-
| [[SHOW]] ''property_or_function'' || W || Displays the returned value from a property or function to SRC.
|-
| [[STRARG]] ''text'' || R || Returns the first word from ''text''.
|-
| [[STREAT]] ''text'' || R || Removes the first word from ''text'' and returns the remaining text.
|-
| [[STRPOS]] ''position character text'' || R || Returns the position of a ''character'' within the ''text'', starting from ''position''.
|-
| [[STRREGEXNEW]] ''pattern, text'' || R || Returns 1 if ''text'' matches a regular expression ''pattern''.
|-
| [[STRREVERSE]] ''text'' || R || Returns ''text'', after reversing its characters.
|-
| [[STRSUB]] ''position, count, text'' || R || Extracts ''count'' characters from ''text'', starting from ''position''.
|-
| [[STRTOLOWER]] ''text'' || R || Returns ''text'' in lowercase.
|-
| [[STRTOUPPER]] ''text'' || R || Returns ''text'' in uppercase.
|-
| [[STRTRIM]] ''text'' || R || Removes whitespace (i.e. spaces, tabs) from the start and end of ''text''.
|-
| [[SYSCMD]] ''command, arg1, arg2...'' || R || Executes a system command on the server and waits for it to complete.<br />'''Note:''' Requires OF_FileCommands to be enabled in Sphere.ini
|-
| [[SYSSPAWN]] ''command, arg1, arg2...'' || R || Executes a system command on the server and does not wait for it to complete.<br />'''Note:''' Requires OF_FileCommands to be enabled in Sphere.ini
|-
| [[UVAL]] ''expression'' || R || Evaluates an expression and returns the result as an unsigned integer.
|-
| [[VAR]]''.name'' || RW || Gets or sets the value of a VAR.
|}

[[Category: Reference Compendium]]
[[Category: Scripts]]

Category:Variables

2013-09-30T06:15:51Z

Rattlehead: /* Properties and Functions */

==References==
The following table lists all object references that are available from any script.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[DB]] || R || Gets the server's [[Database|database]] object.
|-
| [[FILE]] || R || Gets the server's [[Files|file]] object.
|-
| [[I]] || R || Gets the current object.
|-
| [[LIST]] || R || Gets the server's list object.
|-
| [[NEW]] || RW || Gets or sets the last [[Characters|character]] or [[Items|item]] created on the server.
|-
| [[OBJ]] || RW || Gets or sets a reference to a [[Characters|character]] or [[Items|item]]
|-
| [[SRC]] || R || Gets the source [[Characters|character]] of an event.
|-
| [[UID]].''object_uid'' || R || Gets a reference to the [[Characters|character]] or [[Items|item]] with the specified [[UID]].
|}

==Properties and Functions==
The following table lists all properties and functions that are available from any script.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ASC]] ''text'' || R || Converts ''text'' into a series of ASCII values.
|-
| [[ASCPAD]] ''size,text'' || R || Converts ''text'' into a series of ASCII values, padded with 0s untill ''size'' is reached.
Will also truncate the ''text'' if longer then ''size''
|-
| [[BETWEEN]] ''min, max, numerator, denominator'' || R || Returns the value that's ''numerator/denominator'' between ''min'' and ''max''
|-
| [[BETWEEN2]] ''min, max, numerator, denominator'' || R || Returns the value that's ''numerator/denominator'' between ''max'' and ''min''
|-
| [[CHR]] ''ascii_code'' || R || Returns the character represented by the given ASCII code.
|-
| [[CLEARVARS]] ''prefix'' || W || Removes all server VARs whose name start with ''prefix''.
|-
| [[CLRBIT]] ''value, bit'' || R || Returns the value of ''value'' with ''bit'' not set.
|-
| [[D]]''property_or_function'' || R || Forces a property or function to return a decimal value.
|-
| [[DEFMSG]]''.name'' || W || Sets the value of a DEFMESSAGE. (see sphere_msgs.scp)
|-
| [[EXPLODE]] ''separators'', ''text'' || R || Splits ''text'' by the given separator characters.
|-
| [[EVAL]] ''expression'' || R || Evaluates an expression and returns the result as an integer.
|-
| [[FEVAL]] ''expression'' || R ||| Evaluates an expression and returns the result as an integer, supports floating point values.
|-
| [[FHVAL]] ''expression'' || R ||| Evaluates an expression and returns the result as a hexadecimal value, supports floating point values.
|-
| [[FLOATVAL]] ''expression'' || R || Evaluates an expression and returns the result as a floating point value.
|-
| [[FVAL]] ''expression'' || R || Evaluates an expression and formats the result with a single decimal point. ("1000" becomes "100.0")
|-
| ''ref''.[[GETREFTYPE]] || R || Returns a code representing what type of object ''ref'' is.
|-
| [[HVAL]] ''expression'' || R || Evaluates an expression and returns the result as a hexadecimal value.
|-
| [[ISBIT]] ''value, bit'' || R || Returns non-zero if ''bit'' is set in ''value''.
|-
| [[ISEMPTY]] ''value'' || R || Returns 1 if ''value'' is empty/blank text.
|-
| [[ISNUM]] ''value'' || R || Returns 1 if ''value'' is a numeric value.
|-
| [[LIST.xxx]] ''.name'' || RW || Gets or sets an element in a LIST.
|-
| [[LISTCOL]] || R || Returns the alternating colour in webpage tables.
|-
| [[MD5HASH]] ''text'' || R || Returns an MD5 hash for ''text''.
|-
| [[MULDIV]] ''num, mul, div'' || R || Returns (''num'' * ''mul'') / ''div''.
|-
| [[NEWDUPE]] ''object_uid'' || W || Clones the character or item with the specified [[UID]].
|-
| [[NEWITEM]] ''item_defname, amount, container, equip'' || W || Creates a new item.
|-
| [[NEWNPC]] ''character_defname'' || W || Creates a new character.
|-
| [[QVAL]] ''expression''? ''value_true'':''value_false'' || R || Evaluates an expression and returns ''value_true'' if the result is true, otherwise returns ''value_false''.
There is another variant of QVAL in the [[Intrinsic Functions]] category.
|-
| [[R]]''x'' || R || Returns a random number between 0 and ''x - 1''.
|-
| [[R]]''x, y'' || R || Returns a random number between ''x'' and ''y''.
|-
| [[SETBIT]] ''value, bit'' || R || Returns the value of ''value'' with ''bit'' set.
|-
| [[SHOW]] ''property_or_function'' || W || Displays the returned value from a property or function to SRC.
|-
| [[STRARG]] ''text'' || R || Returns the first word from ''text''.
|-
| [[STREAT]] ''text'' || R || Removes the first word from ''text'' and returns the remaining text.
|-
| [[STRPOS]] ''position character text'' || R || Returns the position of a ''character'' within the ''text'', starting from ''position''.
|-
| [[STRREGEXNEW]] ''pattern, text'' || R || Returns 1 if ''text'' matches a regular expression ''pattern''.
|-
| [[STRREVERSE]] ''text'' || R || Returns ''text'', after reversing its characters.
|-
| [[STRSUB]] ''position, count, text'' || R || Extracts ''count'' characters from ''text'', starting from ''position''.
|-
| [[STRTOLOWER]] ''text'' || R || Returns ''text'' in lowercase.
|-
| [[STRTOUPPER]] ''text'' || R || Returns ''text'' in uppercase.
|-
| [[STRTRIM]] ''text'' || R || Removes whitespace (i.e. spaces, tabs) from the start and end of ''text''.
|-
| [[SYSCMD]] ''command, arg1, arg2...'' || R || Executes a system command on the server and waits for it to complete.<br />'''Note:''' Requires OF_FileCommands to be enabled in Sphere.ini
|-
| [[SYSSPAWN]] ''command, arg1, arg2...'' || R || Executes a system command on the server and does not wait for it to complete.<br />'''Note:''' Requires OF_FileCommands to be enabled in Sphere.ini
|-
| [[UVAL]] ''expression'' || R || Evaluates an expression and returns the result as an unsigned integer.
|-
| [[VAR]]''.name'' || RW || Gets or sets the value of a VAR.
|}

[[Category: Reference Compendium]]
[[Category: Scripts]]