Difference between revisions of "Lua:Class:Stringlist"

From Cheat Engine
Jump to navigation Jump to search
(filled out a proper class template for the StringList class)
m
 
Line 2: Line 2:
 
StringList '''class''': ('''Inheritance''': ''[[Lua:Class:Strings|Strings]]''->''[[Lua:Class:Object|Object]]'')
 
StringList '''class''': ('''Inheritance''': ''[[Lua:Class:Strings|Strings]]''->''[[Lua:Class:Object|Object]]'')
  
−
Basically, a wrapper around the [[Lua:Class:Strings|Strings]] class.
+
The Stringlist class represents a list of strings with optional sorting, duplicate handling, and case sensitivity.
−
 
+
You can create a Stringlist object using <code>createStringlist()</code>.
−
== Related Globals ==
 
−
; createStringList() &#58; StringList
 
−
: Creates a stringList object.
 
−
 
 
−
; DuplicatesType &#58; number
 
−
: These are declared globally and their ''type()'' is of ''number''.
 
−
: They act like an enum object for the Duplicates property.
 
−
: 0 &#58; dupIgnore
 
−
: 1 &#58; dupAccept
 
−
: 2 &#58; dupError
 
  
 
== Properties ==
 
== Properties ==
−
; Duplicates &#58; DuplicatesType
+
{| class="wikitable" style="width:100%"
−
: Determines how duplicates should be handled.
+
! Property
−
: ''Note: Does not seem to work.''
+
! Type
−
 
+
! Description
−
; Sorted &#58; boolean
+
|-
−
: Determines if the list should be sorted.
+
| Sorted
−
 
+
| Boolean
−
; CaseSensitive &#58; boolean
+
| Determines if the list should be sorted.
−
: Determines if case sensitivity is considered when sorting the list.
+
|-
−
: ''Note: This has no effect on the actual cases of the actual strings.
+
| Duplicates
 +
| [[DuplicatesType]]
 +
| Determines how duplicates are handled when the list is sorted (see enum below).
 +
|-
 +
| CaseSensitive
 +
| Boolean
 +
| Determines if the list is case sensitive.
 +
|}
  
 
== Methods ==
 
== Methods ==
−
; getDuplicates() &#58; DuplicatesType
+
{| class="wikitable" style="width:100%"
−
: Returns the Duplicates property.
+
! Method
−
 
+
! Parameters
−
; setDuplicates(DuplicatesType)
+
! Returns
−
: Sets the Duplicates property (dupIgnore, dupAccept, dupError).
+
! Description
−
: ''Note: Again, this does not seem to have any actual effect.''
+
|-
−
 
+
| getDuplicates
−
; getSorted() &#58; boolean
+
| None
−
: Returns the Sorted property.
+
| [[DuplicatesType]]
−
 
+
| Returns the duplicates property.
−
; setSorted(boolean)
+
|-
−
: Sets the Sorted property.
+
| setDuplicates
−
 
+
| [[DuplicatesType]]
−
; getCaseSensitive() &#58; boolean
+
| None
−
: Returns the CaseSensitive property.
+
| Sets the duplicates property (<code>dupIgnore</code>, <code>dupAccept</code>, <code>dupError</code>).
 +
|-
 +
| getSorted
 +
| None
 +
| Boolean
 +
| Returns true if the list is sorted.
 +
|-
 +
| setSorted
 +
| Boolean
 +
| None
 +
| Sets the sorted property.
 +
|-
 +
| getCaseSensitive
 +
| None
 +
| Boolean
 +
| Returns true if the list is case sensitive.
 +
|-
 +
| setCaseSensitive
 +
| Boolean
 +
| None
 +
| Sets the case sensitive property.
 +
|}
  
−
; setCaseSensitive(boolean)
+
== DuplicatesType Enum ==
−
: Sets the CaseSensitive property.
+
{| class="wikitable"
 +
! Name
 +
! Value
 +
! Description
 +
|-
 +
| dupIgnore
 +
| 0
 +
| Ignore duplicate entries.
 +
|-
 +
| dupAccept
 +
| 1
 +
| Accept duplicate entries.
 +
|-
 +
| dupError
 +
| 2
 +
| Raise an error on duplicate entries.
 +
|}
  
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}

Latest revision as of 18:28, 11 July 2025

StringList class: (Inheritance: Strings->Object)

The Stringlist class represents a list of strings with optional sorting, duplicate handling, and case sensitivity. You can create a Stringlist object using createStringlist().

Properties[edit]

Property Type Description
Sorted Boolean Determines if the list should be sorted.
Duplicates DuplicatesType Determines how duplicates are handled when the list is sorted (see enum below).
CaseSensitive Boolean Determines if the list is case sensitive.

Methods[edit]

Method Parameters Returns Description
getDuplicates None DuplicatesType Returns the duplicates property.
setDuplicates DuplicatesType None Sets the duplicates property (dupIgnore, dupAccept, dupError).
getSorted None Boolean Returns true if the list is sorted.
setSorted Boolean None Sets the sorted property.
getCaseSensitive None Boolean Returns true if the list is case sensitive.
setCaseSensitive Boolean None Sets the case sensitive property.

DuplicatesType Enum[edit]

Name Value Description
dupIgnore 0 Ignore duplicate entries.
dupAccept 1 Accept duplicate entries.
dupError 2 Raise an error on duplicate entries.

See also[edit]

Related Classes[edit]



Retrieved from "https://wiki.cheatengine.org/index.php?title=Lua:Class:Stringlist&oldid=7711"