Lua:Class:MemScan

{} Class

class MemScan : Object

The MemScan class represents a memory scan object.

A MemScan inherits from Object. It can perform first scans, next scans, unknown initial value scans, value comparisons, and saved-result comparisons. It can also be used together with a FoundList object to access scan results.

Inheritance

Class	Inherits From	Description
MemScan	Object	A memory scan object used to perform and manage memory scans.

Creation

<> Lua API Reference

function getCurrentMemscan() : MemScan

<> Lua API Reference

function createMemScan(progressbar) : MemScan

Returns or creates a MemScan object.

getCurrentMemscan returns the current memory scan object. If tabs are used, it returns the MemScan object of the currently selected tab.

createMemScan creates a new MemScan object. The optional progressbar parameter can be used to attach scan progress to a progress bar.

Function Parameters

Function	Parameter	Description
getCurrentMemscan()	None	Returns the current MemScan object.
createMemScan(progressbar)	progressbar (optional)	Creates a new MemScan object and optionally attaches a progress bar.

Returns

MemScan — A memory scan object.

Scan State Properties

Property	Type	Description
LastScanWasRegionScan	Boolean	Returns true if the previous scan was an unknown initial value scan.
LastScanValue	String	The value used by the previous scan.
LastScanType	ScanType or String	The type of the previous scan, such as stNewScan or stNextScan.
ScanresultFolder	String	The path where the scan results are stored.
FoundList	FoundList	The FoundList currently attached to this MemScan object.
OnlyOneResult	Boolean	If true, the scan stops after finding the first result and writes the address to Result.
IsUnique	Boolean	Similar to OnlyOneResult, but uses multiple threads. If the value is not unique, a random matching address may be returned.
Result	Integer	If OnlyOneResult is used, this contains the found address after the scan has finished.

Event Properties

Property	Type	Description
OnScanDone	Function	Function called when the scan has finished. Receives the MemScan object as parameter.
OnGuiUpdate	Function	Function called during the scan so the interface can be updated.

OnGuiUpdate Parameters

Parameter	Type	Description
memscan	MemScan	The MemScan object that is currently scanning.
TotalAddressesToScan	Integer	The total number of addresses that will be scanned.
CurrentlyScanned	Integer	The number of addresses already scanned.
ResultsFound	Integer	The number of results found so far.

Scan Configuration Properties

Property	Type	Description
CodePage	Boolean	Controls code page handling for scans that use text input.
ScanOption	TScanOption	The scan option to use.
VariableType	TVariableType	The variable type to scan for.
VarType	TVariableType	Alias for VariableType.
Roundingtype	TRoundingType	The rounding mode used for floating-point scans.
Scanvalue	String	The primary value to scan for.
Scanvalue1	String	Alias for Scanvalue.
Scanvalue2	String	The secondary value to scan for, such as the upper value in a value-between scan.
Startaddress	Integer	The start address of the scan range.
Stopaddress	Integer	The stop address of the scan range.
Hexadecimal	Boolean	If true, the input value is treated as hexadecimal.
BinaryStringAsDecimal	Boolean	If true and the variable type is vtBinary, the input is treated as decimal instead of a binary string.
UTF16	Boolean	If true and the variable type is vtString, a UTF-16 string scan is performed.
Casesensitive	Boolean	If true and the variable type is vtString, the scan is case-sensitive.
Fastscanmethod	TFastScanMethod	The fast scan alignment method.
Fastscanparameter	String	The parameter used by the selected fast scan method.
Customtype	TCustomType	The custom type to use when scanning with a custom variable type.

Scan Region Properties

Property	Type	Description
ScanWritable	TScanRegionPreference	Controls whether writable memory is included, excluded, or ignored.
ScanExecutable	TScanRegionPreference	Controls whether executable memory is included, excluded, or ignored.
ScanCopyOnWrite	TScanRegionPreference	Controls whether copy-on-write memory is included, excluded, or ignored.

Saved Scan Properties

Property	Type	Description
Percentage	Boolean	If true, the scan uses percentage-based comparison where supported.
CompareToSavedScan	Boolean	If true, the scan compares against a saved scan result.
SavedScanName	String	The name of the saved scan result to compare against.

