Difference between revisions of "Lua:Class:Addresslist"

From Cheat Engine
Jump to navigation Jump to search
Line 1: Line 1:
−
'''AddressList class''': (Inheritance: [[Panel]]->[[WinControl]]->[[Control]]->[[Component]]->[[Object]])
+
Addresslist '''class''': ('''Inheritance''': ''[[Panel]]''->''[[WinControl]]''->''[[Control]]''->''[[Component]]''->''[[Object]]'')
  
 +
Class for manipulating the Cheat Engine form's address list.
  
−
The Addresslist class can be used to access information regarding the Cheat Engine table. It is commonly combined with [[MemoryRecord]].
+
== Properties ==
 +
; Count : integer
 +
: The number of records in the table.
  
 +
; SelCount : integer
 +
: The number of records that are selected.
  
−
===Properties===
+
; SelectedRecord : [[MemoryRecord]]
−
  Count: Integer - The number of records in the table
+
: The main selected record.
−
  SelCount: integer- The number of records that are selected
 
−
  SelectedRecord: MemoryRecord - The main selected record
 
−
  MemoryRecord[]: MemoryRecord - Array to access the individial memory records
 
−
  [] = MemoryRecord - Default accessor
 
  
−
===Methods===
+
; MemoryRecord[''index''] : [[MemoryRecord]]
−
  getCount()
+
: Array to access the individual memory records.
−
  getMemoryRecord(index)
 
−
  getMemoryRecordByDescription(description): returns a MemoryRecord object
 
−
  getMemoryRecordByID(ID)
 
−
  createMemoryRecord() : creates an generic cheat table entry and add it to the list
 
  
−
  getSelectedRecords(): Returns a table containing all the selected records
+
; [''index''] : [[MemoryRecord]]
 +
: Default accessor.
  
−
  doDescriptionChange() : Will show the gui window to change the description of the selected entry
+
== Methods ==
−
  doAddressChange() : Will show the gui window to change the address of the selected entry
+
; getCount() : integer
−
  doTypeChange() : Will show the gui window to change the type of the selected entries
+
: Returns the number of memory records in the address list.
−
  doValueChange() : Will show the gui window to change the value of the selected entries
 
  
−
  getSelectedRecord() : Gets the main selected memoryrecord
+
; getMemoryRecord(''index'') : [[MemoryRecord]]
−
  setSelectedRecord(memrec) : Sets the currently selected memoryrecord. This will unselect all other entries
+
: returns a [[MemoryRecord]] object based on it's index.
  
−
----
+
; getMemoryRecordByDescription(''description'') : [[MemoryRecord]]
 +
: returns a [[MemoryRecord]] object based on it's description.
  
−
* [[Lua|Lua Functions and Classes]]
+
; getMemoryRecordByID(''ID'') : [[MemoryRecord]]
 +
: returns a [[MemoryRecord]] object based on it's ID.
 +
 
 +
; createMemoryRecord() : [[MemoryRecord]]
 +
: creates an generic cheat table entry and add it to the list
 +
 
 +
; getSelectedRecords() : [[MemoryRecord]]
 +
: Returns a table containing all the selected records
 +
 
 +
; doDescriptionChange()
 +
: Will show the GUI window to change the description of the selected entry
 +
 
 +
; doAddressChange()
 +
: Will show the GUI window to change the address of the selected entry
 +
 
 +
; doTypeChange()
 +
: Will show the GUI window to change the type of the selected entries
 +
 
 +
; doValueChange()
 +
: Will show the GUI window to change the value of the selected entries
 +
 
 +
; getSelectedRecord() : [[MemoryRecord]]
 +
: Gets the main selected memory record.
 +
 
 +
; setSelectedRecord(''memrec'')
 +
: Sets the currently selected memory record. This will unselect all other entries.
 +
 
 +
== Examples ==
 +
local addressList = getAddressList()
 +
if addressList.Count >= 1 then
 +
  local mrHealth = addressList.getMemoryRecordByDescription('Health')
 +
end
 +
local mrMana = addressList.createMemoryRecord()
 +
 
 +
== See also ==
 +
* [[Lua]]
 +
* [[Help_File:Script engine|Script engine]]
 +
 
 +
=== Related Functions ===
 +
* [[getMainForm]]
 +
* [[getAddressList]]
 +
 
 +
=== Related Classes ===
 +
* [[MemoryRecord]]

Revision as of 08:00, 11 March 2017

Addresslist class: (Inheritance: Panel->WinControl->Control->Component->Object)

Class for manipulating the Cheat Engine form's address list.

Properties

Count : integer
The number of records in the table.
SelCount : integer
The number of records that are selected.
SelectedRecord : MemoryRecord
The main selected record.
MemoryRecord[index] : MemoryRecord
Array to access the individual memory records.
[index] : MemoryRecord
Default accessor.

Methods

getCount() : integer
Returns the number of memory records in the address list.
getMemoryRecord(index) : MemoryRecord
returns a MemoryRecord object based on it's index.
getMemoryRecordByDescription(description) : MemoryRecord
returns a MemoryRecord object based on it's description.
getMemoryRecordByID(ID) : MemoryRecord
returns a MemoryRecord object based on it's ID.
createMemoryRecord() : MemoryRecord
creates an generic cheat table entry and add it to the list
getSelectedRecords() : MemoryRecord
Returns a table containing all the selected records
doDescriptionChange()
Will show the GUI window to change the description of the selected entry
doAddressChange()
Will show the GUI window to change the address of the selected entry
doTypeChange()
Will show the GUI window to change the type of the selected entries
doValueChange()
Will show the GUI window to change the value of the selected entries
getSelectedRecord() : MemoryRecord
Gets the main selected memory record.
setSelectedRecord(memrec)
Sets the currently selected memory record. This will unselect all other entries.

Examples

local addressList = getAddressList()
if addressList.Count >= 1 then
  local mrHealth = addressList.getMemoryRecordByDescription('Health')
end
local mrMana = addressList.createMemoryRecord()

See also

Related Functions

Related Classes



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