Interface IPlotPointDataProvider

Data provider for storing and retrieving various instances of IPlotPointData

Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IPlotPointDataProvider

Methods

AddData<T>(IPlotPointData)

Adds an instance of IPlotPointData to the collection

Declaration
void AddData<T>(IPlotPointData data)
    where T : IPlotPointData
Parameters
Type Name Description
IPlotPointData data
Type Parameters
Name Description
T

IPlotPointData implementation to add

Cleanup()

Clears all data from the provider

Declaration
void Cleanup()

GetAllData<T>()

Retrieves an array of all IPlotPointData of a given type

Declaration
T[] GetAllData<T>()
    where T : class, IPlotPointData
Returns
Type Description
T[]
Type Parameters
Name Description
T

IPlotPointData implementation to retrieve

GetData<T>(String)

Retrieves a single instance of IPlotPointData with a given ID

Declaration
T GetData<T>(string id)
    where T : class, IPlotPointData
Parameters
Type Name Description
String id
Returns
Type Description
T
Type Parameters
Name Description
T

IPlotPointData implementation to retrieve

GetData<T>(String[])

Retrieves an array of IPlotPointData based on a given array of IDs

Declaration
T[] GetData<T>(string[] ids)
    where T : class, IPlotPointData
Parameters
Type Name Description
String[] ids
Returns
Type Description
T[]
Type Parameters
Name Description
T

IPlotPointData implementation to retrieve

RemoveAllData<T>()

Removes all data for the given type T

Declaration
bool RemoveAllData<T>()
    where T : class, IPlotPointData
Returns
Type Description
Boolean

Whether or not the type T could be found to remove
Type Parameters
Name Description
T

RemoveData<T>(IPlotPointData)

Removes cached data of type T

Declaration
bool RemoveData<T>(IPlotPointData data)
    where T : class, IPlotPointData
Parameters
Type Name Description
IPlotPointData data
Returns
Type Description
Boolean

Whether or not any data was removed
Type Parameters
Name Description
T

RemoveData<T>(String)

Removes all cached data with matching id and type T

Declaration
bool RemoveData<T>(string id)
    where T : class, IPlotPointData
Parameters
Type Name Description
String id
Returns
Type Description
Boolean

Whether or not any data was removed
Type Parameters
Name Description
T