Apps Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
= Apps =
= Apps =
== Description ==
== Description ==
The Apps API allows modders to control Apps
App VM
== Functions ==
== Global Functions ==
=== RequestAppState ===
=== SetState ===
<syntaxhighlight source lang="lua">Apps.RequestAppState(appName, newState)</syntaxhighlight>
<syntaxhighlight source lang="lua">SetState(newState)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
Line 11: Line 11:
! Name !! Type
! Name !! Type
|-
|-
| appName || string
| newState || OffGridApp+AppStates
|}
'''Description''': Sets the App's state.
 
'''Returns''': Nothing
 
=== CreateStatusWindow ===
<syntaxhighlight source lang="lua">CreateStatusWindow()</syntaxhighlight>
'''Description''': Create the status window
 
'''Returns''': Nothing
 
=== RemoveStatusWindow ===
<syntaxhighlight source lang="lua">RemoveStatusWindow()</syntaxhighlight>
'''Description''': Remove this app's status window
 
'''Returns''': Nothing
 
=== DisplayStatusWindow ===
<syntaxhighlight source lang="lua">DisplayStatusWindow(enabled)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
|-
| newState || OffGridApp+AppStates
| enabled || bool
|}
'''Description''': Show or hide the app's status window.
 
'''Returns''': Nothing
 
'''Notes''': Make sure to to create the window first ;)
=== UpdateStatusWindow ===
<syntaxhighlight source lang="lua">UpdateStatusWindow(text)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| text || string
|}
'''Description''': Update the text content of the app's status window
 
'''Returns''': Nothing
 
=== SetStatusIcon ===
<syntaxhighlight source lang="lua">SetStatusIcon(id)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! 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 ===
<syntaxhighlight source lang="lua">SetStatusIconColor(color)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| color || Lua Type
|}
|}
'''Description''': Ask an App to change it's state
'''Description''': Set the color of the status window icon


'''Returns''': Nothing
'''Returns''': Nothing
Line 23: Line 87:
This file is auto generated, please don't edit manually!
This file is auto generated, please don't edit manually!


'''Docs last hacked together on''': 08/03/2019 13:51
'''Docs last hacked together on''': 15/11/2019 14:59
[[Category:Modding]][[Category:LuaAPI]]
[[Category:Modding]][[Category:LuaAPI]]

Revision as of 15:24, 16 November 2019

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