UI Lua API

UI

Description

The UI API allows modders to control UI elements of the game

Functions

ToggleClock

UI.ToggleClock()

Description: Toggles the clock hud element

Returns: Nothing

ToggleWeather

UI.ToggleWeather()

Description: Toggles the weather hud element

Returns: Nothing

ToggleLightMonitor

UI.ToggleLightMonitor()

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()

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()

Description: Show/Hide UI markers for hackable and interactable objects near the player.

Returns: Nothing

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

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

Docs last hacked together on: 10/11/2017 11:58