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/tables/locals.md
gir489 11d48f49f9
feat(lua): added weapon and vehicle cache bindings (#2477) 
* Replaced bad example in entities documentation.
* Updated Lua documentation for vehicles/weapons to allow for auto generation.
* Added Vector3 support to the Lua globals/locals class.
* Fixed a bug with get_float in globals/locals returning an int instead of a float.
* Fixed globals get_uint/set_uint using signed types for the return/parameter.
* Added unsigned int helpers to the locals Lua class.
2023-12-05 09:58:35 +01:00

2.5 KiB
Raw Blame History

Table: locals

Table for manipulating GTA scripts locals.

Functions (9)

get_int(script, index)

  • Parameters:

    • script (string): The name of the script
    • index (index): Index of the script local.

  • Returns:

    • integer: The value of the given local.

Example Usage:

integer = locals.get_int(script, index)

get_uint(script, index)

  • Parameters:

    • script (string): The name of the script
    • index (index): Index of the script local.

  • Returns:

    • unsigned integer: The value of the given local.

Example Usage:

unsigned integer = locals.get_uint(script, index)

get_float(script, index)

  • Parameters:

    • script (string): The name of the script
    • index (index): Index of the script local.

  • Returns:

    • float: The value of the given local.

Example Usage:

float = locals.get_float(script, index)

get_vec3(script, index)

  • Parameters:

    • script (string): The name of the script
    • index (index): Index of the script local.

  • Returns:

    • Vector3: The value of the given local.

Example Usage:

Vector3 = locals.get_vec3(script, index)

set_int(script, index, val)

  • Parameters:
    • script (string): The name of the script
    • index (index): Index of the script local.
    • val (integer): The new value of the given local.

Example Usage:

locals.set_int(script, index, val)

set_int(script, index, val)

  • Parameters:
    • script (string): The name of the script
    • index (index): Index of the script local.
    • val (unsigned integer): The new value of the given local.

Example Usage:

locals.set_int(script, index, val)

set_float(script, index, val)

  • Parameters:
    • script (string): The name of the script
    • index (index): Index of the script local.
    • val (float): The new value of the given local.

Example Usage:

locals.set_float(script, index, val)

set_vec3(script, index, val)

  • Parameters:
    • script (string): The name of the script
    • index (index): Index of the script local.
    • val (Vector3): The new value of the given local.

Example Usage:

locals.set_vec3(script, index, val)

get_pointer(script, index)

  • Parameters:

    • script (string): The name of the script
    • index (index): Index of the script local.

  • Returns:

    • pointer: The pointer to the given local.

Example Usage:

pointer = locals.get_pointer(script, index)