InputActionEventData Structure |
Event data returned by an Input Action update event. Use this to get information about the input event.
Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public struct InputActionEventData
The InputActionEventData type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | actionDescriptiveName |
The descriptive name of the input Action of this event.
|
| actionName |
The scripting name of the input Action of this event.
|
| eventType |
The event type of this event.
|
| player |
The Player that generated this event.
|
Methods| Name | Description | |
|---|---|---|
 | GetAxis |
Gets the axis value of an Action.
|
| GetAxisCoordinateMode | |
| GetAxisCoordinateModePrev | |
| GetAxisDelta |
Gets the change in axis value of an Action since the previous frame.
|
| GetAxisPrev |
Gets the axis value of an Action during the previous frame.
|
| GetAxisRaw |
Gets the raw axis value of an Action. The raw value excludes any digital axis simulation modification by the Input Behavior assigned to this Action.
This raw value is modified by deadzone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRawCoordinateMode | |
| GetAxisRawCoordinateModePrev | |
| GetAxisRawDelta |
Gets the change in raw axis value of an Action since the previous frame. The raw value excludes any digital axis simulation modification by the Input Behavior assigned to this Action.
This raw value is modified by deadzone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRawPrev |
Gets the raw axis value of an Action during the previous frame. The raw value excludes any digital axis simulation modification by the Input Behavior assigned to this Action.
This raw value is modified by deadzone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRawTimeActive |
Gets the length of time in seconds that an axis has been continuously active as calculated from the raw value. Returns 0 if the axis is not currently active.
|
| GetAxisRawTimeInactive |
Gets the length of time in seconds that an axis has been inactive as calculated from the raw value. Returns 0 if the axis is currently active.
|
| GetAxisTimeActive |
Gets the length of time in seconds that an axis has been continuously active. Returns 0 if the axis is not currently active.
|
| GetAxisTimeInactive |
Gets the length of time in seconds that an axis has been inactive. Returns 0 if the axis is currently active.
|
| GetButton |
Gets the button held state of an Action. This will return TRUE as long as the button is held.
This also applies to axes being used as buttons.
|
| GetButtonDoublePressDown |
Gets the button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetButtonDoublePressDown(Single) |
Gets the button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
|
| GetButtonDoublePressHold |
Gets the button double pressed and held state of an Action. This will return TRUE after a double press and the button is then held.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetButtonDoublePressHold(Single) |
Gets the button double pressed and held state of an Action. This will return TRUE after a double press and the button is then held.
|
| GetButtonDoublePressUp |
Gets the button double pressed and just released state of an Action. This will return TRUE only on the first frame after double press is released.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetButtonDoublePressUp(Single) |
Gets the button double pressed and just released state of an Action. This will return TRUE only on the first frame after double press is released.
|
| GetButtonDown |
Gets the button just pressed state of an Action. This will only return TRUE only on the first frame the button is pressed or for the duration of the Button Down Buffer time limit if set in the Input Behavior assigned to this Action.
This also applies to axes being used as buttons.
|
| GetButtonLongPress |
Gets the button held state of an Action after being held for a period of time.
This will return TRUE only after the button has been held
for the specified time and will continue to return TRUE
until the button is released.
This also applies to axes being used as buttons.
The button long press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetButtonTimedPress instead.
|
| GetButtonLongPressDown |
Gets the button state of an Action after being held for a period of time.
This will return TRUE only on the frame in which
the button had been held for the specified time.
This also applies to axes being used as buttons.
The button long press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetButtonTimedPressDown instead.
|
| GetButtonLongPressUp |
Gets the button state of an Action after being held for a period of time and then released.
This will return TRUE only on the frame in which the button had
been held for at least the specified time and then released.
This also applies to axes being used as buttons.
The button long press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetButtonTimedPressUp instead.
|
| GetButtonPrev |
Gets the button held state of an Action during the previous frame.
|
| GetButtonRepeating |
Gets the repeating button state of an Action.
This will return TRUE when immediately pressed, then FALSE until the Input Behaviour button repeat delay has elapsed,
then TRUE for a 1-frame duration repeating at the interval specified in the Input Behavior assigned to the Action.
This also applies to axes being used as buttons.
|
| GetButtonShortPress |
Gets the button held state of an Action after being held for a period of time.
This will return TRUE only after the button has been held
for the specified time and will continue to return TRUE
until the button is released.
This also applies to axes being used as buttons.
The button short press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetButtonTimedPress instead.
|
| GetButtonShortPressDown |
Gets the button state of an Action after being held for a period of time.
This will return TRUE only on the frame in which
the button had been held for the specified time.
This also applies to axes being used as buttons.
The button short press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetButtonTimedPressDown instead.
|
| GetButtonShortPressUp |
Gets the button state of an Action after being held for a period of time and then released.
This will return TRUE only on the frame in which the button had
been held for at least the specified time and then released.
This also applies to axes being used as buttons.
The button short press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetButtonTimedPressUp instead.
|
| GetButtonSinglePressDown |
Gets the button just single pressed and held state of an Action.
This will return TRUE for only the first frame after a button press and after the double press timeout has expired.
This will never return TRUE if a double press occurs.
This method is delayed because it only returns TRUE after the double press timeout has expired.
Only use this method if you need to check for both a single press and a double press on the same Action.
Otherwise, use GetButtonDown instead for instantaneous button press detection.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetButtonSinglePressHold |
Gets the button single pressed and held state of an Action.
This will return TRUE after a button is held and the double press timeout has expired.
This will never return TRUE if a double press occurs.
This method is delayed because it only returns TRUE after the double press timeout has expired.
Only use this method if you need to check for both a single press and a double press on the same Action.
Otherwise, use GetButton instead for instantaneous button press detection.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetButtonSinglePressUp |
Gets the button single pressed and just released state of an Action.
This will return TRUE for only the first frame after the release of a single press.
This will never return TRUE if a double press occurs.
This method is delayed because it only returns TRUE after the double press timeout has expired.
Only use this method if you need to check for both a single press and a double press on the same Action.
Otherwise, use GetButtonUp instead for instantaneous button press detection.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetButtonTimedPress(Single) |
Gets the button held state of an Action after being held for a period of time.
This will return TRUE only after the button has been held
for the specified time and will continue to return TRUE
until the button is released.
This also applies to axes being used as buttons.
|
| GetButtonTimedPress(Single, Single) |
Gets the button held state of an Action after being held for a period of time.
This will return TRUE only after the button has been held
for the specified time and will continue to return TRUE
until the button is released.
This also applies to axes being used as buttons.
|
| GetButtonTimedPressDown |
Gets the button state of an Action after being held for a period of time.
This will return TRUE only on the frame in which
the button had been held for the specified time.
This also applies to axes being used as buttons.
|
| GetButtonTimedPressUp(Single) |
Gets the button state of an Action after being held for a period of time and then released.
This will return TRUE only on the frame in which the button had
been held for at least the specified time and then released.
This also applies to axes being used as buttons.
|
| GetButtonTimedPressUp(Single, Single) |
Gets the button state of an Action after being held for a period of time and then released.
This will return TRUE only on the frame in which the button had
been held for at least the specified time and then released.
This also applies to axes being used as buttons.
|
| GetButtonTimePressed |
Gets the length of time in seconds that a button has been continuously held down. Returns 0 if the button is not currently pressed.
|
| GetButtonTimeUnpressed |
Gets the length of time in seconds that a button has not been pressed. Returns 0 if the button is currently pressed.
|
| GetButtonUp |
Get the button just released state for an Action. This will only return TRUE for the first frame the button is released.
This also applies to axes being used as buttons.
|
| GetCurrentInputSources |
Gets a list of all the input sources that contributed to the value of the Action in the current frame.
|
| GetNegativeButton |
Gets the negative button held state of an Action. This will return TRUE as long as the negative button is held.
This also applies to axes being used as buttons.
|
| GetNegativeButtonDoublePressDown |
Gets the negative button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetNegativeButtonDoublePressDown(Single) |
Gets the negative button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
|
| GetNegativeButtonDoublePressHold |
Gets the negative button double pressed and held state of an Action. This will return TRUE after a double press and the negative button is then held.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetNegativeButtonDoublePressHold(Single) |
Gets the negative button double pressed and held state of an Action. This will return TRUE after a double press and the negative button is then held.
|
| GetNegativeButtonDoublePressUp |
Gets the negative button double pressed and just released state of an Action. This will return TRUE only on the first frame after double press is released.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetNegativeButtonDoublePressUp(Single) |
Gets the negative button double pressed and just released state of an Action. This will return TRUE only on the first frame after double press is released.
|
| GetNegativeButtonDown |
Gets the negative button just pressed state of an Action. This will only return TRUE only on the first frame the negative button is pressed or for the duration of the Button Down Buffer time limit if set in the Input Behavior assigned to this Action.
This also applies to axes being used as buttons.
|
| GetNegativeButtonLongPress |
Gets the negative button held state of an Action after being held for a period of time.
This will return TRUE only after the negative button has been held
for the specified time and will continue to return TRUE
until the negative button is released.
This also applies to axes being used as negative buttons.
The negative button long press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPress instead.
|
| GetNegativeButtonLongPressDown |
Gets the negative button state of an Action after being held for a period of time.
This will return TRUE only on the frame in which
the negative button had been held for the specified time.
This also applies to axes being used as negative buttons.
The negative button long press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressDown instead.
|
| GetNegativeButtonLongPressUp |
Gets the negative button state of an Action after being held for a period of time and then released.
This will return TRUE only on the frame in which the negative button had
been held for at least the specified time and then released.
This also applies to axes being used as negative buttons.
The negative button long press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressUp instead.
|
| GetNegativeButtonPrev |
Gets the negative button held state of an Action during the previous frame.
|
| GetNegativeButtonRepeating |
Gets the repeating negative button state of an Action.
This will return TRUE when immediately pressed, then FALSE until the Input Behaviour button repeat delay has elapsed,
then TRUE for a 1-frame duration repeating at the interval specified in the Input Behavior assigned to the Action.
This also applies to axes being used as buttons.
|
| GetNegativeButtonShortPress |
Gets the negative button held state of an Action after being held for a period of time.
This will return TRUE only after the negative button has been held
for the specified time and will continue to return TRUE
until the negative button is released.
This also applies to axes being used as negative buttons.
The negative button short press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPress instead.
|
| GetNegativeButtonShortPressDown |
Gets the negative button state of an Action after being held for a period of time.
This will return TRUE only on the frame in which
the negative button had been held for the specified time.
This also applies to axes being used as negative buttons.
The negative button short press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressDown instead.
|
| GetNegativeButtonShortPressUp |
Gets the negative button state of an Action after being held for a period of time and then released.
This will return TRUE only on the frame in which the negative button had
been held for at least the specified time and then released.
This also applies to axes being used as negative buttons.
The negative button short press time is set in the Input Behavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressUp instead.
|
| GetNegativeButtonSinglePressDown |
Gets the negative button just single pressed and held state of an Action.
This will return TRUE for only the first frame after a negative button press and after the double press timeout has expired.
This will never return TRUE if a double press occurs.
This method is delayed because it only returns TRUE after the double press timeout has expired.
Only use this method if you need to check for both a single press and a double press on the same Action.
Otherwise, use GetNegativeButtonDown instead for instantaneous negative button press detection.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetNegativeButtonSinglePressHold |
Gets the negative button single pressed and held state of an Action.
This will return TRUE after a negative button is held and the double press timeout has expired.
This will never return TRUE if a double press occurs.
This method is delayed because it only returns TRUE after the double press timeout has expired.
Only use this method if you need to check for both a single press and a double press on the same Action.
Otherwise, use GetNegativeButton instead for instantaneous negative button press detection.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetNegativeButtonSinglePressUp |
Gets the negative button single pressed and just released state of an Action.
This will return TRUE for only the first frame after the release of a single press.
This will never return TRUE if a double press occurs.
This method is delayed because it only returns TRUE after the double press timeout has expired.
Only use this method if you need to check for both a single press and a double press on the same Action.
Otherwise, use GetNegativeButtonUp instead for instantaneous negative button press detection.
The double press speed is set in the Input Behavior assigned to the Action.
|
| GetNegativeButtonTimedPress(Single) |
Gets the negative button held state of an Action after being held for a period of time.
This will return TRUE only after the negative button has been held
for the specified time and will continue to return TRUE
until the negative button is released.
This also applies to axes being used as negative buttons.
|
| GetNegativeButtonTimedPress(Single, Single) |
Gets the negative button held state of an Action after being held for a period of time.
This will return TRUE only after the negative button has been held
for the specified time and will continue to return TRUE
until the negative button is released.
This also applies to axes being used as negative buttons.
|
| GetNegativeButtonTimedPressDown |
Gets the negative button state of an Action after being held for a period of time.
This will return TRUE only on the frame in which
the negative button had been held for the specified time.
This also applies to axes being used as negative buttons.
|
| GetNegativeButtonTimedPressUp(Single) |
Gets the negative button state of an Action after being held for a period of time and then released.
This will return TRUE only on the frame in which the negative button had
been held for at least the specified time and then released.
This also applies to axes being used as negative buttons.
|
| GetNegativeButtonTimedPressUp(Single, Single) |
Gets the negative button state of an Action after being held for a period of time and then released.
This will return TRUE only on the frame in which the negative button had
been held for at least the specified time and then released.
This also applies to axes being used as negative buttons.
|
| GetNegativeButtonTimePressed |
Gets the length of time in seconds that a negative button has been continuously held down. Returns 0 if the negative button is not currently pressed.
|
| GetNegativeButtonTimeUnpressed |
Gets the length of time in seconds that a negative button has not been pressed. Returns 0 if the negative button is currently pressed.
|
| GetNegativeButtonUp |
Get the negative button just released state for all Actions. This will only return TRUE for the first frame the negative button is released.
This will return TRUE each time any negative button is released even if others are being held down.
This also applies to axes being used as buttons.
|
| IsCurrentInputSource(Controller) |
Checks whether a particular controller contributed input to this Action in the current frame.
|
| IsCurrentInputSource(ControllerType) |
Checks whether any controller of type contributed input to this Action in the current frame.
|
| IsCurrentInputSource(ControllerType, Int32) |
Checks whether a particular controller contributed input to this Action in the current frame.
|
Fields| Name | Description | |
|---|---|---|
 | actionId |
The Action Id of Action this event is for.
|
| playerId |
The Player Id of the Player that generated this event.
|
| updateLoop |
The update loop this event was called in.
|
See Also