Difference between revisions of "LIST"

From SphereWiki
Jump to: navigation, search
(Created page with "01-02-2009, Shadow Dragon - Added: Basic LIST support. LIST.xxx to show elements in list. Also, can be used like LIST.xxx=value to clear list and add a value LIST.xxx.ADD ...")
 
Line 1: Line 1:
−
01-02-2009, Shadow Dragon
+
 
−
- Added: Basic LIST support.
+
==LIST Functions==
−
  LIST.xxx to show elements in list. Also, can be used like LIST.xxx=value to clear list and add a value
+
 
−
  LIST.xxx.ADD to add new element to list, can be number or string
+
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.
−
  LIST.xxx.CLEAR to clear list
+
 
−
  LIST.xxx.index to read/write value on element in list
+
 
−
  LIST.xxx.COUNT to get count of elements in list
+
{| border="1" cellspacing="4" cellpadding="4"
−
  LIST.xxx.index.REMOVE to remove element at specified index in list
+
| '''LIST'''''.key'' || '''Read/Write''' || '''Description'''
−
  LIST.xxx.index.INSERT to insert element at specified index in list
+
|-
−
  LIST.xxx.FINDELEM search_value returns index of first found element in list. Search starting from begin
+
| [[LIST]].''xxx'' || R || Shows elements in LIST.''xxx''
−
  LIST.xxx.index.FINDELEM search_value returns index of first found element in list. Search starting from index
+
|-
−
  SERV.PRINTLISTS to print all lists and their elements
+
| [[LIST]].''xxx''.ADD ''<args>'' || W || Adds ''<args>'' as a new element in the list
−
  SERV.CLEARLISTS to clear all lists. If used with mask parameter, then clear all lists, which name countains specified mask
+
|-
 +
| [[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
 +
|}

Revision as of 18:56, 1 October 2013

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.


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 LISTs and their respective ELEMENTS
SERV.CLEARLISTS W Clears all LISTs. If used with mask parameter, then it will clear LISTs with specified name
Retrieved from "https://wiki.spherecommunity.net/index.php?title=LIST&oldid=7447"