Difference between revisions of "Spectrum Lua API"

From Off Grid Wiki
Jump to navigation Jump to search
Line 81: 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''': 06/09/2018 14:53
+
'''Docs last hacked together on''': 15/11/2019 14:59
 
[[Category:Modding]][[Category:LuaAPI]]
 
[[Category:Modding]][[Category:LuaAPI]]

Revision as of 18:15, 19 November 2019

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: 15/11/2019 14:59