Click or drag to resize

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)
Syntax
C#
public struct InputActionEventData

The InputActionEventData type exposes the following members.

Properties
  NameDescription
Public propertyactionDescriptiveName
The descriptive name of the input Action of this event.
Public propertyactionName
The scripting name of the input Action of this event.
Public propertyeventType
The event type of this event.
Public propertyplayer
The Player that generated this event.
Top
Methods
  NameDescription
Public methodGetAxis
Gets the axis value of an Action.
Public methodGetAxisCoordinateMode
Public methodGetAxisCoordinateModePrev
Public methodGetAxisDelta
Gets the change in axis value of an Action since the previous frame.
Public methodGetAxisPrev
Gets the axis value of an Action during the previous frame.
Public methodGetAxisRaw
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.
Public methodGetAxisRawCoordinateMode
Public methodGetAxisRawCoordinateModePrev
Public methodGetAxisRawDelta
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.
Public methodGetAxisRawPrev
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.
Public methodGetAxisRawTimeActive
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.
Public methodGetAxisRawTimeInactive
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.
Public methodGetAxisTimeActive
Gets the length of time in seconds that an axis has been continuously active. Returns 0 if the axis is not currently active.
Public methodGetAxisTimeInactive
Gets the length of time in seconds that an axis has been inactive. Returns 0 if the axis is currently active.
Public methodGetButton
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.
Public methodGetButtonDoublePressDown
Public methodGetButtonDoublePressDown(Single)
Gets the button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
Public methodGetButtonDoublePressHold
Public methodGetButtonDoublePressHold(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.
Public methodGetButtonDoublePressUp
Public methodGetButtonDoublePressUp(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.
Public methodGetButtonDown
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.
Public methodGetButtonLongPress
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.
Public methodGetButtonLongPressDown
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.
Public methodGetButtonLongPressUp
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.
Public methodGetButtonPrev
Gets the button held state of an Action during the previous frame.
Public methodGetButtonRepeating
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.
Public methodGetButtonShortPress
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.
Public methodGetButtonShortPressDown
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.
Public methodGetButtonShortPressUp
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.
Public methodGetButtonSinglePressDown
Public methodGetButtonSinglePressHold
Public methodGetButtonSinglePressUp
Public methodGetButtonTimedPress(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.
Public methodGetButtonTimedPress(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.
Public methodGetButtonTimedPressDown
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.
Public methodGetButtonTimedPressUp(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.
Public methodGetButtonTimedPressUp(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.
Public methodGetButtonTimePressed
Gets the length of time in seconds that a button has been continuously held down. Returns 0 if the button is not currently pressed.
Public methodGetButtonTimeUnpressed
Gets the length of time in seconds that a button has not been pressed. Returns 0 if the button is currently pressed.
Public methodGetButtonUp
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.
Public methodGetCurrentInputSources
Gets a list of all the input sources that contributed to the value of the Action in the current frame.
Public methodGetNegativeButton
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.
Public methodGetNegativeButtonDoublePressDown
Public methodGetNegativeButtonDoublePressDown(Single)
Gets the negative button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
Public methodGetNegativeButtonDoublePressHold
Public methodGetNegativeButtonDoublePressHold(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.
Public methodGetNegativeButtonDoublePressUp
Public methodGetNegativeButtonDoublePressUp(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.
Public methodGetNegativeButtonDown
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.
Public methodGetNegativeButtonLongPress
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.
Public methodGetNegativeButtonLongPressDown
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.
Public methodGetNegativeButtonLongPressUp
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.
Public methodGetNegativeButtonPrev
Gets the negative button held state of an Action during the previous frame.
Public methodGetNegativeButtonRepeating
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.
Public methodGetNegativeButtonShortPress
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.
Public methodGetNegativeButtonShortPressDown
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.
Public methodGetNegativeButtonShortPressUp
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.
Public methodGetNegativeButtonSinglePressDown
Public methodGetNegativeButtonSinglePressHold
Public methodGetNegativeButtonSinglePressUp
Public methodGetNegativeButtonTimedPress(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.
Public methodGetNegativeButtonTimedPress(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.
Public methodGetNegativeButtonTimedPressDown
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.
Public methodGetNegativeButtonTimedPressUp(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.
Public methodGetNegativeButtonTimedPressUp(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.
Public methodGetNegativeButtonTimePressed
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.
Public methodGetNegativeButtonTimeUnpressed
Gets the length of time in seconds that a negative button has not been pressed. Returns 0 if the negative button is currently pressed.
Public methodGetNegativeButtonUp
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.
Public methodIsCurrentInputSource(Controller)
Checks whether a particular controller contributed input to this Action in the current frame.
Public methodIsCurrentInputSource(ControllerType)
Checks whether any controller of type contributed input to this Action in the current frame.
Public methodIsCurrentInputSource(ControllerType, Int32)
Checks whether a particular controller contributed input to this Action in the current frame.
Top
Fields
  NameDescription
Public fieldactionId
The Action Id of Action this event is for.
Public fieldplayerId
The Player Id of the Player that generated this event.
Public fieldupdateLoop
The update loop this event was called in.
Top
See Also