Class UnityEventSensor

Inheritance

object

AFunction

ASensor

AUnitySensor

UnityEventSensor

Inherited Members

AUnitySensor.Reset()

AUnitySensor.Init()

AUnitySensor.SafePostCheck()

AUnitySensor.PostCheck()

AUnitySensor.StopCheck()

AUnitySensor.SensorCheck()

AUnitySensor.FillParameters()

AUnitySensor.UnityThreadFillParameters()

AUnitySensor.UpdateScenario()

ASensor.NEGATE_PARAMETER

ASensor.Check(IContext)

ASensor.SetContexts(IContext)

ASensor.SetInputEventContext(IContext)

ASensor.Event

ASensor.externalContext

ASensor.scenarioContext

ASensor.sequenceContext

ASensor.inputEventContext

ASensor.Negate

AFunction.UpdateContexts(ContextHolder)

AFunction.SetParameters(Dictionary<string, Parameter>)

AFunction.Parameters

AFunction.Contexts

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Xareus.Scenarios.Unity

Assembly: Xareus.Unity.Libraries.dll

Syntax

[FunctionDescription("This sensor can be activated by a unity event trigerred from a component.")]
public class UnityEventSensor : AUnitySensor

Constructors

UnityEventSensor(Event, Dictionary<string, Parameter>, ContextHolder)

Declaration

public UnityEventSensor(Event @event, Dictionary<string, Parameter> parameters, ContextHolder contexts)

Parameters

Type	Name	Description
Event	event
Dictionary<string, Parameter>	parameters
ContextHolder	contexts

Fields

ARITY_WARNING_MESSAGE

Declaration

protected const string ARITY_WARNING_MESSAGE = "ValuesToCheck count does not match event arity."

Field Value

Type	Description
string

COMPONENT

Declaration

protected const string COMPONENT = "Component"

Field Value

Type	Description
string

Component

Declaration

[ConfigurationParameter("Component", Necessity.Required)]
protected Component Component

Field Value

Type	Description
Component

EVENT

Declaration

protected const string EVENT = "Event"

Field Value

Type	Description
string

Triggered

Declaration

protected bool Triggered

Field Value

Type	Description
bool

UnityEventField

Declaration

[ConfigurationParameter("Event", Necessity.Required)]
[Provider("Component")]
[ProvideConstraint(typeof(UnityEventBase))]
[ProvideConstraint(FieldType.Unity)]
protected FieldInfo UnityEventField

Field Value

Type	Description
FieldInfo

ValuesToCheck

Declaration

[ConfigurationParameter("ValuesToCheck", "Values to check against the event. You must provide as many values as the event contains", Necessity.Optional)]
[Provider("Event")]
protected List<object> ValuesToCheck

Field Value

Type	Description
List<object>

Methods

SafeReset()

Reset a sensor. Note that this code will be executed in unity's thread and the declared parameters (using the ConfigurationParameter attribute) are already filled

Declaration

public override void SafeReset()

Overrides

AUnitySensor.SafeReset()

SafeSensorCheck()

This method is called at each scenario update. Note that this code will be executed in unity's thread

Declaration

public override ASensor.Result SafeSensorCheck()

Returns

Type	Description
ASensor.Result

Overrides

AUnitySensor.SafeSensorCheck()

SafeStopCheck()

Stops a sensor. Note that this code will be executed in unity's thread and the declared parameters (using the ConfigurationParameter attribute) are already filled This will be called when the transition contining this sensor is no longer ready to be triggered. Either it already fired or tokens moved and the transition no longer has the necessary upstream tokens

Declaration

public override void SafeStopCheck()

Overrides

AUnitySensor.SafeStopCheck()