Vivum Target
Exports
Learn about the exports of Vivum Target
AddTarget
| Kind | Name | Type | Description |
|---|---|---|---|
| @param | menu | Menu | |
| @return | id | string | nil | The id of the menu. |
--- @param menu Menu
--- @return string | nil id The id of the menu.
local id = exports["vivum-target"]:AddTarget(menu)
UpdateTarget
| Kind | Name | Type | Description |
|---|---|---|---|
| @param | id | number | string | |
| @param | partial | PartialMenu | |
| @return | menu? | Menu | The menu if found. |
--- @param id number | string
--- @param partial PartialMenu
--- @return Menu? menu The menu if found.
local menu = exports["vivum-target"]:UpdateTarget(id, partial)
RemoveTarget
| Kind | Name | Type | Description |
|---|---|---|---|
| @param | id | number | string | |
| @param | resource? | string | |
--- @param id number | string
--- @param resource? string
exports["vivum-target"]:RemoveTarget(id, resource)
GetTarget
| Kind | Name | Type | Description |
|---|---|---|---|
| @param | id | number | string | |
| @param | resource? | string | |
| @return | menu? | Menu | The menu if found. |
| @return | index? | number | The index of the menu if found. |
--- @param id number | string
--- @param resource? string
--- @return Menu? menu The menu if found.
--- @return number? index The index of the menu if found.
local menu, index = exports["vivum-target"]:GetTarget(id, resource)
Toggle
| Kind | Name | Type | Description |
|---|---|---|---|
| @param | state? | boolean | State being set to |
--- @param state? boolean State being set to `false` will disable the ALT (or whichever keybind is set) functionality.
exports["vivum-target"]:Toggle(state)
RemoveNames
| Kind | Name | Type | Description |
|---|---|---|---|
| @param | id | number | string | |
| @param | names | string | string[] | |
| @param | resource? | string | |
--- @param id number | string
--- @param names string | string[]
--- @param resource? string
exports["vivum-target"]:RemoveNames(id, names, resource)
PreloadIcons
| Kind | Name | Type | Description |
|---|---|---|---|
| @param | icons | string[] | |
| @return | loaded | boolean | Whether any icons were loaded. |
--- @param icons string[]
--- @return boolean loaded Whether any icons were loaded.
local loaded = exports["vivum-target"]:PreloadIcons(icons)