Methods

Method	Return Type	Description
scan()	void	Performs either a first scan or next scan based on the current property values.
firstScan()	void	Performs a first scan based on the current property values.
nextScan()	void	Performs a next scan based on the current property values.
newScan()	void	Clears the current scan results.
firstScan(scanoption, vartype, roundingtype, input1, input2, startAddress, stopAddress, protectionflags, alignmenttype, alignmentparam, isHexadecimalInput, isNotABinaryString, isunicodescan, iscasesensitive)	void	Performs an initial scan using the specified parameters.
nextScan(scanoption, roundingtype, input1, input2, isHexadecimalInput, isNotABinaryString, isunicodescan, iscasesensitive, ispercentagescan, savedresultname)	void	Performs a next scan based on the previous scan or a saved result list.
waitTillDone()	void	Waits for the MemScan thread or threads to finish scanning. This should be used after starting a scan.
saveCurrentResults(name)	void	Saves the current scan results to a unique name for this MemScan object.
getSavedResultList()	Table	Returns an indexed table containing the names of all saved results.
getSavedResultHandler(name)	SavedResultHandler	Returns the SavedResultHandler object with the given name, or nil on failure.
getAttachedFoundlist()	FoundList	Returns the attached FoundList object, or nil if no FoundList is attached.
setOnlyOneResult(state)	void	If true before a scan starts, the scanner only returns one result. This does not work with a FoundList.
getOnlyResult()	Integer or nil	Only works if OnlyOneResult is true. Returns the found address or nil if no result was found.
getProgress()	Table	Returns a table containing progress information.

Progress Table Fields

Field	Type	Description
TotalAddressesToScan	Integer	The total number of addresses that will be scanned.
CurrentlyScanned	Integer	The number of addresses already scanned.
ResultsFound	Integer	The number of results found so far.

First Scan Parameters

Parameter	Type	Description
scanoption	TScanOption	Defines what type of first scan is performed.
vartype	TVariableType	Defines the variable type to scan for.
roundingtype	TRoundingType	Defines how exact-value floating-point scans are handled.
input1	String	The primary input value, if required by the scan option.
input2	String	The secondary input value, if required by the scan option.
startAddress	Integer or CEAddressString	The start address to scan from. Commonly 0.
stopAddress	Integer or CEAddressString	The address where the scan should stop. Commonly 0xffffffffffffffff.
protectionflags	String	Protection flags that control which memory regions are scanned.
alignmenttype	TFastScanMethod	The scan alignment type.
alignmentparam	String	The alignment parameter used by the selected alignment type.
isHexadecimalInput	Boolean	If true, the input value is treated as hexadecimal. If false, it is treated as decimal.
isNotABinaryString	Boolean	If true and vartype is vtBinary, the input is treated as decimal instead of a binary string.
isunicodescan	Boolean	If true and vartype is vtString, a UTF-16 string scan is performed.
iscasesensitive	Boolean	If true and vartype is vtString, the scan checks for matching case.

Next Scan Parameters

Parameter	Type	Description
scanoption	TScanOption	Defines what type of next scan is performed.
roundingtype	TRoundingType	Defines how exact-value floating-point scans are handled.
input1	String	The primary input value, if required by the scan option.
input2	String	The secondary input value, if required by the scan option.
isHexadecimalInput	Boolean	If true, the input value is treated as hexadecimal. If false, it is treated as decimal.
isNotABinaryString	Boolean	If true and the previous variable type is vtBinary, the input is treated as decimal instead of a binary string.
isunicodescan	Boolean	If true and the previous variable type is vtString, a UTF-16 string scan is performed.
iscasesensitive	Boolean	If true and the previous variable type is vtString, the scan checks for matching case.
ispercentagescan	Boolean	If true and supported by the scan option, Cheat Engine performs a percentage scan instead of a normal value scan.
savedresultname	String (optional)	The name of a saved result list that should be compared against. The first scan is named FIRST.

First Scan Options

Value	Description
soUnknownValue	Unknown initial value scan.
soExactValue	Exact value scan.
soValueBetween	Value between scan.
soBiggerThan	Bigger than scan.
soSmallerThan	Smaller than scan.

