Apps Lua API

From Off Grid Wiki
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.

Apps

Description

The Apps API allows modders to control Apps

Functions

RequestAppState

Apps.RequestAppState(appName, newState)

Expected parameter types

Name Type
appName string
newState OffGridApp+AppStates

Description: Ask an App to change it's state

Returns: Nothing

Console_OutputLine

Apps.Console_OutputLine(appName, outputString)

Expected parameter types

Name Type
appName string
outputString string

Description: Output a line to the terminal UI

Returns: Nothing

Global Functions

SetState

SetState(newState)

Expected parameter types

Name Type
newState OffGridApp+AppStates

Description: Sets the App's state.

Returns: Nothing

CreateStatusWindow

CreateStatusWindow()

Description: Create the status window

Returns: Nothing

RemoveStatusWindow

RemoveStatusWindow()

Description: Remove this app's status window

Returns: Nothing

DisplayStatusWindow

DisplayStatusWindow(enabled)

Expected parameter types

Name Type
enabled bool

Description: Show or hide the app's status window.

Returns: Nothing

Notes: Make sure to to create the window first ;)

UpdateStatusWindow

UpdateStatusWindow(text)

Expected parameter types

Name Type
text string

Description: Update the text content of the app's status window

Returns: Nothing

SetStatusIcon

SetStatusIcon(id)

Expected parameter types

Name Type
id number

Description: Set the icon used for the app's status window

Returns: Nothing

Notes: ID should match with an image in your app definition's 'statusIcons' table.

SetStatusIconColor

SetStatusIconColor(color)

Expected parameter types

Name Type
color Lua Type

Description: Set the color of the status window icon

Returns: Nothing

CreateAppWindow

CreateAppWindow(title, backgroundImagePath)

Expected parameter types

Name Type
title string
backgroundImagePath string

Description: Initialize the AppWindow for this App

Returns: Nothing

RemoveAppWindow

RemoveAppWindow()

Description: Reset the AppWindow

Returns: Nothing

ShowAppWindow

ShowAppWindow()

Description: Make the AppWindow visible (rember to create the window first!)

Returns: Nothing

HideAppWindow

HideAppWindow()

Description: Hide the app window.

Returns: Nothing

SetAppWindowContent

SetAppWindowContent(content)

Expected parameter types

Name Type
content string

Description: Set the content text of the AppWindow

Returns: Nothing

ShowAppWindowProgress

ShowAppWindowProgress(display)

Expected parameter types

Name Type
display bool

Description: Show (or hide) a progress bar on the AppWindow

Returns: Nothing

SetAppWindowProgress

SetAppWindowProgress(progress)

Expected parameter types

Name Type
progress number

Description: Set the progres on the AppWindow progress bar (remember to use 'ShowAppWindowProgress(true)' first to enable it!)

Returns: Nothing

StartLuaCoroutine

StartLuaCoroutine(dynValue)

Expected parameter types

Name Type
dynValue Lua Type

Description: ...

Returns: Nothing


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

Docs last hacked together on: 29/08/2023 16:24