mirror of
https://github.com/Mr-X-GTA/YimMenu.git
synced 2025-01-07 09:53:50 +08:00
76afd97185
* 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
74 lines
1.4 KiB
Markdown
74 lines
1.4 KiB
Markdown
# 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:**
|
|
```lua
|
|
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:**
|
|
```lua
|
|
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:**
|
|
```lua
|
|
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:**
|
|
```lua
|
|
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:**
|
|
```lua
|
|
pointer = locals.get_pointer(script, index)
|
|
```
|
|
|
|
|