Memory

Reference for the memory API.

Functions

memory.base

Returns the base address of the game.

function memory.base(): integer

memory.size

Returns the size (in memory) of the game.

function memory.size(): integer

memory.alloc

Allocates memory.

---@param size integer
function memory.alloc(size): memory_allocated

memory.scan

Scans memory for a signature.

---@param signature string
---@param module? string
function memory.scan(signature, module?): memory_address

Types

pointer_int

Field	Type
value	integer

---@param count? integer
function pointer_int(count?): pointer_int

function pointer_int:free(): nil
function pointer_int:address(): memory_address

pointer_bool

Field	Type
value	bool

---@param count? integer
function pointer_bool(count?): pointer_bool

function pointer_bool:free(): nil
function pointer_bool:address(): memory_address

pointer_float

Field	Type
value	number

---@param count? integer
function pointer_float(count?): pointer_float

function pointer_float:free(): nil
function pointer_float:address(): memory_address

pointer_scr_value

Field	Type
value	scr_value

---@param count? integer
function pointer_scr_value(count?): pointer_scr_value

function pointer_scr_value:free(): nil
function pointer_scr_value:address(): memory_address

pointer_vec3

Field	Type
value	vec3

---@param count? integer
function pointer_vec3(count?): pointer_vec3

function pointer_vec3:free(): nil
function pointer_vec3:address(): memory_address

pointer_scr_vec3

Field	Type
value	scr_vec3

---@param count? integer
function pointer_scr_vec3(count?): pointer_scr_vec3

function pointer_scr_vec3:free(): nil
function pointer_scr_vec3:address(): memory_address

memory_address

Field	Type
value	integer
int8	integer
as_int8	integer
int16	integer
as_int16	integer
int32	integer
as_int32	integer
int64	integer
as_int64	integer
uint8	integer
as_uint8	integer
uint16	integer
as_uint16	integer
uint32	integer
as_uint32	integer
uint64	integer
as_uint64	integer
float	number
as_float	number
double	number
as_double	number
bool	bool
as_bool	bool
ptr	memory_address
as_ptr	memory_address
scr_vec3	scr_vec3
as_scr_vec3	scr_vec3
vec2	vec2
as_vec2	vec2
vec3	vec3
as_vec3	vec3
str	string
as_str	string

---@param count? integer
function memory_address:nop(count?): nil

---@param offset integer
function memory_address:add(offset): memory_address

---@param offset integer
function memory_address:sub(offset): memory_address

---@param op_size? integer
---@param insn_size? integer
function memory_address:rip(op_size?, insn_size?): memory_address

scr_value

Field	Type
int32	integer
uint32	integer
uint64	integer
float	number
bool	bool
str	string
ref	scr_value

memory_allocated

function memory_allocated:free(): nil