Class UnityEventSensor

Inheritance
object
AFunction
ASensor
AUnitySensor
AUnityArityEventHandlerSensor
UnityEventSensor
Inherited Members
Namespace: Xareus.Scenarios.Unity
Assembly: Xareus.Unity.Libraries.dll
Syntax
[Renamed("Xareus.Scenarios.Unity.UnityEventSensor", "Xareus.Unity.Libraries", typeof(LegacyComponentAccessParameterConverter))]
[FunctionDescription("This sensor can be activated by a unity event triggered from a component (ex: public UnityEvent<int> MyEvent;).", new string[] { "Event", "Unity" })]
public class UnityEventSensor : AUnityArityEventHandlerSensor

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

EVENT

Declaration
protected const string EVENT = "Event"
Field Value
Type Description
string

OBJECT

Declaration
protected const string OBJECT = "Object"
Field Value
Type Description
string

Object

Declaration
[ConfigurationParameter("Object", Necessity.Required)]
protected Object Object
Field Value
Type Description
Object

UnityEventField

Declaration
[ConfigurationParameter("Event", Necessity.Required)]
[Provider("Object")]
[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>

Properties

ValuesToCheckAgainst

Declaration
protected override List<object> ValuesToCheckAgainst { get; }
Property Value
Type Description
List<object>
Overrides

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

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