Devices Lua API: Difference between revisions
No edit summary |
No edit summary |
||
Line 9: | Line 9: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 23: | Line 25: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 34: | Line 38: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 48: | Line 54: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 59: | Line 67: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 71: | Line 81: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 85: | Line 97: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 96: | Line 110: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 110: | Line 126: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 121: | Line 139: | ||
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''': 10/11/2017 11:07 | ||
[[Catagory:Modding]][[Catagory:LuaAPI]] | |||
[[ | |||
[[ |
Revision as of 11:48, 10 November 2017
Devices
Description
The Devices API is used to control the behavior of provided devices in the level kit each of these calls will have a slightly different response to each of these calls. Please see the devices page for a full break down.
Functions
SetPower
Devices.SetPower(deviceName, state)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
state | bool |
Description: Change the powered on state of the device
Returns: Nothing
Notes: See provided devices page to see how each device handles this call
GetPower
Devices.GetPower(deviceName)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
Description: Get the powered on state of the device
Returns: If the device is currently powered on
SetActive
Devices.SetActive(deviceName, state)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
state | bool |
Description: Change the active state of the device
Returns: Nothing
Notes: See provided devices page to see how each device handles this call
GetActive
Devices.GetActive(deviceName)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
Description: Get the active state of the device
Returns: If the device is currently active
RunOnce
Devices.RunOnce(deviceName)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
Description: Trigger a single update of the device
Returns: Nothing
Notes: See provided devices page to see how each device handles this call
SetAmok
Devices.SetAmok(deviceName, state)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
state | bool |
Description: Begin an 'Amok' state, cause the device to act in an unstable/broken manor
Returns: Nothing
Notes: See provided devices page to see how each device handles this call
GetAmok
Devices.GetAmok(deviceName)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
Description: Get the 'Amok' state of the device
Returns: If the device is currently running 'Amok'
SetValue
Devices.SetValue(deviceName, newValue)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
newValue | string |
Description: Pass a string value to the device
Returns: Nothing
Notes: See provided devices page to see how each device handles this call
GetValue
Devices.GetValue(deviceName)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
Description: Get the current value of the device
Returns: The value of the device
This file is auto generated, please don't edit manually!
Docs last hacked together on: 10/11/2017 11:07 Catagory:ModdingCatagory:LuaAPI