mirror of
https://github.com/Mr-X-GTA/YimMenu.git
synced 2026-10-10 11:53:07 +08:00
gir489
d2a7ff8ba4
* 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.
2.5 KiB
2.5 KiB
Table: locals
Table for manipulating GTA scripts locals.
Functions (9)
get_int(script, index)
-
Parameters:
script(string): The name of the scriptindex(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 scriptindex(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 scriptindex(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 scriptindex(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 scriptindex(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 scriptindex(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 scriptindex(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 scriptindex(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 scriptindex(index): Index of the script local.
-
Returns:
pointer: The pointer to the given local.
Example Usage:
pointer = locals.get_pointer(script, index)