Class KeyPressedSensor

Checks for a keyboard input. Note that inputs happening between two scenario update will activate the sensor

Inheritance
object
AFunction
ASensor
AUnitySensor
KeyPressedSensor
Inherited Members
Namespace: Xareus.Scenarios.Input
Assembly: Xareus.Unity.Libraries.Input.dll
Syntax
[Renamed("Xareus.Scenario.Input.KeyPressedSensor", "Xareus.Scenario.Input")]
[Renamed("Xareus.Scenarios.Input.KeyPressedSensor", "Xareus.Unity.Librairies.Input")]
public class KeyPressedSensor : AUnitySensor

Constructors

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

Declaration
public KeyPressedSensor(Event @event, Dictionary<string, Parameter> parameters, ContextHolder contexts)
Parameters
Type Name Description
Event event
Dictionary<string, Parameter> parameters
ContextHolder contexts

Fields

KEY

Declaration
[EventContextEntry]
public static readonly string KEY
Field Value
Type Description
string

convertToLayout

Declaration
[ConfigurationParameter("Convert To Layout", "Converts the key to the current layout of the keyboard (can be costly!)", Necessity.Optional, InitialValue = true, Necessity = Necessity.Optional)]
protected bool convertToLayout
Field Value
Type Description
bool

eventContext

The result

Declaration
protected SimpleDictionary eventContext
Field Value
Type Description
SimpleDictionary

keyCode

Declaration
[ConfigurationParameter("Key", Necessity.Optional, Necessity = Necessity.Required)]
protected KeyCode keyCode
Field Value
Type Description
KeyCode

mvr_keycode

Declaration
protected uint mvr_keycode
Field Value
Type Description
uint

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

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

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