Spectrum Lua API: Difference between revisions
(Add Prism Lua API) |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 8: | Line 8: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| dataPoint || DataPoint | | dataPoint || DataPoint | ||
| Line 19: | Line 21: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| dataPoint || DataPoint | | dataPoint || DataPoint | ||
|} | |} | ||
'''Description''': Saves currently targeted data point to the players data inventory | '''Description''': Saves currently targeted data point to the players data inventory | ||
'''Returns''': Nothing | |||
=== FilterClear === | |||
<syntaxhighlight source lang="lua">Spectrum.FilterClear()</syntaxhighlight> | |||
'''Description''': Clear the Filter | |||
'''Returns''': Nothing | |||
=== FilterType (int, bool) === | |||
<syntaxhighlight source lang="lua">Spectrum.FilterType (int, bool)(t, on)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| t || number | |||
|- | |||
| on || bool | |||
|} | |||
'''Description''': Filter which types of Data Spectrum shows | |||
'''Returns''': Nothing | |||
=== FilterCreator === | |||
<syntaxhighlight source lang="lua">Spectrum.FilterCreator(creator)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| creator || DataPoint | |||
|} | |||
'''Description''': Shows only Data from the Creator of the specified DataPoint. Pass nil to clear | |||
'''Returns''': Nothing | |||
=== FilterNetwork === | |||
<syntaxhighlight source lang="lua">Spectrum.FilterNetwork(network)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| network || DataPoint | |||
|} | |||
'''Description''': Shows only Data from the Network of the specified DataPoint. Pass nil to clear | |||
'''Returns''': Nothing | '''Returns''': Nothing | ||
| Line 30: | Line 81: | ||
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]] | |||
Revision as of 13:50, 23 July 2020
Spectrum
Description
The Spectrum api allows the manipulation of data points within the game world
Functions
DeleteDataPoint
Spectrum.DeleteDataPoint(dataPoint)
Expected parameter types
| Name | Type |
|---|---|
| dataPoint | DataPoint |
Description: Deletes the passed in data point
Returns: Nothing
SaveDataPoint
Spectrum.SaveDataPoint(dataPoint)
Expected parameter types
| Name | Type |
|---|---|
| dataPoint | DataPoint |
Description: Saves currently targeted data point to the players data inventory
Returns: Nothing
FilterClear
Spectrum.FilterClear()
Description: Clear the Filter
Returns: Nothing
FilterType (int, bool)
Spectrum.FilterType (int, bool)(t, on)
Expected parameter types
| Name | Type |
|---|---|
| t | number |
| on | bool |
Description: Filter which types of Data Spectrum shows
Returns: Nothing
FilterCreator
Spectrum.FilterCreator(creator)
Expected parameter types
| Name | Type |
|---|---|
| creator | DataPoint |
Description: Shows only Data from the Creator of the specified DataPoint. Pass nil to clear
Returns: Nothing
FilterNetwork
Spectrum.FilterNetwork(network)
Expected parameter types
| Name | Type |
|---|---|
| network | DataPoint |
Description: Shows only Data from the Network of the specified DataPoint. Pass nil to clear
Returns: Nothing
This file is auto generated, please don't edit manually!
Docs last hacked together on: 23/07/2020 11:58