UI Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 44: Line 44:


'''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 ===
<syntaxhighlight source lang="lua">UI.ToggleDebugUI(state)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| state || bool
|}
'''Description''': Toggles the developer debug UI
'''Returns''': Nothing
<span style="color:#009000">'''Tip'''</span>: This can be helpful for debugging your mods!
=== OpenRemoteConnection ===
=== OpenRemoteConnection ===
<syntaxhighlight source lang="lua">UI.OpenRemoteConnection(missionObject)</syntaxhighlight>
<syntaxhighlight source lang="lua">UI.OpenRemoteConnection(missionObject)</syntaxhighlight>
Line 112: Line 98:
'''Returns''': Nothing
'''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.  
<span style="color:#009000">'''Tip'''</span>: These should mainly be used as additional 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 122: Line 108:
| luaMessage || Lua Table
| luaMessage || Lua Table
|}
|}
'''Description''': Displays a modal, multiple calls to this will cause a stack of modals the user can click through
'''Description''': Displays a modal window with text filed, an optional picture, confirm button & optional cancel button.


'''Returns''': Nothing
'''Returns''': Nothing


<span style="color:#009000">'''Tip'''</span>: These can be helpful to display story context and tutorialise hacking puzzles
=== ShowPopup ===
=== ShowPopUp ===
<syntaxhighlight source lang="lua">UI.ShowPopup(type, header, message, timeout)</syntaxhighlight>
<syntaxhighlight source lang="lua">UI.ShowPopUp(type, header, message, timeout)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
Line 142: Line 127:
| timeout || number (optional)
| timeout || number (optional)
|}
|}
'''Description''': Displays a small pop up in the centre of the screen
'''Description''': Displays a small popup window in the centre of the screen


'''Returns''': Nothing
'''Returns''': Nothing
Line 161: Line 146:
| timeout || number (optional)
| timeout || number (optional)
|}
|}
'''Description''': Displays a notification pop up in the top right corner of the screen
'''Description''': Displays a notification popup in the top right corner of the screen
 
'''Returns''': Nothing
 
=== ShowPopupMenu ===
<syntaxhighlight source lang="lua">UI.ShowPopupMenu(table)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| table || Lua Table
|}
'''Description''': Opens a popup menu with multiple options


'''Returns''': Nothing
'''Returns''': Nothing
Line 169: Line 167:
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''': 15/11/2019 14:59
'''Docs last hacked together on''': 29/08/2023 16:24
[[Category:Modding]][[Category:LuaAPI]]
[[Category:Modding]][[Category:LuaAPI]]

Latest revision as of 14:47, 20 November 2023

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

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 additional 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 window with text filed, an optional picture, confirm button & optional cancel button.

Returns: Nothing

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 popup window 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 popup in the top right corner of the screen

Returns: Nothing

ShowPopupMenu

UI.ShowPopupMenu(table)

Expected parameter types

Name Type
table Lua Table

Description: Opens a popup menu with multiple options

Returns: Nothing


This file is auto generated, please don't edit manually!

Docs last hacked together on: 29/08/2023 16:24