UI Lua API: Difference between revisions
No edit summary |
No edit summary |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
== Functions == | == Functions == | ||
=== ToggleClock === | === ToggleClock === | ||
<syntaxhighlight source lang="lua">UI.ToggleClock()</syntaxhighlight> | <syntaxhighlight source lang="lua">UI.ToggleClock(state)</syntaxhighlight> | ||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| state || bool | |||
|} | |||
'''Description''': Toggles the clock hud element | '''Description''': Toggles the clock hud element | ||
Line 11: | Line 18: | ||
=== ToggleWeather === | === ToggleWeather === | ||
<syntaxhighlight source lang="lua">UI.ToggleWeather()</syntaxhighlight> | <syntaxhighlight source lang="lua">UI.ToggleWeather(state)</syntaxhighlight> | ||
''' | '''Expected parameter types''' | ||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| state || bool | |||
|} | |||
'''Description''': Toggles the weather hud element | '''Description''': Toggles the weather hud element | ||
Line 37: | Line 45: | ||
'''Notes''': This can be used for dramatic effect when certain story elements trigger | '''Notes''': This can be used for dramatic effect when certain story elements trigger | ||
=== ToggleDebugUI === | === ToggleDebugUI === | ||
<syntaxhighlight source lang="lua">UI.ToggleDebugUI()</syntaxhighlight> | <syntaxhighlight source lang="lua">UI.ToggleDebugUI(state)</syntaxhighlight> | ||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| state || bool | |||
|} | |||
'''Description''': Toggles the developer debug UI | '''Description''': Toggles the developer debug UI | ||
Line 70: | Line 85: | ||
=== ToggleUIMarkers === | === ToggleUIMarkers === | ||
<syntaxhighlight source lang="lua">UI.ToggleUIMarkers()</syntaxhighlight> | <syntaxhighlight source lang="lua">UI.ToggleUIMarkers(state)</syntaxhighlight> | ||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| state || bool | |||
|} | |||
'''Description''': Show/Hide UI markers for hackable and interactable objects near the player. | '''Description''': Show/Hide UI markers for hackable and interactable objects near the player. | ||
'''Returns''': Nothing | '''Returns''': Nothing | ||
=== ShowHint === | |||
<syntaxhighlight source lang="lua">UI.ShowHint(message, timeout)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| message || string | |||
|- | |||
| timeout || number (optional) | |||
|} | |||
'''Description''': Displays a hint message. Multiple messages will stack on screen but don't go too crazy... | |||
'''Returns''': Nothing | |||
<span style="color:#009000">'''Tip'''</span>: These should mainly be used as additioanl help to the player, outside of the context of the game world. | |||
=== ShowModalMessage === | === ShowModalMessage === | ||
<syntaxhighlight source lang="lua">UI.ShowModalMessage(luaMessage)</syntaxhighlight> | <syntaxhighlight source lang="lua">UI.ShowModalMessage(luaMessage)</syntaxhighlight> | ||
Line 96: | Line 134: | ||
! Name !! Type | ! Name !! Type | ||
|- | |- | ||
| type || OffGridPopup+ | | type || OffGridPopup+PopupTypes | ||
|- | |- | ||
| header || string | | header || string | ||
Line 105: | Line 143: | ||
|} | |} | ||
'''Description''': Displays a small pop up in the centre of the screen | '''Description''': Displays a small pop up in the centre of the screen | ||
'''Returns''': Nothing | |||
=== ShowNotification === | |||
<syntaxhighlight source lang="lua">UI.ShowNotification(type, header, message, timeout)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| type || OffGridNotification+NotificationTypes | |||
|- | |||
| header || string | |||
|- | |||
| message || string | |||
|- | |||
| timeout || number (optional) | |||
|} | |||
'''Description''': Displays a notification pop up in the top right corner of the screen | |||
'''Returns''': Nothing | '''Returns''': Nothing | ||
Line 112: | Line 169: | ||
This file is auto generated, please don't edit manually! | This file is auto generated, please don't edit manually! | ||
'''Docs last hacked together on''': | '''Docs last hacked together on''': 23/07/2020 11:58 | ||
[[Category:Modding]][[Category:LuaAPI]] | [[Category:Modding]][[Category:LuaAPI]] |
Revision as of 13:52, 23 July 2020
UI
Description
The UI API allows modders to control UI elements of the game
Functions
ToggleClock
UI.ToggleClock(state)
Expected parameter types
Name | Type |
---|---|
state | bool |
Description: Toggles the clock hud element
Returns: Nothing
ToggleWeather
UI.ToggleWeather(state)
Expected parameter types
Name | Type |
---|---|
state | bool |
Description: Toggles the weather hud element
Returns: Nothing
SetDataViewState
UI.SetDataViewState(state)
Expected parameter types
Name | Type |
---|---|
state | bool |
Description: Sets the state of the data view
Returns: Nothing
Notes: This can be used for dramatic effect when certain story elements trigger
ToggleDebugUI
UI.ToggleDebugUI(state)
Expected parameter types
Name | Type |
---|---|
state | bool |
Description: Toggles the developer debug UI
Returns: Nothing
Tip: This can be helpful for debugging your mods!
OpenRemoteConnection
UI.OpenRemoteConnection(missionObject)
Expected parameter types
Name | Type |
---|---|
missionObject | MissionObject |
Description: Opens SSH connection to currently targeted device
Returns: Nothing
SetRadialScanState
UI.SetRadialScanState(shouldScan)
Expected parameter types
Name | Type |
---|---|
shouldScan | bool |
Description: Control if the radial menu should be scanning for targets
Returns: Nothing
ToggleUIMarkers
UI.ToggleUIMarkers(state)
Expected parameter types
Name | Type |
---|---|
state | bool |
Description: Show/Hide UI markers for hackable and interactable objects near the player.
Returns: Nothing
ShowHint
UI.ShowHint(message, timeout)
Expected parameter types
Name | Type |
---|---|
message | string |
timeout | number (optional) |
Description: Displays a hint message. Multiple messages will stack on screen but don't go too crazy...
Returns: Nothing
Tip: These should mainly be used as additioanl help to the player, outside of the context of the game world.
ShowModalMessage
UI.ShowModalMessage(luaMessage)
Expected parameter types
Name | Type |
---|---|
luaMessage | Lua Table |
Description: Displays a modal, multiple calls to this will cause a stack of modals the user can click through
Returns: Nothing
Tip: These can be helpful to display story context and tutorialise hacking puzzles
ShowPopUp
UI.ShowPopUp(type, header, message, timeout)
Expected parameter types
Name | Type |
---|---|
type | OffGridPopup+PopupTypes |
header | string |
message | string |
timeout | number (optional) |
Description: Displays a small pop up in the centre of the screen
Returns: Nothing
ShowNotification
UI.ShowNotification(type, header, message, timeout)
Expected parameter types
Name | Type |
---|---|
type | OffGridNotification+NotificationTypes |
header | string |
message | string |
timeout | number (optional) |
Description: Displays a notification pop up in the top right corner of the screen
Returns: Nothing
This file is auto generated, please don't edit manually!
Docs last hacked together on: 23/07/2020 11:58