Class TypeWithScenario

A Xareus Type that embed a scenario. Implements IContext to allow the scenario to store and retrieve objects. Implements IRealizationManager to allow (Any)RelationSensor and RelationEffector to read/write Relations. Implements ITypeDescriptorContext for type conversion

Inheritance

object

TypeWithScenario

Implements

IObjectType

IContext

Inherited Members

XUType.id

XUType.xuObject

XUType.relationType

XUType.XuObject

XUType.UFObject

XUType.Type

XUType.Name

XUType.Owner

XUType.ToString()

XUType.GenerateNewId()

XUType.XuTypeRemovedEvent

XUType.OnEnable()

XUType.OnValidate()

XUType.OnDisable()

Namespace: Xareus.Relations.Scenarios.Unity

Assembly: Xareus.Relations.Scenarios.Unity.dll

Syntax

[RequireComponent(typeof(XUObject))]
[RequireComponent(typeof(ScenarioRunner))]
public class TypeWithScenario : XUType, IObjectType, IContext

Fields

ENVIRONMENT_ENTRY

Declaration

public const string ENVIRONMENT_ENTRY = "Environment"

Field Value

Type	Description
string

RELATION_ENGINE_ENTRY

Declaration

public const string RELATION_ENGINE_ENTRY = "RelationEngine"

Field Value

Type	Description
string

ScenarioRunner

The component that will run the scenario.

Declaration

public ScenarioRunner ScenarioRunner

Field Value

Type	Description
ScenarioRunner

XUOBJECT_ENTRY

Declaration

public const string XUOBJECT_ENTRY = "XUObject"

Field Value

Type	Description
string

XUOBJECT_ID_ENTRY

Declaration

public const string XUOBJECT_ID_ENTRY = "XUObjectId"

Field Value

Type	Description
string

Properties

Container

Declaration

public IContainer Container { get; }

Property Value

Type	Description
IContainer

Engine

The scenario engine.

Declaration

public Scenario Engine { get; }

Property Value

Type	Description
Scenario

Environment

Direct access to the global Environment.

Declaration

[SharedExternalContextEntry("Environment")]
public static Environment Environment { get; }

Property Value

Type	Description
Environment

Instance

Declaration

public object Instance { get; }

Property Value

Type	Description
object

PropertyDescriptor

Declaration

public PropertyDescriptor PropertyDescriptor { get; }

Property Value

Type	Description
PropertyDescriptor

RelationEngine

Direct access to the RelationEngine.

Declaration

[SharedExternalContextEntry("RelationEngine")]
public IEngine RelationEngine { get; }

Property Value

Type	Description
IEngine

Types

Direct access to other Types.

Declaration

public IEnumerable<XUType> Types { get; }

Property Value

Type	Description
IEnumerable<XUType>

XuObjectEntry

Declaration

[LocalExternalContextEntry("XUObject")]
protected XUObject XuObjectEntry { get; }

Property Value

Type	Description
XUObject

XuObjectId

Declaration

[LocalExternalContextEntry("XUObjectId")]
protected string XuObjectId { get; }

Property Value

Type	Description
string

Methods

Awake()

Declaration

protected virtual void Awake()

Clear()

Declaration

public void Clear()

CreateScenarioLoadingParameters()

Create the scenario loading parameters

Declaration

protected virtual ScenarioLoadingParameters CreateScenarioLoadingParameters()

Returns

Type	Description
ScenarioLoadingParameters

GetPaths()

Declaration

public IEnumerable<string> GetPaths()

Returns

Type	Description
IEnumerable<string>

GetService(Type)

Declaration

public object GetService(Type serviceType)

Parameters

Type	Name	Description
Type	serviceType

Returns

Type	Description
object

GetValue(string)

Declaration

public object GetValue(string path)

Parameters

Type	Name	Description
string	path

Returns

Type	Description
object

GetValueOrDefault(string, object)

Declaration

public object GetValueOrDefault(string path, object defaultValue = null)

Parameters

Type	Name	Description
string	path
object	defaultValue

Returns

Type	Description
object

HasPath(string)

Declaration

public bool HasPath(string path)

Parameters

Type	Name	Description
string	path

Returns

Type	Description
bool

OnComponentChanged()

Declaration

public void OnComponentChanged()

OnComponentChanging()

Declaration

public bool OnComponentChanging()

Returns

Type	Description
bool

SetValue(string, object)

Declaration

public void SetValue(string path, object value)

Parameters

Type	Name	Description
string	path
object	value

Union(string, IContext)

Declaration

public void Union(string path, IContext other)

Parameters

Type	Name	Description
string	path
IContext	other

Union(IContext, bool)

Declaration

public void Union(IContext other, bool overrideDuplicates = true)

Parameters

Type	Name	Description
IContext	other
bool	overrideDuplicates

Implements

IObjectType

IContext