Class CheckAnimatorParameterValueSensor

Inheritance
object
AFunction
ASensor
AUnitySensor
AInUnityStepSensor
CheckAnimatorParameterValueSensor
Inherited Members
Namespace: Xareus.Scenarios.Unity
Assembly: Xareus.Unity.Libraries.dll
Syntax
[FunctionDescription("Sensor to check the value of an animator parameter", new string[] { "Unity/Animation" })]
public class CheckAnimatorParameterValueSensor : AInUnityStepSensor

Constructors

CheckAnimatorParameterValueSensor(Event, Dictionary<string, Parameter>, IContext, IContext, IContext)

Declaration
public CheckAnimatorParameterValueSensor(Event @event, Dictionary<string, Parameter> parameters, IContext externalContext, IContext scenarioContext, IContext sequenceContext)
Parameters
Type Name Description
Event event
Dictionary<string, Parameter> parameters
IContext externalContext
IContext scenarioContext
IContext sequenceContext

Fields

animator

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

animatorParameterName

Declaration
[ConfigurationParameter("Parameter Name", Necessity.Required)]
protected string animatorParameterName
Field Value
Type Description
string

expectedValue

Declaration
[ConfigurationParameter("Expected Value", "The accepted types are int, float, and bool", Necessity.Required)]
protected object expectedValue
Field Value
Type Description
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

UnityStepSensorCheck()

This method is called at each selected Unity execution step in Unity's thread. The Unity execution steps used depend on the ExecutionStep property

Declaration
public override ASensor.Result UnityStepSensorCheck()
Returns
Type Description
ASensor.Result
Overrides