Difference between revisions of "LIST"
From SphereWiki
Rattlehead (talk | contribs) (→LIST Functions) |
Rattlehead (talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | |||
| + | __FORCETOC__ | ||
==LIST Functions== | ==LIST Functions== | ||
| Line 34: | Line 36: | ||
==Examples== | ==Examples== | ||
Below are examples of the use of the '''LIST''' functions: | Below are examples of the use of the '''LIST''' functions: | ||
| + | |||
| + | |||
| + | SRC.LIST.MyList.ADD MyElement | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | [[Category: Reference Compendium]] | ||
| + | [[Category: Scripts]] | ||
Revision as of 19:26, 1 October 2013
Contents
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 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 LISTs and their respective ELEMENTS |
| SERV.CLEARLISTS | W | Clears all LISTs. If used with mask parameter, then it will clear LISTs with specified name |
Examples
Below are examples of the use of the LIST functions:
SRC.LIST.MyList.ADD MyElement
