Leunsel: Added related function template.

2026-06-26T23:39:47Z

Added related function template.

Leunsel: Initial page creation.

2026-06-26T20:29:16Z

Initial page creation.

New page

[[Category:Lua]]
{{CodeBox|'''function''' unmapMemory(''address'', ''mdl'') ''':''' void}}

Unmaps a memory region that was previously mapped with [[Lua:mapMemory|mapMemory]].

The <code>mdl</code> value must be the MDL returned by <code>mapMemory</code>.

===Function Parameters===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|address
|Integer
|The mapped address returned by mapMemory.
|-
|mdl
|Integer
|The MDL handle returned by mapMemory.
|}

===Returns===
This function does not return a value.

===Examples===

====Map and unmap memory====
<syntaxhighlight lang="lua" line highlight="5,11">
local address = getAddress("game.exe+1234")
local size = 4096
local frompid = getOpenedProcessID()

local mappedAddress, mdl = mapMemory(address, size, frompid, 0)

if mappedAddress ~= nil and mappedAddress ~= 0 then
print(string.format("Mapped address: %X", mappedAddress))
end

unmapMemory(mappedAddress, mdl)
</syntaxhighlight>

====Validate values before unmapping====
<syntaxhighlight lang="lua" line highlight="5,8">
local address = getAddress("game.exe+1234")
local size = 4096
local frompid = getOpenedProcessID()

local mappedAddress, mdl = mapMemory(address, size, frompid, 0)

if mappedAddress ~= nil and mappedAddress ~= 0 and mdl ~= nil and mdl ~= 0 then
unmapMemory(mappedAddress, mdl)
else
print("Mapping failed or returned invalid values")
end
</syntaxhighlight>

====Read from mapped memory and clean up====
<syntaxhighlight lang="lua" line highlight="5,13">
local address = getAddress("game.exe+1234")
local size = 4096
local frompid = getOpenedProcessID()

local mappedAddress, mdl = mapMemory(address, size, frompid, 0)

if mappedAddress ~= nil and mappedAddress ~= 0 then
local value = readInteger(mappedAddress)

print("Value: " .. tostring(value))
end

unmapMemory(mappedAddress, mdl)
</syntaxhighlight>

====Use pcall to ensure unmapMemory is called====
<syntaxhighlight lang="lua" line highlight="5,14">
local address = getAddress("game.exe+1234")
local size = 4096
local frompid = getOpenedProcessID()

local mappedAddress, mdl = mapMemory(address, size, frompid, 0)

local ok, err = pcall(function()
if mappedAddress ~= nil and mappedAddress ~= 0 then
print(readInteger(mappedAddress))
end
end)

if mappedAddress ~= nil and mappedAddress ~= 0 and mdl ~= nil and mdl ~= 0 then
unmapMemory(mappedAddress, mdl)
end

if not ok then
print(err)
end
</syntaxhighlight>

====Store mapping information for later cleanup====
<syntaxhighlight lang="lua" line highlight="5,9">
local mapping = {}

mapping.address = getAddress("game.exe+1234")
mapping.size = 4096
mapping.mappedAddress, mapping.mdl = mapMemory(mapping.address, mapping.size, getOpenedProcessID(), 0)

-- Later:
if mapping.mappedAddress ~= nil and mapping.mappedAddress ~= 0 and mapping.mdl ~= nil and mapping.mdl ~= 0 then
unmapMemory(mapping.mappedAddress, mapping.mdl)

mapping.mappedAddress = nil
mapping.mdl = nil
end
</syntaxhighlight>

====Unmap multiple mapped regions====
<syntaxhighlight lang="lua" line highlight="7,11">
local mappings = {}

mappings[#mappings + 1] = {mapMemory(getAddress("game.exe+1000"), 4096, getOpenedProcessID(), 0)}
mappings[#mappings + 1] = {mapMemory(getAddress("game.exe+2000"), 4096, getOpenedProcessID(), 0)}

for i, mapping in ipairs(mappings) do
local mappedAddress = mapping[1]
local mdl = mapping[2]

if mappedAddress ~= nil and mappedAddress ~= 0 and mdl ~= nil and mdl ~= 0 then
unmapMemory(mappedAddress, mdl)
end
end
</syntaxhighlight>

{{LuaSeeAlso}}

← Older revision		Revision as of 23:39, 26 June 2026
Line 131:		Line 131:

	{{LuaSeeAlso}}		{{LuaSeeAlso}}
		+
		+	{{Memory}}

Lua:unmapMemory - Revision history

Leunsel: Added related function template.

Leunsel: Initial page creation.