Difference between revisions of "Lua:readBytes"

From Cheat Engine
Jump to navigation Jump to search
m
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
[[Category:Lua]]
 
[[Category:Lua]]
'''function''' readBytes(''Address'', ''Bytecount'', ''ReturnAsTable'' ) ''':''' (byte, ...) '''-''' table
+
'''function''' readBytes(''Address'', ''ByteCount'', [''ReturnAsTable''])
  
Returns the bytes at the given address
+
Reads bytes from the specified address in the currently opened (target) process. 
 +
Returns the bytes as multiple return values or as a table if ''ReturnAsTable'' is true.
  
 
===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 11: Line 13:
 
|-
 
|-
 
|Address
 
|Address
|[[CEAddressString]] or Integer
+
|Integer or [[CEAddressString]]
|The address to read
+
|The address in the target process 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 = readBytes(0x123456, 4)
 +
print(b1, b2, b3, b4)
 +
 +
-- Read 4 bytes and get them as a table
 +
local bytes = readBytes(0x123456, 4, true)
 +
for i, v in ipairs(bytes) do
 +
  print("Byte " .. i .. ": " .. v)
 +
end
 +
</pre>
  
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}

Revision as of 16:01, 11 July 2025

function readBytes(Address, ByteCount, [ReturnAsTable])

Reads bytes from the specified address in the currently opened (target) process. Returns the bytes as multiple return values or as a table if ReturnAsTable is true.

Function Parameters

Parameter Type Description
Address Integer or CEAddressString The address in the target process 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

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

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

See also

Lua
Script Engine

Related Functions

Read Functions
readBytes
readSmallInteger
readInteger
readQword
readPointer
readFloat
readDouble
readString
Read Functions (Local Process)
readBytesLocal
readIntegerLocal
readQwordLocal
readPointerLocal
readFloatLocal
readDoubleLocal
readStringLocal
Write Functions
writeBytes
writeSmallInteger
writeInteger
writeQword
writeFloat
writeDouble
writeString
Write Functions (Local Process)
writeBytesLocal
writeIntegerLocal
writeQwordLocal
writeFloatLocal
writeDoubleLocal
writeStringLocal
Byte Table Conversions (Value → Byte Table)
wordToByteTable
dwordToByteTable
qwordToByteTable
floatToByteTable
doubleToByteTable
stringToByteTable
wideStringToByteTable
Byte Table Conversions (Byte Table → Value)
byteTableToWord
byteTableToDword
byteTableToQword
byteTableToFloat
byteTableToDouble
byteTableToString
byteTableToWideString