UI Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(adding DocStart)
(removing DocStart tag)
Line 1: Line 1:
{OffGridDocStart}}
= UI =
= UI =
== Description ==
== Description ==

Revision as of 17:00, 26 June 2017

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

ToggleDataSave

UI.ToggleDataSave()

Description: Toggles the data save app

Returns: Nothing

ToggleDataDelete

UI.ToggleDataDelete()

Description: Toggles the data delete app

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

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


Docs last hacked together on: 09/05/2017 13:09