Difference between revisions of "Lua:writeString"

From Cheat Engine
Jump to navigation Jump to search
m (Added CodeBox Template.)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Lua]]
 
[[Category:Lua]]
'''function''' writeString(''Address'', ''Text'', ''WideChar'' OPTIONAL) : Boolean - Returns true on success.
+
{{CodeBox|'''function''' writeString(''Address'', ''Text'', [''WideChar'']) ''':''' Boolean}}
  
Writes the given text to the given address. This does not write a 0-terminator at the end. You need to use [[writeBytes]] yourself if you need one. Set WideChar to true if it is encoded using a widechar formatting.
+
Writes a string to the specified address in the currently opened (target) process.
 +
Set ''WideChar'' to true to write the string as widechar (UTF-16/Unicode). 
 +
Returns true on success.
  
 
===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 of the target process to write to
+
|The address in the target process to write to.
 
|-
 
|-
 
|Text
 
|Text
 
|String
 
|String
|The text to write to the process
+
|The string to write.
 
|-
 
|-
 
|WideChar
 
|WideChar
|boolean
+
|Boolean (optional)
|Set to true if it is encoded using a widechar formatting
+
|Set to true to write as a widechar (UTF-16/Unicode) string. Default is false (ASCII/ANSI).
 
|}
 
|}
  
 +
===Returns===
 +
Boolean — true if the write was successful, false otherwise.
 +
 +
===Examples===
 +
<pre>
 +
-- Write an ASCII string to address 0x123456
 +
local success = writeString(0x123456, "Hello, world!")
 +
print("Write successful:", success)
 +
 +
-- Write a widechar (Unicode) string to a CEAddressString
 +
writeString("game.exe+1234", "Unicode Text", true)
 +
</pre>
  
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}

Latest revision as of 23:02, 4 December 2025

<> Function

function writeString(Address, Text, [WideChar]) : Boolean

Writes a string to the specified address in the currently opened (target) process. Set WideChar to true to write the string as widechar (UTF-16/Unicode). Returns true on success.

Function Parameters[edit]

Parameter Type Description
Address Integer or CEAddressString The address in the target process to write to.
Text String The string to write.
WideChar Boolean (optional) Set to true to write as a widechar (UTF-16/Unicode) string. Default is false (ASCII/ANSI).

Returns[edit]

Boolean — true if the write was successful, false otherwise.

Examples[edit]

-- Write an ASCII string to address 0x123456
local success = writeString(0x123456, "Hello, world!")
print("Write successful:", success)

-- Write a widechar (Unicode) string to a CEAddressString
writeString("game.exe+1234", "Unicode Text", true)

See also[edit]

Lua
Script Engine

Related Functions[edit]

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