TmpMenu/docs/lua/tables/locals.md
Quentin 76afd97185 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

1.4 KiB

Table: locals

Table for manipulating GTA scripts locals.

Functions (5)

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

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

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)