Apps

From Off Grid Wiki
Jump to: navigation, search

Apps

Description

App VM

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


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

Docs last hacked together on: 15/11/2019 14:59