Class XURealization

Executes the behaviour of a relation on relationnal objects.

Inheritance

object

XURealization

Namespace: Xareus.Relations.Unity

Assembly: Xareus.Relations.Unity.dll

Syntax

public class XURealization

Properties

AssociatedTypes

All the types associated to this realization

Declaration

public Dictionary<TypeMatch, XUType> AssociatedTypes { get; }

Property Value

Type	Description
Dictionary<TypeMatch, XUType>

GuiToXuRealizationMap

Maps Guids to their corresponding XURealization.

Declaration

public static Dictionary<Guid, XURealization> GuiToXuRealizationMap { get; }

Property Value

Type	Description
Dictionary<Guid, XURealization>

IsBeingDestroyed

Is the realization in the process of being destroyed before the next frame

Declaration

public bool IsBeingDestroyed { get; }

Property Value

Type	Description
bool

IsRunning

Is the Run() method of this realization called

Declaration

public bool IsRunning { get; }

Property Value

Type	Description
bool

RealizationRoot

Lazy create of the root

Declaration

public static Transform RealizationRoot { get; }

Property Value

Type	Description
Transform

RealizationToXuRealizationMap

Maps Realization instances with their XURealization equivalent.

Declaration

public static Dictionary<Realization, XURealization> RealizationToXuRealizationMap { get; }

Property Value

Type	Description
Dictionary<Realization, XURealization>

Relation

The relation

Declaration

public XURelation Relation { get; set; }

Property Value

Type	Description
XURelation

XuRealizationToRealizationMap

Maps XURealization instances with their Realization equivalent.

Declaration

public static Dictionary<XURealization, Realization> XuRealizationToRealizationMap { get; }

Property Value

Type	Description
Dictionary<XURealization, Realization>

guidRealizationMap

Declaration

[Obsolete("Use GuiToXuRealizationMap instead.")]
public static Dictionary<Guid, XURealization> guidRealizationMap { get; }

Property Value

Type	Description
Dictionary<Guid, XURealization>

realizationUfRealizationMap

Declaration

[Obsolete("Use RealizationToXuRealizationMap instead.")]
public static Dictionary<Realization, XURealization> realizationUfRealizationMap { get; }

Property Value

Type	Description
Dictionary<Realization, XURealization>

ufRealizationRealizationMap

Declaration

[Obsolete("Use XuRealizationToRealizationMap instead.")]
public static Dictionary<XURealization, Realization> ufRealizationRealizationMap { get; }

Property Value

Type	Description
Dictionary<XURealization, Realization>

ufRelation

Declaration

[Obsolete("Use Relation instead.")]
public XURelation ufRelation { get; }

Property Value

Type	Description
XURelation

Methods

Create(Realization)

Creates a XURealization instance from its #FIVE equivalent.

Declaration

public static XURealization Create(Realization realization)

Parameters

Type	Name	Description
Realization	realization	The #FIVE equivalent

Returns

Type	Description
XURealization	The XURealization instance

Destroy()

Destroys this realization.

Declaration

public virtual void Destroy()

GetRealization(XURealization)

Get a Realization from its XURealization counterpart

Declaration

public static Realization GetRealization(XURealization xuRealization)

Parameters

Type	Name	Description
XURealization	xuRealization

Returns

Type	Description
Realization

GetXuRealization(Guid)

Get a XURealization from its uid

Declaration

public static XURealization GetXuRealization(Guid id)

Parameters

Type	Name	Description
Guid	id

Returns

Type	Description
XURealization

GetXuRealization(Realization)

Get a XURealization from its Realization counterpart

Declaration

public static XURealization GetXuRealization(Realization realization)

Parameters

Type	Name	Description
Realization	realization

Returns

Type	Description
XURealization

IsRunnable()

Determines whether the behaviour of the relation is runnable.

Declaration

public bool IsRunnable()

Returns

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

Run(Action)

Runs the behaviour of the relation.

Declaration

public void Run(Action resultCallback)

Parameters

Type	Name	Description
Action	resultCallback	Returns on completion.

TryGetRealization(XURealization, out Realization)

Get a Realization from its XURealization counterpart

Declaration

public static void TryGetRealization(XURealization xuRealization, out Realization realization)

Parameters

Type	Name	Description
XURealization	xuRealization
Realization	realization

TryGetXuRealization(Guid, out XURealization)

Get a XURealization from its uid

Declaration

public static void TryGetXuRealization(Guid id, out XURealization xuRealization)

Parameters

Type	Name	Description
Guid	id
XURealization	xuRealization

TryGetXuRealization(Realization, out XURealization)

Get a XURealization from its Realization counterpart

Declaration

public static void TryGetXuRealization(Realization realization, out XURealization xuRealization)

Parameters

Type	Name	Description
Realization	realization
XURealization	xuRealization