UI Lua API

From Off Grid Wiki
Revision as of 13:03, 13 September 2017 by Harry (talk | contribs) (Update)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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

TurnOffDataView

UI.TurnOffDataView()

Description: Turns off the data view overlay

Returns: Nothing

Notes: This can be used for dramatic effect when certain story elements trigger

ToggleDataView

UI.ToggleDataView()

Description: Toggles the data view overlay

Returns: Nothing

ToggleDebugUI

UI.ToggleDebugUI()

Description: Toggles the developer debug UI

Returns: Nothing

Tip: This can be helpful for debugging your mods!

ToggleRemoteConnection

UI.ToggleRemoteConnection()

Description: Toggles the SSH remote connection app

Returns: Nothing

OpenRemoteConnection

UI.OpenRemoteConnection()

Description: Opens SSH connection to currently targeted device

Returns: Nothing

ToggleRadialApp

UI.ToggleRadialApp()

Description: Use Radial menu from 3rd person mode

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

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

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: 13/09/2017 14:00