UI Lua API

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