Difference between revisions of "Lua:readString"

From Cheat Engine
Jump to navigation Jump to search
m (Added CodeBox Template.)
m
Line 41: Line 41:
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}
  
=== Related Functions ===
+
{{RelatedStrings}}
* [[ansiToUtf8]]
+
 
* [[utf8ToAnsi]]
 
* [[translate]]
 
 
{{ReadWriteMemory}}
 
{{ReadWriteMemory}}

Revision as of 20:39, 24 June 2026

<> Lua API Reference

function readString(Address, MaxLength, [WideChar]) : String

Reads a string from the specified address in the currently opened (target) process until a 0-terminator is encountered. The maximum number of characters to read is limited by MaxLength to prevent freezing. Set WideChar to true if the string is encoded using widechar (UTF-16/Unicode) formatting.

Function Parameters

Parameter Type Description
Address Integer or CEAddressString The address in the target process to read from.
MaxLength Integer The maximum number of characters to read (prevents infinite loops; use 6000 if you don't care).
WideChar Boolean (optional) Set to true to read as a widechar (UTF-16/Unicode) string. Default is false (ASCII/ANSI).

Returns

String — The string read from the specified address.

Examples

-- Read an ASCII string from address 0x123456, up to 100 characters
local str = readString(0x123456, 100)
print("String:", str)

-- Read a widechar (Unicode) string from a CEAddressString
local wstr = readString("game.exe+1234", 256, true)
print("Wide string:", wstr)

Main Pages

Core Lua documentation entry points

Lua
Script Engine

String Related Lua Functions

Encoding conversion and localized text helpers