Difference between revisions of "Lua:readBytesLocal"

From Cheat Engine
Jump to navigation Jump to search
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
[[Category:Lua]]
 
[[Category:Lua]]
'''function''' readBytesLocal(''Address'', ''Bytecount'', ''ReturnAsTable'' ) ''':''' (byte, ...) '''-''' table
+
'''function''' readBytesLocal(''Address'', ''ByteCount'', [''ReturnAsTable''])
  
Returns the bytes at the given address, in Cheat Engine's memory.
+
Reads bytes from the specified address in Cheat Engine's own process memory (not the target process).
 
+
Returns the bytes as multiple return values or as a table if ''ReturnAsTable'' is true.
Note: The bytes read are from the Cheat Engine process instead of the targeted process.
 
  
 
===Function Parameters===
 
===Function Parameters===
{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
+
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
 
!align="left"|Parameter
 
!align="left"|Parameter
 
!align="left"|Type
 
!align="left"|Type
Line 13: Line 12:
 
|-
 
|-
 
|Address
 
|Address
|[[CEAddressString]] or Integer
+
|Integer or [[CEAddressString]]
|The address to read
+
|The address in Cheat Engine's memory to read from.
 
|-
 
|-
|Bytecount
+
|ByteCount
 
|Integer
 
|Integer
|The number of bytes to read
+
|The number of bytes to read.
 
|-
 
|-
 
|ReturnAsTable
 
|ReturnAsTable
|Boolean
+
|Boolean (optional)
|Returns a table object instead of multiple return values
+
|If true, returns a table of bytes. If false or omitted, returns each byte as a separate return value.
 
|}
 
|}
  
 +
===Examples===
 +
<pre>
 +
-- Read 4 bytes and get them as separate values
 +
local b1, b2, b3, b4 = readBytesLocal(0x123456, 4)
 +
print(b1, b2, b3, b4)
 +
 +
-- Read 4 bytes and get them as a table
 +
local bytes = readBytesLocal(0x123456, 4, true)
 +
for i, v in ipairs(bytes) do
 +
  print("Byte " .. i .. ": " .. v)
 +
end
 +
</pre>
  
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}

Latest revision as of 17:11, 11 July 2025

function readBytesLocal(Address, ByteCount, [ReturnAsTable])

Reads bytes from the specified address in Cheat Engine's own process memory (not the target process). Returns the bytes as multiple return values or as a table if ReturnAsTable is true.

Function Parameters[edit]

Parameter Type Description
Address Integer or CEAddressString The address in Cheat Engine's memory to read from.
ByteCount Integer The number of bytes to read.
ReturnAsTable Boolean (optional) If true, returns a table of bytes. If false or omitted, returns each byte as a separate return value.

Examples[edit]

-- Read 4 bytes and get them as separate values
local b1, b2, b3, b4 = readBytesLocal(0x123456, 4)
print(b1, b2, b3, b4)

-- Read 4 bytes and get them as a table
local bytes = readBytesLocal(0x123456, 4, true)
for i, v in ipairs(bytes) do
  print("Byte " .. i .. ": " .. v)
end

See also[edit]

Related Functions[edit]