Player Class |
Represents a player to which controllers are assigned. Input should normally be managed through the Player class.
Inheritance HierarchySystemObject
RewiredPlayer
RewiredPlayer
Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public sealed class Player
The Player type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | descriptiveName |
The descriptive name of the Player.
The returned value will be localized if localization is in use.
|
| id |
The id of the Player.
|
| isPlaying |
Is this Player currently playing? This property is for user use. It is never set to anything but whatever you set in the Rewired Input Manager Player's page for the "Is Playing on Start" field. The only thing that Player.isPlaying affects internally is Joystick Auto-Assignment if "Assign to Playing Players Only" is set to True. One might use Player.isPlaying to flag that a Player has joined in and is active or has quit/lost all their lives, etc. Player.isPlaying does not affect input returned by the Player.
|
| name |
The scripting name of the Player.
Use descriptiveName instead for the localizable display name.
|
Methods| Name | Description | |
|---|---|---|
 | AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType) |
Add a delegate to receive input action events every time any input action value is updated.
|
| AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType) |
Add a delegate to receive input action events every time a specific event occurs in any action.
|
| AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, Int32) |
Add a delegate to receive input action events every time a specific input action value is updated.
|
| AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, String) |
Add a delegate to receive input action events every time a specific input action value is updated.
|
| AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, Int32) |
Add a delegate to receive input action events every time a specific event occurs in a specific action.
|
| AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, Object) |
Add a delegate to receive input action events every time a specific event occurs in any action.
|
| AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, String) |
Add a delegate to receive input action events every time a specific event occurs in a specific action.
|
| AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, Int32, Object) |
Add a delegate to receive input action events every time a specific event occurs in a specific action.
|
| AddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, String, Object) |
Add a delegate to receive input action events every time a specific event occurs in a specific action.
|
| ClearInputEventDelegates |
Clears all input action event delegates. You will no longer receive any input action update events.
|
| GetAnyButton |
Gets the button held state of all Actions. This will return TRUE as long as any button is held.
This also applies to axes.
|
| GetAnyButtonDown |
Gets the button just pressed state of all Actions. This will only return TRUE only on the first frame any button is pressed or for the duration of the Button Down Buffer time limit if set in the InputBehavior assigned to the Action.
This will return TRUE each time any button is pressed even if others are being held down.
This also applies to axes.
|
| GetAnyButtonPrev |
Gets the button held state of an any Action during the previous frame.
This also applies to axes.
|
| GetAnyButtonUp |
Get the button just released state for all Actions. This will only return TRUE for the first frame the button is released.
This will return TRUE each time any button is released even if others are being held down.
This also applies to axes.
|
| GetAnyNegativeButton |
Gets the negative button held state of all Actions. This will return TRUE as long as any negative button is held.
This also applies to axes.
|
| GetAnyNegativeButtonDown |
Gets the negative button just pressed state of all Actions. This will only return TRUE only on the first frame any negative button is pressed or for the duration of the Button Down Buffer time limit if set in the InputBehavior assigned to the Action.
This will return TRUE each time any negative button is pressed even if others are being held down.
This also applies to axes.
|
| GetAnyNegativeButtonPrev |
Gets the negative button held state of an any Action during the previous frame.
This also applies to axes.
|
| GetAnyNegativeButtonUp |
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.
|
| GetAxis(Int32) |
Gets the axis value of an Action.
|
| GetAxis(String) |
Gets the axis value of an Action.
|
| GetAxis2D(Int32, Int32) |
Gets the axis value of two Actions.
|
| GetAxis2D(String, String) |
Gets the axis value of two Actions.
|
| GetAxis2DPrev(Int32, Int32) |
Gets the axis value of two Actions during the previous frame.
|
| GetAxis2DPrev(String, String) |
Gets the axis value of two Actions during the previous frame.
|
| GetAxis2DRaw(Int32, Int32) |
Gets the raw axis value of two Actions.
The raw value excludes any digital axis simulation modification by the InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxis2DRaw(String, String) |
Gets the raw axis value of two Actions.
The raw value excludes any digital axis simulation modification by the InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxis2DRawPrev(Int32, Int32) |
Gets the raw axis value of two Actions during the previous frame.
The raw value excludes any digital axis simulation modification by the InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxis2DRawPrev(String, String) |
Gets the raw axis value of two Actions during the previous frame.
The raw value excludes any digital axis simulation modification by the InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisCoordinateMode(Int32) |
Gets the current coordinate mode of the axis.
This can be used to detect whether the axis is returning a delta value
(mouse, touchpad, etc.) or an absolute value (joystick).
|
| GetAxisCoordinateMode(String) |
Gets the current coordinate mode of the axis.
This can be used to detect whether the axis is returning a delta value
(mouse, touchpad, etc.) or an absolute value (joystick).
|
| GetAxisCoordinateModePrev(Int32) |
Gets the coordinate mode of the axis on the previous frame.
This can be used to detect whether the axis is returning a delta value
(mouse, touchpad, etc.) or an absolute value (joystick).
|
| GetAxisCoordinateModePrev(String) |
Gets the coordinate mode of the axis on the previous frame.
This can be used to detect whether the axis is returning a delta value
(mouse, touchpad, etc.) or an absolute value (joystick).
|
| GetAxisDelta(Int32) |
Gets the change in axis value of an Action since the previous frame.
|
| GetAxisDelta(String) |
Gets the change in axis value of an Action since the previous frame.
|
| GetAxisPrev(Int32) |
Gets the axis value of an Action during the previous frame.
|
| GetAxisPrev(String) |
Gets the axis value of an Action during the previous frame.
|
| GetAxisRaw(Int32) |
Gets the raw axis value of an Action. The raw value excludes any digital axis simulation modification by the InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRaw(String) |
Gets the raw axis value of an Action. The raw value excludes any digital axis simulation modification by the InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRawCoordinateMode(Int32) |
Gets the current coordinate mode of the raw axis.
This can be used to detect whether the axis is returning a delta value
(mouse, touchpad, etc.) or an absolute value (joystick).
|
| GetAxisRawCoordinateMode(String) |
Gets the current coordinate mode of the raw axis.
This can be used to detect whether the axis is returning a delta value
(mouse, touchpad, etc.) or an absolute value (joystick).
|
| GetAxisRawCoordinateModePrev(Int32) |
Gets the coordinate mode of the raw axis on the previous frame.
This can be used to detect whether the axis is returning a delta value
(mouse, touchpad, etc.) or an absolute value (joystick).
|
| GetAxisRawCoordinateModePrev(String) |
Gets the coordinate mode of the raw axis on the previous frame.
This can be used to detect whether the axis is returning a delta value
(mouse, touchpad, etc.) or an absolute value (joystick).
|
| GetAxisRawDelta(Int32) |
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 InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRawDelta(String) |
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 InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRawPrev(Int32) |
Gets the raw axis value of an Action during the previous frame. The raw value excludes any digital axis simulation modification by the InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRawPrev(String) |
Gets the raw axis value of an Action during the previous frame. The raw value excludes any digital axis simulation modification by the InputBehavior assigned to this Action.
This raw value is modified by dead zone and axis calibration settings in the controller. To get truly raw values, you must get the raw value directly from the Controller element.
|
| GetAxisRawTimeActive(Int32) |
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.
|
| GetAxisRawTimeActive(String) |
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(Int32) |
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.
|
| GetAxisRawTimeInactive(String) |
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(Int32) |
Gets the length of time in seconds that an axis has been continuously active. Returns 0 if the axis is not currently active.
|
| GetAxisTimeActive(String) |
Gets the length of time in seconds that an axis has been continuously active. Returns 0 if the axis is not currently active.
|
| GetAxisTimeInactive(Int32) |
Gets the length of time in seconds that an axis has been inactive. Returns 0 if the axis is currently active.
|
| GetAxisTimeInactive(String) |
Gets the length of time in seconds that an axis has been inactive. Returns 0 if the axis is currently active.
|
| GetButton(Int32) |
Gets the button held state of an Action. This will return TRUE as long as the button is held.
This also applies to axes.
|
| GetButton(String) |
Gets the button held state of an Action. This will return TRUE as long as the button is held.
This also applies to axes.
|
| GetButtonDoublePressDown(Int32) |
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 InputBehavior assigned to the Action.
|
| GetButtonDoublePressDown(String) |
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 InputBehavior assigned to the Action.
|
| GetButtonDoublePressDown(Int32, Single) |
Gets the button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
|
| GetButtonDoublePressDown(String, Single) |
Gets the button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
|
| GetButtonDoublePressHold(Int32) |
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 InputBehavior assigned to the Action.
|
| GetButtonDoublePressHold(String) |
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 InputBehavior assigned to the Action.
|
| GetButtonDoublePressHold(Int32, 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.
|
| GetButtonDoublePressHold(String, 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(Int32) |
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 InputBehavior assigned to the Action.
|
| GetButtonDoublePressUp(String) |
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 InputBehavior assigned to the Action.
|
| GetButtonDoublePressUp(Int32, 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.
|
| GetButtonDoublePressUp(String, 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(Int32) |
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 InputBehavior assigned to this Action.
This also applies to axes.
|
| GetButtonDown(String) |
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 InputBehavior assigned to this Action.
This also applies to axes.
|
| GetButtonLongPress(Int32) |
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.
The button long press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPress instead.
|
| GetButtonLongPress(String) |
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.
The button long press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPress instead.
|
| GetButtonLongPressDown(Int32) |
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.
The button long press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPressDown instead.
|
| GetButtonLongPressDown(String) |
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.
The button long press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPressDown instead.
|
| GetButtonLongPressUp(Int32) |
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.
The button long press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPressUp instead.
|
| GetButtonLongPressUp(String) |
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.
The button long press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPressUp instead.
|
| GetButtonPrev(Int32) |
Gets the button held state of an Action during the previous frame.
|
| GetButtonPrev(String) |
Gets the button held state of an Action during the previous frame.
|
| GetButtonRepeating(Int32) |
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 InputBehavior assigned to the Action.
This also applies to axes.
|
| GetButtonRepeating(String) |
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 InputBehavior assigned to the Action.
This also applies to axes.
|
| GetButtonShortPress(Int32) |
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.
The button short press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPress instead.
|
| GetButtonShortPress(String) |
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.
The button short press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPress instead.
|
| GetButtonShortPressDown(Int32) |
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.
The button short press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPressDown instead.
|
| GetButtonShortPressDown(String) |
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.
The button short press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPressDown instead.
|
| GetButtonShortPressUp(Int32) |
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.
The button short press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPressUp instead.
|
| GetButtonShortPressUp(String) |
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.
The button short press time is set in the InputBehavior assigned to the Action.
For a custom duration, use GetButtonTimedPressUp instead.
|
| GetButtonSinglePressDown(Int32) |
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 InputBehavior assigned to the Action.
|
| GetButtonSinglePressDown(String) |
Gets the button just single pressed 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 InputBehavior assigned to the Action.
|
| GetButtonSinglePressHold(Int32) |
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 InputBehavior assigned to the Action.
|
| GetButtonSinglePressHold(String) |
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 InputBehavior assigned to the Action.
|
| GetButtonSinglePressUp(Int32) |
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 InputBehavior assigned to the Action.
|
| GetButtonSinglePressUp(String) |
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 InputBehavior assigned to the Action.
|
| GetButtonTimedPress(Int32, 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.
|
| GetButtonTimedPress(String, 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.
|
| GetButtonTimedPress(Int32, 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.
|
| GetButtonTimedPress(String, 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.
|
| GetButtonTimedPressDown(Int32, Single) |
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.
|
| GetButtonTimedPressDown(String, Single) |
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.
|
| GetButtonTimedPressUp(Int32, 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.
|
| GetButtonTimedPressUp(String, 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.
|
| GetButtonTimedPressUp(Int32, 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.
|
| GetButtonTimedPressUp(String, 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.
|
| GetButtonTimePressed(Int32) |
Gets the length of time in seconds that a button has been continuously held down. Returns 0 if the button is not currently pressed.
|
| GetButtonTimePressed(String) |
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(Int32) |
Gets the length of time in seconds that a button has not been pressed. Returns 0 if the button is currently pressed.
|
| GetButtonTimeUnpressed(String) |
Gets the length of time in seconds that a button has not been pressed. Returns 0 if the button is currently pressed.
|
| GetButtonUp(Int32) |
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.
|
| GetButtonUp(String) |
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.
|
| GetCurrentInputSources(Int32) |
Gets a list of all the input sources that contributed to the value of an Action in the current frame.
|
| GetCurrentInputSources(String) |
Gets a list of all the input sources that contributed to the value of an Action in the current frame.
|
| GetNegativeButton(Int32) |
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.
|
| GetNegativeButton(String) |
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.
|
| GetNegativeButtonDoublePressDown(Int32) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonDoublePressDown(String) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonDoublePressDown(Int32, Single) |
Gets the negative button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
|
| GetNegativeButtonDoublePressDown(String, 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(Int32) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonDoublePressHold(String) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonDoublePressHold(Int32, 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.
|
| GetNegativeButtonDoublePressHold(String, 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(Int32) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonDoublePressUp(String) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonDoublePressUp(Int32, 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.
|
| GetNegativeButtonDoublePressUp(String, 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(Int32) |
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 InputBehavior assigned to this Action.
This also applies to axes.
|
| GetNegativeButtonDown(String) |
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 InputBehavior assigned to this Action.
This also applies to axes.
|
| GetNegativeButtonLongPress(Int32) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPress instead.
|
| GetNegativeButtonLongPress(String) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPress instead.
|
| GetNegativeButtonLongPressDown(Int32) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressDown instead.
|
| GetNegativeButtonLongPressDown(String) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressDown instead.
|
| GetNegativeButtonLongPressUp(Int32) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressUp instead.
|
| GetNegativeButtonLongPressUp(String) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressUp instead.
|
| GetNegativeButtonPrev(Int32) |
Gets the negative button held state of an Action during the previous frame.
|
| GetNegativeButtonPrev(String) |
Gets the negative button held state of an Action during the previous frame.
|
| GetNegativeButtonRepeating(Int32) |
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 InputBehavior assigned to the Action.
This also applies to axes.
|
| GetNegativeButtonRepeating(String) |
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 InputBehavior assigned to the Action.
This also applies to axes.
|
| GetNegativeButtonShortPress(Int32) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPress instead.
|
| GetNegativeButtonShortPress(String) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPress instead.
|
| GetNegativeButtonShortPressDown(Int32) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressDown instead.
|
| GetNegativeButtonShortPressDown(String) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressDown instead.
|
| GetNegativeButtonShortPressUp(Int32) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressUp instead.
|
| GetNegativeButtonShortPressUp(String) |
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 InputBehavior assigned to the Action.
For a custom duration, use GetNegativeButtonTimedPressUp instead.
|
| GetNegativeButtonSinglePressDown(Int32) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonSinglePressDown(String) |
Gets the negative button just single pressed 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 InputBehavior assigned to the Action.
|
| GetNegativeButtonSinglePressHold(Int32) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonSinglePressHold(String) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonSinglePressUp(Int32) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonSinglePressUp(String) |
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 InputBehavior assigned to the Action.
|
| GetNegativeButtonTimedPress(Int32, 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(String, 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(Int32, 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.
|
| GetNegativeButtonTimedPress(String, 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(Int32, Single) |
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.
|
| GetNegativeButtonTimedPressDown(String, Single) |
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(Int32, 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(String, 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(Int32, 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.
|
| GetNegativeButtonTimedPressUp(String, 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(Int32) |
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.
|
| GetNegativeButtonTimePressed(String) |
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(Int32) |
Gets the length of time in seconds that a negative button has not been pressed. Returns 0 if the negative button is currently pressed.
|
| GetNegativeButtonTimeUnpressed(String) |
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(Int32) |
Get the negative button just released state for an Action. This will only return TRUE for the first frame the negative button is released.
This also applies to axes.
|
| GetNegativeButtonUp(String) |
Get the negative button just released state for an Action. This will only return TRUE for the first frame the negative button is released.
This also applies to axes.
|
| GetSaveData |
Gets save data for this player.
|
| GetVibration |
Gets vibration level for a motor at a specified index.
This returns the largest value found for the specified motor index in all Joysticks assigned to the Player.
|
| IsCurrentInputSource(Int32, Controller) |
Checks whether a particular controller contributed input to this Action in the current frame.
|
| IsCurrentInputSource(Int32, ControllerType) |
Checks whether any controller of type contributed input to this Action in the current frame.
|
| IsCurrentInputSource(String, Controller) |
Checks whether a particular controller contributed input to this Action in the current frame.
|
| IsCurrentInputSource(String, ControllerType) |
Checks whether any controller of controller type contributed input to this Action in the current frame.
|
| IsCurrentInputSource(Int32, ControllerType, Int32) |
Checks whether a particular controller contributed input to this Action in the current frame.
|
| IsCurrentInputSource(String, ControllerType, Int32) |
Checks whether a particular controller contributed input to this Action in the current frame.
|
| RemoveInputEventDelegate(ActionInputActionEventData) |
Remove a delegate to no longer receive input action events from any update loop for all actions.
|
| RemoveInputEventDelegate(ActionInputActionEventData, InputActionEventType) |
Remove a delegate to no longer receive input action events from the specified update loop for all actions.
|
| RemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType) |
Remove a delegate to no longer receive input action events from the specified update loop for all actions.
|
| RemoveInputEventDelegate(ActionInputActionEventData, Int32) |
Remove a delegate to no longer receive input action events from any update loop for the specified action.
|
| RemoveInputEventDelegate(ActionInputActionEventData, String) |
Remove a delegate to no longer receive input action events from any update loop for the specified action.
|
| RemoveInputEventDelegate(ActionInputActionEventData, InputActionEventType, Int32) |
Remove a delegate to no longer receive input action events from any update loop for the specified action.
|
| RemoveInputEventDelegate(ActionInputActionEventData, InputActionEventType, String) |
Remove a delegate to no longer receive input action events from any update loop for the specified action.
|
| RemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType) |
Remove a delegate to no longer receive input action events from the specified update loop for all actions.
|
| RemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, Int32) |
Remove a delegate to no longer receive input action events from the specified update loop for the specified action.
|
| RemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, String) |
Remove a delegate to no longer receive input action events from the specified update loop for the specified action.
|
| RemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, Int32) |
Remove a delegate to no longer receive input action events from the specified update loop for the specified action.
|
| RemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, String) |
Remove a delegate to no longer receive input action events from the specified update loop for the specified action.
|
| SetVibration(Int32, Single) |
Sets vibration level for a motor at a specified index in all Joysticks assigned to the Player.
|
| SetVibration(Int32, Single, Boolean) |
Sets vibration level for a motor at a specified index in all Joysticks assigned to the Player.
|
| SetVibration(Int32, Single, Single) |
Sets vibration level for a motor at a specified index with a timeout in all Joysticks assigned to the Player.
|
| SetVibration(Int32, Single, Single, Boolean) |
Sets vibration level for a motor at a specified index with a timeout in all Joysticks assigned to the Player.
|
| StopVibration |
Stops vibration on all motors.
|
Fields| Name | Description | |
|---|---|---|
 | controllers |
A helper object that provides access controllers and controller maps.
|
See Also