Difference between revisions of "Lua:readStringLocal"

From Cheat Engine
Jump to navigation Jump to search
m (Added CodeBox Template.)
m (Syntax Highlighting.)
 
(One intermediate revision by the same user not shown)
Line 29: Line 29:
  
 
===Examples===
 
===Examples===
<pre>
+
<syntaxhighlight lang="lua" line>
 
-- Read an ASCII string from address 0x123456 in CE's memory, up to 100 characters
 
-- Read an ASCII string from address 0x123456 in CE's memory, up to 100 characters
 
local str = readStringLocal(0x123456, 100)
 
local str = readStringLocal(0x123456, 100)
Line 37: Line 37:
 
local wstr = readStringLocal("00400000+10", 256, true)
 
local wstr = readStringLocal("00400000+10", 256, true)
 
print("Wide string:", wstr)
 
print("Wide string:", wstr)
</pre>
+
</syntaxhighlight>
  
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}
  
=== Related Functions ===
+
{{RelatedStrings}}
* [[ansiToUtf8]]
+
 
* [[utf8ToAnsi]]
 
* [[translate]]
 
 
{{ReadWriteMemory}}
 
{{ReadWriteMemory}}

Latest revision as of 15:41, 25 June 2026

<> Lua API Reference

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

Reads a string from the specified address in Cheat Engine's own process memory (not the 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[edit]

Parameter Type Description
Address Integer or CEAddressString The address in Cheat Engine's memory to read from.
MaxLength Integer The maximum number of characters to read (prevents infinite loops).
WideChar Boolean (optional) Set to true to read as a widechar (UTF-16/Unicode) string. Default is false (ASCII/ANSI).

Returns[edit]

String — The string read from the specified address.

Examples[edit]

1 -- Read an ASCII string from address 0x123456 in CE's memory, up to 100 characters
2 local str = readStringLocal(0x123456, 100)
3 print("String:", str)
4 
5 -- Read a widechar (Unicode) string from a CEAddressString
6 local wstr = readStringLocal("00400000+10", 256, true)
7 print("Wide string:", wstr)

Main Pages

Core Lua documentation entry points

Lua
Script Engine

String Related Lua Functions

Encoding conversion and localized text helpers