ModdingRX/TmpMenu
1
0
Fork 0
mirror of https://github.com/Mr-X-GTA/YimMenu.git synced 2025-01-05 17:13:29 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
TmpMenu/docs/lua/classes/pointer.md
Arthur 12906d0365 Add Return Value Support for Script Functions (#3479) 
* Add Return Value Support for Script Functions
* Removed address-of operator on instruction_pointer parameter, as sol is pass-by-value.
* Fixed reset_session_data & start_creator_script
* Added support for Vector3 and updated casting for bool type for proper conversion to Lua boolean
* Updated documentation for scr_function
* Added get_int method and updated param names for script functions
* Fix #3497 graceful landing not saved.
* Added a check in view_lsc to see if the vehicle can accept clan logos first.
* Fixed vehicle clan logo SP bypass not working properly.
* Fixed COPY VEHICLE not giving persist_car_service::spawn_vehicle_json the target's ped so it can copy their clan logo and not ours.
Fixed spawn_vehicle_json calling add_clan_logo_to_vehicle with our logo and not the ped parameter's logo.
* Added Clone Player Car.
* Fixed has_clan_logo check in view_lsc being given the wrong parameter.

---------

Co-authored-by: gir489 <100792176+gir489returns@users.noreply.github.com>
2024-08-06 14:46:48 +02:00

7.2 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_int()

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_int()

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_int(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_int(value)

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()