DataParameter_Collection

A resizable mixed-type collection of data parameters. Elements are accessed via a string address.

Properties

int Count

• The amount of data parameters stored in this collection.

Methods

void Add(string parameterAddress, DataParameterBase dataParameter, bool formatName)

• Adds the given data parameter to the collection, accessible at the given parameter address.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• dataParameter The data parameter value to add.

• formatName Whether or not to format the data parameter address.

void AddRange(bool formatNames, params (string, DataParameterBase)[] values)

• Adds a range of data parameters to the collection accessible by the associated parameter address.

• Can optionally specify formatting the addresses or not. Defaults to true.

• formatNames Whether or not to format the data parameter addresses.

  • values The data parameters to add and their respective addresses.

void Clear()

• Clears the data parameter collection of all values.

void Remove(string parameterAddress, bool formatName)

• Removes the value at the specified address from the collection.

• parameterAddress The address to remove at.

• formatName Whether or not to format the data parameter address.

void SetParameters(bool addIfNonExistent, bool formatNames, params (string, DataParameterBase)[] values)

• Sets a range of data parameter values in this collection.

• Can specify if values should be added if the addresses don't exist in the collection.

• Can optionally specify formatting the addresses or not. Defaults to true.

• addIfNonExistent Whether or not to create new entries if the address doesn't exist in the collection.

• formatNames Whether or not to format the data parameter addresses.

• values The data parameters to set and their respective addresses.

void SetParameter(string parameterAddress, DataParameterBase dataParameter, bool addIfNonExistent, bool formatName)

• Sets a data parameter value in this collection.

• Can specify if a new entry should be added if the address doesn't exist in the collection.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• dataParameter The data parameter value to set.

• addIfNonExistent Whether or not to create a new entry if the address doesn't exist in the collection.

• formatNames Whether or not to format the data parameter address.

void SetParameterValue<T>(string parameterAddress, T value, bool addIfNonExistent, bool formatName)

• Assigns a value of type T to a DataParameter<T> at the given address.

• Can specify if a new entry should be added if the address doesn't exist in the collection.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• value The value to assign.

• addIfNonExistent Whether or not to create a new entry if the address doesn't exist in the collection.

• formatNames Whether or not to format the data parameter address.

DataParameter<T> GetParameterOfValue<T>(string parameterAddress, bool formatName)

• Gets a DataParameter<T> instance at the given address.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• formatNames Whether or not to format the data parameter address.

DataParameterBase GetParameter(string parameterAddress, bool formatName)

• Gets a data parameter instance at the given address.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• formatNames Whether or not to format the data parameter address.

T GetParameterOfType<T>(string parameterAddress, bool formatName)

• Gets a data parameter instance as type T at the given address.

• The type T must inherit from SurvivEngine.DataParameterBase.

  • Can optionally specify formatting the address or not. Defaults to true.

  • parameterAddress The address the data parameter is accessible at.

  • formatNames Whether or not to format the data parameter address.

T GetParameterValue<T>(string parameterAddress, bool formatName)

• Gets the type T value of a DataParameter<T> instance at the given address.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• formatNames Whether or not to format the data parameter address.

bool HasParameter(string parameterName, bool formatName)

• Indicates whether this collection has an entry for the given address.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address to check.

• formatNames Whether or not to format the data parameter address.

bool TryGetParameterOfType<T>(string parameterAddress, out T dataParameter, bool formatName)

• Attempts to get a data parameter instance as type T at the given address.

• The type T must inherit from SurvivEngine.DataParameterBase.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• dataParameter The data parameter value found.

• formatNames Whether or not to format the data parameter address.

bool TryGetParameterOfValue<T>(string parameterAddress, out DataParameter<T> dataParameter, bool formatName)

• Attempts to get a DataParameter<T> instance at the given address.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• dataParameter The data parameter value found.

• formatNames Whether or not to format the data parameter address.

bool TryGetParameter(string parameterAddress, out DataParameterBase dataParameter, bool formatName)

• Attempts to get a data parameter instance at the given address.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• dataParameter The data parameter value found.

• formatNames Whether or not to format the data parameter address.

bool TryGetParameterValue<T>(string parameterAddress, out T value, bool formatName)

• Attempts to get a type T value of a DataParameter<T> instance at the given address.

• Can optionally specify formatting the address or not. Defaults to true.

• parameterAddress The address the data parameter is accessible at.

• value The value found.

• formatNames Whether or not to format the data parameter address.