Difference between revisions of "Data Points Lua Api"

From Off Grid Wiki
Jump to navigation Jump to search
(Created page with "<!-- This file is auto generated, please don't edit manually! --> = DataPoints = == Description == The DataPoints API returns and manage the wanted available data points == Fu...")
 
m
 
Line 122: Line 122:
 
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''': 25/02/2020 12:19
+
'''Docs last hacked together on''': 23/07/2020 11:58
 
[[Category:Modding]][[Category:LuaAPI]]
 
[[Category:Modding]][[Category:LuaAPI]]

Latest revision as of 12:30, 23 July 2020

DataPoints

Description

The DataPoints API returns and manage the wanted available data points

Functions

GetAllDataPoints

DataPoints.GetAllDataPoints()

Description: Return all the data points that are currently in the level

Returns: System.Collections.Generic.List`1[DataPoint]

GetObjectDataPoints

DataPoints.GetObjectDataPoints(objectName)

Expected parameter types

Name Type
objectName string

Description: Return all the data points received by an object or a character

Returns: System.Collections.Generic.List`1[DataPoint]

FilterNetwork

DataPoints.FilterNetwork(dataPoints, networkName)

Expected parameter types

Name Type
dataPoints System.Collections.Generic.List`1[DataPoint]
networkName string

Description: Filter data points with the network name

Returns: System.Collections.Generic.List`1[DataPoint]

FilterDataType

DataPoints.FilterDataType(dataPoints, dataType)

Expected parameter types

Name Type
dataPoints System.Collections.Generic.List`1[DataPoint]
dataType string

Description: Filter data points with the data type

Returns: System.Collections.Generic.List`1[DataPoint]

DeleteDataPoints

DataPoints.DeleteDataPoints(dataPoints)

Expected parameter types

Name Type
dataPoints System.Collections.Generic.List`1[DataPoint]

Description: Remove data points from the level

Returns: Nothing

GetData

DataPoints.GetData(dataPoints)

Expected parameter types

Name Type
dataPoints System.Collections.Generic.List`1[DataPoint]

Description: Return all the data string from the given data points

Returns: System.String[]

GetDataPointInfo

DataPoints.GetDataPointInfo(dataPoints)

Expected parameter types

Name Type
dataPoints System.Collections.Generic.List`1[DataPoint]

Description: Return all the data info from the given data points

Returns: System.Collections.Generic.List`1[DataPointInfo]

PlayersInventorySave

DataPoints.PlayersInventorySave(dataFile)

Expected parameter types

Name Type
dataFile DataPointInfo

Description: Save data info in the the players inventory

Returns: Nothing

PlayersInventoryRemove

DataPoints.PlayersInventoryRemove(dataFile)

Expected parameter types

Name Type
dataFile DataPointInfo

Description: Save data info in the the players inventory

Returns: Nothing


This file is auto generated, please don't edit manually!

Docs last hacked together on: 23/07/2020 11:58