Difference between revisions of "Lua:Class:Stringlist"
Jump to navigation
Jump to search
(filled out a proper class template for the StringList class) |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Lua]] | [[Category:Lua]] | ||
| − | + | StringList '''class''': ('''Inheritance''': ''[[Lua:Class:Strings|Strings]]''->''[[Lua:Class:Object|Object]]'') | |
| − | |||
| − | === | + | Basically, a wrapper around the [[Lua:Class:Strings|Strings]] class. |
| − | + | ||
| − | + | == Related Globals == | |
| − | + | ; createStringList() : StringList | |
| − | == | + | : Creates a stringList object. |
| − | + | ||
| − | + | ; DuplicatesType : number | |
| − | + | : These are declared globally and their ''type()'' is of ''number''. | |
| − | + | : They act like an enum object for the Duplicates property. | |
| − | + | : 0 : dupIgnore | |
| − | + | : 1 : dupAccept | |
| + | : 2 : dupError | ||
| + | |||
| + | == Properties == | ||
| + | ; Duplicates : DuplicatesType | ||
| + | : Determines how duplicates should be handled. | ||
| + | : ''Note: Does not seem to work.'' | ||
| + | |||
| + | ; Sorted : boolean | ||
| + | : Determines if the list should be sorted. | ||
| + | |||
| + | ; CaseSensitive : boolean | ||
| + | : Determines if case sensitivity is considered when sorting the list. | ||
| + | : ''Note: This has no effect on the actual cases of the actual strings. | ||
| + | |||
| + | == Methods == | ||
| + | ; getDuplicates() : DuplicatesType | ||
| + | : Returns the Duplicates property. | ||
| + | |||
| + | ; setDuplicates(DuplicatesType) | ||
| + | : Sets the Duplicates property (dupIgnore, dupAccept, dupError). | ||
| + | : ''Note: Again, this does not seem to have any actual effect.'' | ||
| + | |||
| + | ; getSorted() : boolean | ||
| + | : Returns the Sorted property. | ||
| + | |||
| + | ; setSorted(boolean) | ||
| + | : Sets the Sorted property. | ||
| + | |||
| + | ; getCaseSensitive() : boolean | ||
| + | : Returns the CaseSensitive property. | ||
| + | |||
| + | ; setCaseSensitive(boolean) | ||
| + | : Sets the CaseSensitive property. | ||
| + | |||
| + | {{LuaSeeAlso}} | ||
| + | |||
| + | === Related Classes === | ||
| + | * [[Lua:Class:Object|Object]] | ||
| + | * [[Lua:Class:Strings|Strings]] | ||
Latest revision as of 12:03, 22 March 2020
StringList class: (Inheritance: Strings->Object)
Basically, a wrapper around the Strings class.
Related Globals[edit]
- createStringList() : StringList
- Creates a stringList object.
- DuplicatesType : number
- These are declared globally and their type() is of number.
- They act like an enum object for the Duplicates property.
- 0 : dupIgnore
- 1 : dupAccept
- 2 : dupError
Properties[edit]
- Duplicates : DuplicatesType
- Determines how duplicates should be handled.
- Note: Does not seem to work.
- Sorted : boolean
- Determines if the list should be sorted.
- CaseSensitive : boolean
- Determines if case sensitivity is considered when sorting the list.
- Note: This has no effect on the actual cases of the actual strings.
Methods[edit]
- getDuplicates() : DuplicatesType
- Returns the Duplicates property.
- setDuplicates(DuplicatesType)
- Sets the Duplicates property (dupIgnore, dupAccept, dupError).
- Note: Again, this does not seem to have any actual effect.
- getSorted() : boolean
- Returns the Sorted property.
- setSorted(boolean)
- Sets the Sorted property.
- getCaseSensitive() : boolean
- Returns the CaseSensitive property.
- setCaseSensitive(boolean)
- Sets the CaseSensitive property.
