ModdingRX/YimMenu
Archived
1
0
Fork 0
Code Actions Releases Activity
This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
YimMenu/docs/lua/classes/pointer.md
Quentin 89f57a9a4c
Lua: can make new tabs from lua scripts, doc generation for available tabs to use (#1593) 
* lua api: add globals.get_uint and globals.set_uint

* lua doc: remove duplicate function check as we can overload so it doesn't make sense

* lua doc gen: add support for parsing the tabs enum

* gui: custom lua tabs don't have a `func` rendering function but can still have elements to draw

* lua doc: update generated doc

* chore: code style

* chore: minor spelling mistake

* chore: code style

* gui_service: add runtime removal of tabs

* refactor: make it so that it's less likely defining tabs and their translation key in a wrong way.

* lua api: ability to add custom tabs to the gui from lua
2023-07-05 00:30:57 +02:00

6.8 KiB
Raw Blame History

Class: pointer

Class representing a 64-bit memory address.

Constructors (1)

new(address)

Returns a memory instance, with the given address.

  • Parameters:
    • address (integer): Address

Example Usage:

myInstance = pointer:new(address)

Functions (23)

add(offset)

Adds an offset to the current memory address and returns a new pointer object.

  • Parameters:

    • offset (integer): offset

  • Returns:

    • pointer: new pointer object.

Example Usage:

pointer = pointer:add(offset)

sub(offset)

Subs an offset to the current memory address and returns a new pointer object.

  • Parameters:

    • offset (integer): offset

  • Returns:

    • pointer: new pointer object.

Example Usage:

pointer = pointer:sub(offset)

rip(offset)

Rips the current memory address and returns a new pointer object.

  • Parameters:

    • offset (integer): offset

  • Returns:

    • pointer: new pointer object.

Example Usage:

pointer = pointer:rip(offset)

get_byte()

Retrieves the value stored at the memory address as the specified type.

  • Returns:
    • number: the value stored at the memory address as the specified type.

Example Usage:

number = pointer:get_byte()

get_word()

Retrieves the value stored at the memory address as the specified type.

  • Returns:
    • number: the value stored at the memory address as the specified type.

Example Usage:

number = pointer:get_word()

get_dword()

Retrieves the value stored at the memory address as the specified type.

  • Returns:
    • number: the value stored at the memory address as the specified type.

Example Usage:

number = pointer:get_dword()

get_float()

Retrieves the value stored at the memory address as the specified type.

  • Returns:
    • float: the value stored at the memory address as the specified type.

Example Usage:

float = pointer:get_float()

get_qword()

Retrieves the value stored at the memory address as the specified type.

  • Returns:
    • number: the value stored at the memory address as the specified type.

Example Usage:

number = pointer:get_qword()

set_byte(value)

Sets the value at the memory address to the specified value of the given type.

  • Parameters:
    • value (number): new value.

Example Usage:

pointer:set_byte(value)

set_word(value)

Sets the value at the memory address to the specified value of the given type.

  • Parameters:
    • value (number): new value.

Example Usage:

pointer:set_word(value)

set_dword(value)

Sets the value at the memory address to the specified value of the given type.

  • Parameters:
    • value (number): new value.

Example Usage:

pointer:set_dword(value)

set_float(value)

Sets the value at the memory address to the specified value of the given type.

  • Parameters:
    • value (float): new value.

Example Usage:

pointer:set_float(value)

set_qword(value)

Sets the value at the memory address to the specified value of the given type.

  • Parameters:
    • value (number): new value.

Example Usage:

pointer:set_qword(value)

get_string()

Retrieves the value stored at the memory address as the specified type.

  • Returns:
    • string: the value stored at the memory address as the specified type.

Example Usage:

string = pointer:get_string()

set_string(value)

Sets the value at the memory address to the specified value of the given type.

  • Parameters:
    • value (string): new value.

Example Usage:

pointer:set_string(value)

patch_byte(value)

Creates a memory patch for modifying the value at the memory address with the specified value. The modified value is applied when you call the apply function on the lua_patch object. The original value is restored when you call the restore function on the lua_patch object.

  • Parameters:

    • value (number): new value.

  • Returns:

    • lua_patch: memory patch instance for modifying the value at the memory address with the specified value. Can call apply / restore on the object.

Example Usage:

lua_patch = pointer:patch_byte(value)

patch_word(value)

Creates a memory patch for modifying the value at the memory address with the specified value. The modified value is applied when you call the apply function on the lua_patch object. The original value is restored when you call the restore function on the lua_patch object.

  • Parameters:

    • value (number): new value.

  • Returns:

    • lua_patch: memory patch instance for modifying the value at the memory address with the specified value. Can call apply / restore on the object.

Example Usage:

lua_patch = pointer:patch_word(value)

patch_dword(value)

Creates a memory patch for modifying the value at the memory address with the specified value. The modified value is applied when you call the apply function on the lua_patch object. The original value is restored when you call the restore function on the lua_patch object.

  • Parameters:

    • value (number): new value.

  • Returns:

    • lua_patch: memory patch instance for modifying the value at the memory address with the specified value. Can call apply / restore on the object.

Example Usage:

lua_patch = pointer:patch_dword(value)

patch_qword(value)

Creates a memory patch for modifying the value at the memory address with the specified value. The modified value is applied when you call the apply function on the lua_patch object. The original value is restored when you call the restore function on the lua_patch object.

  • Parameters:

    • value (number): new value.

  • Returns:

    • lua_patch: memory patch instance for modifying the value at the memory address with the specified value. Can call apply / restore on the object.

Example Usage:

lua_patch = pointer:patch_qword(value)

is_null()

  • Returns:
    • boolean: Returns true if the address is null.

Example Usage:

boolean = pointer:is_null()

is_valid()

  • Returns:
    • boolean: Returns true if the address is not null.

Example Usage:

boolean = pointer:is_valid()

deref()

Dereferences the memory address and returns a new pointer object pointing to the value at that address.

  • Returns:
    • pointer: A new pointer object pointing to the value at that address.

Example Usage:

pointer = pointer:deref()

get_address()

Retrieves the memory address stored in the pointer object.

  • Returns:
    • number: The memory address stored in the pointer object as a number.

Example Usage:

number = pointer:get_address()