Lua:AOBScan

<> Lua API Reference

function AOBScan(aobstring, protectionflags, alignmenttype, alignmentparam) : StringList

<> Lua API Reference

function AOBScan(byte1, byte2, ...) : StringList

Scans the currently opened process for an array of bytes and returns a StringList containing all matching addresses.

The returned StringList must be destroyed when it is no longer needed.

Function Parameters

String Pattern Form

Parameter	Type	Description
aobstring	String	The array-of-bytes pattern to scan for. Wildcards can be used in the pattern.
protectionflags	String (optional)	A string that controls which memory regions are scanned based on executable, writable, and copy-on-write protection flags.
alignmenttype	Integer (optional)	Controls the address alignment check.
alignmentparam	String	The alignment parameter. Required when the selected alignment type needs a value.

Byte Parameter Form

Parameter	Type	Description
byte1, byte2, ...	Integer	The byte values to scan for. Values higher than 255 or values that are not integers are treated as wildcards.

Returns

StringList — A StringList containing all matching addresses as strings.

The returned list must be destroyed manually when it is no longer needed.

Protection Flags

The protectionflags parameter is a string made from memory protection flags.

Flag	Meaning
X	Executable memory.
W	Writable memory.
C	Copy-on-write memory.

Each flag can be prefixed with one of the following operators:

Operator	Meaning
+	The flag must be set.
-	The flag must not be set.
*	The flag does not matter.

Protection Flag Examples

Protection Flags	Description
+W-C	Scans writable memory, excludes copy-on-write memory, and does not care about the executable flag.
+X-C-W	Scans read-only executable memory.
+W	Scans writable memory and does not care about copy-on-write or executable memory.
	Scans everything. This is the same as *X*C*W.

Alignment Types

Value	Name	Description
0	No alignment check	No alignment restriction is applied.
1	Divisible alignment	The address must be divisible by alignmentparam.
2	Last digits alignment	The address must end with the digits specified by alignmentparam.

Alignment Parameter

The alignmentparam parameter is a string.

Its meaning depends on alignmenttype:

Alignment Type	alignmentparam Meaning
0	Not used.
1	The value the address must be divisible by.
2	The last digits the address must end with.

Wildcard Behavior

In the byte parameter form, every value higher than 255 or every value that is not an integer is treated as a wildcard.

In the string pattern form, use the normal array-of-bytes wildcard syntax inside the pattern string.

Examples

local results = AOBScan("48 8B ?? ?? ?? 89")

if results ~= nil then
  print("Results found: " .. tostring(results.Count))

  for i = 0, results.Count - 1 do
    print(results[i])
  end

  results.destroy()
end

local results = AOBScan("48 8B ?? ?? ?? 89", "+X-C-W")

if results ~= nil then
  print("Executable read-only results: " .. tostring(results.Count))
  results.destroy()
end

local results = AOBScan("48 8B ?? ?? ?? 89", "+W-C", 1, "4")

if results ~= nil then
  print("Writable aligned results: " .. tostring(results.Count))
  results.destroy()
end

local results = AOBScan(0x48, 0x8B, 999, 0x89)

if results ~= nil then
  print("Results found: " .. tostring(results.Count))
  results.destroy()
end

Notes

• AOBScan scans the currently opened process.
• The returned StringList must be destroyed when it is no longer needed.
• The string pattern form is usually easier to read and maintain.
• The byte parameter form treats values higher than 255 or non-integer values as wildcards.
• An empty protectionflags string scans all memory regions.
• Use protection flags and alignment when you want to reduce false positives or improve scan performance.

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine

Related Pages

AOBScan
AOBScanModuleUnique
AOBScanUnique
getCurrentMemscan

Readonly Classes

• StringList - String list object documentation