UI Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
m (Rich moved page Lua Apis/UI Lua API to UI Lua API without leaving a redirect: removing sub-pages)
(Update)
Line 1: Line 1:
<!-- This file is auto generated, please don't edit manually! -->
= UI =
= UI =
== Description ==
== Description ==
Line 31: Line 32:
<syntaxhighlight source lang="lua">UI.ToggleDataView()</syntaxhighlight>
<syntaxhighlight source lang="lua">UI.ToggleDataView()</syntaxhighlight>
'''Description''': Toggles the data view overlay
'''Description''': Toggles the data view overlay
'''Returns''': Nothing
=== ToggleDataSave ===
<syntaxhighlight source lang="lua">UI.ToggleDataSave()</syntaxhighlight>
'''Description''': Toggles the data save app
'''Returns''': Nothing
=== ToggleDataDelete ===
<syntaxhighlight source lang="lua">UI.ToggleDataDelete()</syntaxhighlight>
'''Description''': Toggles the data delete app


'''Returns''': Nothing
'''Returns''': Nothing
Line 56: Line 45:
<syntaxhighlight source lang="lua">UI.ToggleRemoteConnection()</syntaxhighlight>
<syntaxhighlight source lang="lua">UI.ToggleRemoteConnection()</syntaxhighlight>
'''Description''': Toggles the SSH remote connection app
'''Description''': Toggles the SSH remote connection app
'''Returns''': Nothing
=== OpenRemoteConnection ===
<syntaxhighlight source lang="lua">UI.OpenRemoteConnection()</syntaxhighlight>
'''Description''': Opens SSH connection to currently targeted device
'''Returns''': Nothing
=== ToggleRadialApp ===
<syntaxhighlight source lang="lua">UI.ToggleRadialApp()</syntaxhighlight>
'''Description''': Use Radial menu from 3rd person mode
'''Returns''': Nothing
=== ToggleUIMarkers ===
<syntaxhighlight source lang="lua">UI.ToggleUIMarkers()</syntaxhighlight>
'''Description''': Show/Hide UI markers for hackable and interactable objects near the player.


'''Returns''': Nothing
'''Returns''': Nothing
Line 71: Line 78:


<span style="color:#009000">'''Tip'''</span>: These can be helpful to display story context and tutorialise hacking puzzles
<span style="color:#009000">'''Tip'''</span>: These can be helpful to display story context and tutorialise hacking puzzles
=== ShowPopUp ===
<syntaxhighlight source lang="lua">UI.ShowPopUp(type, header, message, timeout)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
| 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''': 09/05/2017 13:09
'''Docs last hacked together on''': 13/09/2017 14:00

Revision as of 13:03, 13 September 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

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