Apps Lua API: Difference between revisions
(Created page with "<!-- This file is auto generated, please don't edit manually! --> = Animator = == Description == Allows the user to set properties of a mission objects Unity animator The...") |
mNo edit summary |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<!-- This file is auto generated, please don't edit manually! --> | <!-- This file is auto generated, please don't edit manually! --> | ||
= | = Apps = | ||
== Description == | == Description == | ||
The Apps API allows modders to control Apps | |||
== Functions == | == Functions == | ||
=== | === RequestAppState === | ||
<syntaxhighlight source lang="lua"> | <syntaxhighlight source lang="lua">Apps.RequestAppState(appName, newState)</syntaxhighlight> | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 13: | Line 11: | ||
! Name !! Type | ! Name !! Type | ||
|- | |- | ||
| | | appName || string | ||
|- | |- | ||
| | | newState || OffGridApp+AppStates | ||
|} | |} | ||
'''Description''': | '''Description''': Ask an App to change it's state | ||
'''Returns''': Nothing | '''Returns''': Nothing | ||
=== | == Global Functions == | ||
<syntaxhighlight source lang="lua"> | === SetState === | ||
<syntaxhighlight source lang="lua">SetState(newState)</syntaxhighlight> | |||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 30: | Line 27: | ||
! Name !! Type | ! Name !! Type | ||
|- | |- | ||
| | | newState || OffGridApp+AppStates | ||
|} | |} | ||
'''Description''': Sets | '''Description''': Sets the App's state. | ||
'''Returns''': Nothing | '''Returns''': Nothing | ||
=== | === CreateStatusWindow === | ||
<syntaxhighlight source lang="lua"> | <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 | |||
'''Description''': | |||
'''Returns''': Nothing | '''Returns''': Nothing | ||
=== | === DisplayStatusWindow === | ||
<syntaxhighlight source lang="lua"> | <syntaxhighlight source lang="lua">DisplayStatusWindow(enabled)</syntaxhighlight> | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 64: | Line 52: | ||
! Name !! Type | ! Name !! Type | ||
|- | |- | ||
| | | enabled || bool | ||
|} | |} | ||
'''Description''': | '''Description''': Show or hide the app's status window. | ||
'''Returns''': Nothing | '''Returns''': Nothing | ||
=== | '''Notes''': Make sure to to create the window first ;) | ||
<syntaxhighlight source lang="lua"> | === UpdateStatusWindow === | ||
<syntaxhighlight source lang="lua">UpdateStatusWindow(text)</syntaxhighlight> | |||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 79: | Line 66: | ||
! Name !! Type | ! Name !! Type | ||
|- | |- | ||
| | | text || string | ||
|} | |} | ||
'''Description''': | '''Description''': Update the text content of the app's status window | ||
'''Returns''': | '''Returns''': Nothing | ||
=== | === SetStatusIcon === | ||
<syntaxhighlight source lang="lua"> | <syntaxhighlight source lang="lua">SetStatusIcon(id)</syntaxhighlight> | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 94: | Line 79: | ||
! Name !! Type | ! Name !! Type | ||
|- | |- | ||
| | | id || number | ||
|} | |} | ||
'''Description''': | '''Description''': Set the icon used for the app's status window | ||
'''Returns''': | '''Returns''': Nothing | ||
=== | '''Notes''': ID should match with an image in your app definition's 'statusIcons' table. | ||
<syntaxhighlight source lang="lua"> | === SetStatusIconColor === | ||
<syntaxhighlight source lang="lua">SetStatusIconColor(color)</syntaxhighlight> | |||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 109: | Line 93: | ||
! Name !! Type | ! Name !! Type | ||
|- | |- | ||
| | | color || Lua Type | ||
|} | |} | ||
'''Description''': | '''Description''': Set the color of the status window icon | ||
'''Returns''': | '''Returns''': Nothing | ||
Line 121: | Line 103: | ||
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''': | '''Docs last hacked together on''': 23/07/2020 11:58 | ||
[[Category:Modding]][[Category:LuaAPI]] | [[Category:Modding]][[Category:LuaAPI]] |
Revision as of 12:21, 23 July 2020
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
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: 23/07/2020 11:58