Next Scan Options

Value	Description
soExactValue	Exact value scan.
soValueBetween	Value between scan.
soBiggerThan	Bigger than scan.
soSmallerThan	Smaller than scan.
soIncreasedValue	Increased value scan.
soIncreasedValueBy	Increased value by scan.
soDecreasedValue	Decreased value scan.
soDecreasedValueBy	Decreased value by scan.
soChanged	Changed value scan.
soUnchanged	Unchanged value scan.

Variable Types

Value	Description
vtByte	1-byte integer.
vtWord	2-byte integer.
vtDword	4-byte integer.
vtQword	8-byte integer.
vtSingle	Single-precision floating-point value.
vtDouble	Double-precision floating-point value.
vtString	String value.
vtByteArray	Byte array.
vtGrouped	Grouped scan value.
vtBinary	Binary value.
vtAll	All supported variable types.

Rounding Types

Value	Description
rtRounded	Normal rounded scan. For example, an exact value of 3 includes values from 3.0 to 3.49999999.
rtTruncated	Truncated scan. For example, an exact value of 3 includes values from 3.0 to 3.99999999.
rtExtremerounded	Extreme rounded scan. For example, an exact value of 3 includes values from 2.0000001 to 3.99999999.

Alignment Types

Value	Description
fsmNotAligned	No alignment check.
fsmAligned	The address must be divisible by the value in alignmentparam.
fsmLastDigits	The last digits of the address must end with the digits provided by alignmentparam.

Scan Region Preference Values

Value	Description
scanDontCare	Do not care whether this memory region attribute is present.
scanExclude	Exclude memory regions with this attribute.
scanInclude	Only include memory regions with this attribute.

Examples

 1 local memscan = createMemScan()
 2 
 3 memscan.firstScan(
 4   soExactValue,
 5   vtDword,
 6   rtRounded,
 7   "100",
 8   "",
 9   0,
10   0xffffffffffffffff,
11   "",
12   fsmAligned,
13   "4",
14   false,
15   true,
16   false,
17   false
18 )
19 
20 memscan.waitTillDone()
21 
22 print("First scan done")

 1 local memscan = createMemScan()
 2 
 3 memscan.firstScan(
 4   soExactValue,
 5   vtDword,
 6   rtRounded,
 7   "100",
 8   "",
 9   0,
10   0xffffffffffffffff,
11   "",
12   fsmAligned,
13   "4",
14   false,
15   true,
16   false,
17   false
18 )
19 
20 memscan.waitTillDone()
21 
22 memscan.nextScan(
23   soIncreasedValue,
24   rtRounded,
25   "",
26   "",
27   false,
28   true,
29   false,
30   false,
31   false
32 )
33 
34 memscan.waitTillDone()
35 
36 print("Next scan done")

 1 local memscan = createMemScan()
 2 
 3 memscan.setOnlyOneResult(true)
 4 
 5 memscan.firstScan(
 6   soExactValue,
 7   vtDword,
 8   rtRounded,
 9   "100",
10   "",
11   0,
12   0xffffffffffffffff,
13   "",
14   fsmAligned,
15   "4",
16   false,
17   true,
18   false,
19   false
20 )
21 
22 memscan.waitTillDone()
23 
24 local result = memscan.getOnlyResult()
25 
26 if result ~= nil then
27   print("Found address: " .. string.format("%X", result))
28 else
29   print("No result found")
30 end

 1 local memscan = createMemScan()
 2 
 3 memscan.OnGuiUpdate = function(memscan, total, scanned, found)
 4   print("Scanned: " .. tostring(scanned) .. " / " .. tostring(total))
 5   print("Found: " .. tostring(found))
 6 end
 7 
 8 memscan.OnScanDone = function(memscan)
 9   print("Scan finished")
10 end

1 local memscan = getCurrentMemscan()
2 
3 if memscan ~= nil then
4   local progress = memscan.getProgress()
5 
6   print("Total: " .. tostring(progress.TotalAddressesToScan))
7   print("Scanned: " .. tostring(progress.CurrentlyScanned))
8   print("Found: " .. tostring(progress.ResultsFound))
9 end

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine