Class XURelation

Defines a behaviour between relationnal objets. Their types must be defined as fields and decorated with ObjectPatternAttribute. Prototype relations and cloned relations (executed in XURealization) stand out.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

IdentifiableBehaviour

XURelation

Implements

IRelation

Inherited Members

IdentifiableBehaviour.id

IdentifiableBehaviour.Id

IdentifiableBehaviour.GetIdentifiable(string)

IdentifiableBehaviour.HasIdentifiable(string)

IdentifiableBehaviour.Equals(object)

IdentifiableBehaviour.GetHashCode()

IdentifiableBehaviour.OnValidate()

IdentifiableBehaviour.GenerateNewId()

IdentifiableBehaviour.FreeId()

IdentifiableBehaviour.OnIdChanged(string)

IdentifiableBehaviour.DefaultId()

Namespace: Xareus.Relations.Unity

Assembly: Xareus.Relations.Unity.dll

Syntax

[DisallowMultipleComponent]
[OverrideClass("Xareus.Relations.Relation", "Xareus.Relations")]
[OverrideClass("FIVE.Relations.Relation,FIVE.Relations")]
public abstract class XURelation : IdentifiableBehaviour, IRelation

Fields

OnRelationExecuted

Called with the given ResultCallback of the Run(Action)

Declaration

public static Action<XURelation> OnRelationExecuted

Field Value

Type	Description
Action<XURelation>

Examples

You can listen to this event from anywhere using the following example:

private void OnEnable()
{
    XURelation.OnRelationExecuted += OnRelationExecuted;
}

private void OnDisable()
{
    XURelation.OnRelationExecuted -= OnRelationExecuted;
}

private void OnRelationExecuted(XURelation relation)
{
    Debug.Log($"OnRelationExecuted event received from {relation.id}");
}

idXuObjectPatternMap

Maps the object patterns of this relation with their identifier.

Declaration

protected Dictionary<string, XUObjectPattern> idXuObjectPatternMap

Field Value

Type	Description
Dictionary<string, XUObjectPattern>

registered

Declaration

[HideInInspector]
protected bool registered

Field Value

Type	Description
bool

Properties

IdXuObjectPatternMap

Maps the object patterns of this relation with their identifier.

Declaration

public IReadOnlyDictionary<string, XUObjectPattern> IdXuObjectPatternMap { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, XUObjectPattern>

InRealization

If this instance is used in a realization

Declaration

public bool InRealization { get; set; }

Property Value

Type	Description
bool

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

ObjectPatterns

Declaration

public HashSet<ObjectPattern> ObjectPatterns { get; set; }

Property Value

Type	Description
HashSet<ObjectPattern>

RegisteredRelations

Gets all relations that are registered in the relation engine

Declaration

public static IEnumerable<IRelation> RegisteredRelations { get; }

Property Value

Type	Description
IEnumerable<IRelation>

Relation

The Xareus relation corresponding to this Relation

Declaration

public IRelation Relation { get; }

Property Value

Type	Description
IRelation

RelationNameToXuRelationMap

Maps relations names to their corresponding XURelation.

Declaration

public static IReadOnlyDictionary<string, XURelation> RelationNameToXuRelationMap { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, XURelation>

RelationToXuRelationMap

Maps IRelation relations instances with their XURelation equivalent.

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this property")]
public static IReadOnlyDictionary<IRelation, XURelation> RelationToXuRelationMap { get; }

Property Value

Type	Description
IReadOnlyDictionary<IRelation, XURelation>

XuRelationToRelationMap

Maps XURelation instances with their IRelation equivalent.

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this property")]
public static IReadOnlyDictionary<XURelation, IRelation> XuRelationToRelationMap { get; }

Property Value

Type	Description
IReadOnlyDictionary<XURelation, IRelation>

relationNameUfRelationMap

Declaration

[Obsolete("Use RelationNameToXuRelationMap instead.")]
public static IReadOnlyDictionary<string, XURelation> relationNameUfRelationMap { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, XURelation>

relationUfRelationMap

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this property")]
public static IReadOnlyDictionary<IRelation, XURelation> relationUfRelationMap { get; }

Property Value

Type	Description
IReadOnlyDictionary<IRelation, XURelation>

ufRelationRelationMap

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this property")]
public static IReadOnlyDictionary<XURelation, IRelation> ufRelationRelationMap { get; }

Property Value

Type	Description
IReadOnlyDictionary<XURelation, IRelation>

Methods

Awake()

Called in play mode

Declaration

protected override void Awake()

Overrides

IdentifiableBehaviour.Awake()

GetCoreRelation(XURelation)

Get a core Xareus relation from its Unity Counterpart

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this method")]
public static IRelation GetCoreRelation(XURelation xuRelation)

Parameters

Type	Name	Description
XURelation	xuRelation

Returns

Type	Description
IRelation

GetXuRelation(string)

Get a relation from its Id

Declaration

public static XURelation GetXuRelation(string id)

Parameters

Type	Name	Description
string	id

Returns

Type	Description
XURelation

GetXuRelation(IRelation)

Get a Unity relation from its Xareus Core counterpart

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this method")]
public static XURelation GetXuRelation(IRelation relation)

Parameters

Type	Name	Description
IRelation	relation

Returns

Type	Description
XURelation

IsRunnable()

Determines whether the behaviour is runnable.

Declaration

public abstract bool IsRunnable()

Returns

Type	Description
bool	true whether the behaviour is runnable; false otherwise

OnEnable()

Declaration

protected virtual void OnEnable()

Register()

Declaration

public void Register()

RelationsToXuRelations(IEnumerable<IRelation>)

Converts a collection of Xareus Core relations to their XURelation counterparts

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this method")]
public static IEnumerable<XURelation> RelationsToXuRelations(IEnumerable<IRelation> relations)

Parameters

Type	Name	Description
IEnumerable<IRelation>	relations

Returns

Type	Description
IEnumerable<XURelation>

Run(Action)

Runs the behaviour.

Declaration

public abstract void Run(Action resultCallback)

Parameters

Type	Name	Description
Action	resultCallback	Returns on completion.

Stop()

Stops a running behaviour. Does nothing whether it is not running.

Declaration

public virtual void Stop()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

UnityEngine.Object.ToString()

TryGetCoreRelation(XURelation, out IRelation)

Get a Xareus Core relation from its Unity Counterpart

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this method")]
public static void TryGetCoreRelation(XURelation xuRelation, out IRelation relation)

Parameters

Type	Name	Description
XURelation	xuRelation
IRelation	relation

TryGetXuRelation(string, out XURelation)

Get a relation from its Id

Declaration

public static void TryGetXuRelation(string id, out XURelation xuRelation)

Parameters

Type	Name	Description
string	id
XURelation	xuRelation

TryGetXuRelation(IRelation, out XURelation)

Get a Unity relation from its Xareus Core counterpart

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this method")]
public static void TryGetXuRelation(IRelation relation, out XURelation xuRelation)

Parameters

Type	Name	Description
IRelation	relation
XURelation	xuRelation

Unregister()

unregisters the current relation

Declaration

public void Unregister()

XuRelationsToRelations(IEnumerable<XURelation>)

Converts a collection of XURelation to their IRelation counterparts

Declaration

[Obsolete("Relations are now equivalent, you can remove the usage of this method")]
public static IEnumerable<IRelation> XuRelationsToRelations(IEnumerable<XURelation> xuRelations)

Parameters

Type	Name	Description
IEnumerable<XURelation>	xuRelations

Returns

Type	Description
IEnumerable<IRelation>

Implements

IRelation