Class RuntimeScenarioFileRegistry

The runtime scenario file registry is used to keep track of the scenario files used at runtime, including external scenarios

Inheritance

object

Object

ScriptableObject

RuntimeScenarioFileRegistry

Namespace: Xareus.Scenarios.Unity

Assembly: Xareus.Scenarios.Unity.dll

Syntax

public class RuntimeScenarioFileRegistry : ScriptableObject

Fields

scenarioFilesUsed

Declaration

[SerializeField]
protected List<AdditionalScenarioFile> scenarioFilesUsed

Field Value

Type	Description
List<AdditionalScenarioFile>

Properties

Instance

Declaration

public static RuntimeScenarioFileRegistry Instance { get; }

Property Value

Type	Description
RuntimeScenarioFileRegistry

RegistryAssetExists

Declaration

public static bool RegistryAssetExists { get; }

Property Value

Type	Description
bool

Methods

AddScenarioFileUsed(AdditionalScenarioFile)

Add a scenario file to the list of scenario files used

Declaration

public void AddScenarioFileUsed(AdditionalScenarioFile additionalScenarioFile)

Parameters

Type	Name	Description
AdditionalScenarioFile	additionalScenarioFile

AddScenarioFilesUsed(IEnumerable<AdditionalScenarioFile>)

Add a list of scenario files to the list of scenario files used

Declaration

public void AddScenarioFilesUsed(IEnumerable<AdditionalScenarioFile> additionalScenarioFiles)

Parameters

Type	Name	Description
IEnumerable<AdditionalScenarioFile>	additionalScenarioFiles

Clear()

Declaration

public void Clear()

GetScenarioFile(TextAsset)

Get the scenario file record corresponding to a text asset

Declaration

public AdditionalScenarioFile GetScenarioFile(TextAsset textAsset)

Parameters

Type	Name	Description
TextAsset	textAsset

Returns

Type	Description
AdditionalScenarioFile

OnAfterDeserialize()

Implement this callback to transform data back into runtime data types after an object is deserialized.

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

Implement this callback to transform data into serializable data types immediately before an object is serialized.

Declaration

public void OnBeforeSerialize()

RefreshDerivedData()

Declaration

public void RefreshDerivedData()