Click or drag to resize

Player Methods

The Player type exposes the following members.

Methods
  NameDescription
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType)
Add a delegate to receive input action events every time any input action value is updated.
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType)
Add a delegate to receive input action events every time a specific event occurs in any action.
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, Int32)
Add a delegate to receive input action events every time a specific input action value is updated.
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, String)
Add a delegate to receive input action events every time a specific input action value is updated.
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, Int32)
Add a delegate to receive input action events every time a specific event occurs in a specific action.
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, Object)
Add a delegate to receive input action events every time a specific event occurs in any action.
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, String)
Add a delegate to receive input action events every time a specific event occurs in a specific action.
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, Int32, Object)
Add a delegate to receive input action events every time a specific event occurs in a specific action.
Public methodAddInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, String, Object)
Add a delegate to receive input action events every time a specific event occurs in a specific action.
Public methodClearInputEventDelegates
Clears all input action event delegates. You will no longer receive any input action update events.
Public methodGetAnyButton
Gets the button held state of all Actions. This will return TRUE as long as any button is held. This also applies to axes being used as buttons.
Public methodGetAnyButtonDown
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 being used as buttons.
Public methodGetAnyButtonPrev
Gets the button held state of an any Action during the previous frame. This also applies to axes being used as buttons.
Public methodGetAnyButtonUp
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 being used as buttons.
Public methodGetAnyNegativeButton
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 being used as buttons.
Public methodGetAnyNegativeButtonDown
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 being used as buttons.
Public methodGetAnyNegativeButtonPrev
Gets the negative button held state of an any Action during the previous frame. This also applies to axes being used as buttons.
Public methodGetAnyNegativeButtonUp
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 methodGetAxis(Int32)
Gets the axis value of an Action.
Public methodGetAxis(String)
Gets the axis value of an Action.
Public methodGetAxis2D(Int32, Int32)
Gets the axis value of two Actions.
Public methodGetAxis2D(String, String)
Gets the axis value of two Actions.
Public methodGetAxis2DPrev(Int32, Int32)
Gets the axis value of two Actions during the previous frame.
Public methodGetAxis2DPrev(String, String)
Gets the axis value of two Actions during the previous frame.
Public methodGetAxis2DRaw(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.
Public methodGetAxis2DRaw(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.
Public methodGetAxis2DRawPrev(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.
Public methodGetAxis2DRawPrev(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.
Public methodGetAxisCoordinateMode(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).
Public methodGetAxisCoordinateMode(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).
Public methodGetAxisCoordinateModePrev(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).
Public methodGetAxisCoordinateModePrev(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).
Public methodGetAxisDelta(Int32)
Gets the change in axis value of an Action since the previous frame.
Public methodGetAxisDelta(String)
Gets the change in axis value of an Action since the previous frame.
Public methodGetAxisPrev(Int32)
Gets the axis value of an Action during the previous frame.
Public methodGetAxisPrev(String)
Gets the axis value of an Action during the previous frame.
Public methodGetAxisRaw(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.
Public methodGetAxisRaw(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.
Public methodGetAxisRawCoordinateMode(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).
Public methodGetAxisRawCoordinateMode(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).
Public methodGetAxisRawCoordinateModePrev(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).
Public methodGetAxisRawCoordinateModePrev(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).
Public methodGetAxisRawDelta(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.
Public methodGetAxisRawDelta(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.
Public methodGetAxisRawPrev(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.
Public methodGetAxisRawPrev(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.
Public methodGetAxisRawTimeActive(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.
Public methodGetAxisRawTimeActive(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.
Public methodGetAxisRawTimeInactive(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.
Public methodGetAxisRawTimeInactive(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.
Public methodGetAxisTimeActive(Int32)
Gets the length of time in seconds that an axis has been continuously active. Returns 0 if the axis is not currently active.
Public methodGetAxisTimeActive(String)
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(Int32)
Gets the length of time in seconds that an axis has been inactive. Returns 0 if the axis is currently active.
Public methodGetAxisTimeInactive(String)
Gets the length of time in seconds that an axis has been inactive. Returns 0 if the axis is currently active.
Public methodGetButton(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 being used as buttons.
Public methodGetButton(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 being used as buttons.
Public methodGetButtonDoublePressDown(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.
Public methodGetButtonDoublePressDown(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.
Public methodGetButtonDoublePressDown(Int32, Single)
Gets the button double pressed state of an Action. This will return TRUE only on the first frame of a double press.
Public methodGetButtonDoublePressDown(String, 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(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.
Public methodGetButtonDoublePressHold(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.
Public methodGetButtonDoublePressHold(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.
Public methodGetButtonDoublePressHold(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.
Public methodGetButtonDoublePressUp(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.
Public methodGetButtonDoublePressUp(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.
Public methodGetButtonDoublePressUp(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.
Public methodGetButtonDoublePressUp(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.
Public methodGetButtonDown(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 being used as buttons.
Public methodGetButtonDown(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 being used as buttons.
Public methodGetButtonLongPress(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 being used as buttons. The button long press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPress instead.
Public methodGetButtonLongPress(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 being used as buttons. The button long press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPress instead.
Public methodGetButtonLongPressDown(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 being used as buttons. The button long press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPressDown instead.
Public methodGetButtonLongPressDown(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 being used as buttons. The button long press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPressDown instead.
Public methodGetButtonLongPressUp(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 being used as buttons. The button long press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPressUp instead.
Public methodGetButtonLongPressUp(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 being used as buttons. The button long press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPressUp instead.
Public methodGetButtonPrev(Int32)
Gets the button held state of an Action during the previous frame.
Public methodGetButtonPrev(String)
Gets the button held state of an Action during the previous frame.
Public methodGetButtonRepeating(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 being used as buttons.
Public methodGetButtonRepeating(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 being used as buttons.
Public methodGetButtonShortPress(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 being used as buttons. The button short press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPress instead.
Public methodGetButtonShortPress(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 being used as buttons. The button short press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPress instead.
Public methodGetButtonShortPressDown(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 being used as buttons. The button short press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPressDown instead.
Public methodGetButtonShortPressDown(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 being used as buttons. The button short press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPressDown instead.
Public methodGetButtonShortPressUp(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 being used as buttons. The button short press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPressUp instead.
Public methodGetButtonShortPressUp(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 being used as buttons. The button short press time is set in the InputBehavior assigned to the Action. For a custom duration, use GetButtonTimedPressUp instead.
Public methodGetButtonSinglePressDown(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.
Public methodGetButtonSinglePressDown(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.
Public methodGetButtonSinglePressHold(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.
Public methodGetButtonSinglePressHold(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.
Public methodGetButtonSinglePressUp(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.
Public methodGetButtonSinglePressUp(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.
Public methodGetButtonTimedPress(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 being used as buttons.
Public methodGetButtonTimedPress(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 being used as buttons.
Public methodGetButtonTimedPress(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 being used as buttons.
Public methodGetButtonTimedPress(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 being used as buttons.
Public methodGetButtonTimedPressDown(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 being used as buttons.
Public methodGetButtonTimedPressDown(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 being used as buttons.
Public methodGetButtonTimedPressUp(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 being used as buttons.
Public methodGetButtonTimedPressUp(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 being used as buttons.
Public methodGetButtonTimedPressUp(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 being used as buttons.
Public methodGetButtonTimedPressUp(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 being used as buttons.
Public methodGetButtonTimePressed(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.
Public methodGetButtonTimePressed(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.
Public methodGetButtonTimeUnpressed(Int32)
Gets the length of time in seconds that a button has not been pressed. Returns 0 if the button is currently pressed.
Public methodGetButtonTimeUnpressed(String)
Gets the length of time in seconds that a button has not been pressed. Returns 0 if the button is currently pressed.
Public methodGetButtonUp(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 being used as buttons.
Public methodGetButtonUp(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 being used as buttons.
Public methodGetCurrentInputSources(Int32)
Gets a list of all the input sources that contributed to the value of an Action in the current frame.
Public methodGetCurrentInputSources(String)
Gets a list of all the input sources that contributed to the value of an Action in the current frame.
Public methodGetNegativeButton(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 being used as buttons.
Public methodGetNegativeButton(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 being used as buttons.
Public methodGetNegativeButtonDoublePressDown(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.
Public methodGetNegativeButtonDoublePressDown(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.
Public methodGetNegativeButtonDoublePressDown(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.
Public methodGetNegativeButtonDoublePressDown(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.
Public methodGetNegativeButtonDoublePressHold(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.
Public methodGetNegativeButtonDoublePressHold(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.
Public methodGetNegativeButtonDoublePressHold(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.
Public methodGetNegativeButtonDoublePressHold(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.
Public methodGetNegativeButtonDoublePressUp(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.
Public methodGetNegativeButtonDoublePressUp(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.
Public methodGetNegativeButtonDoublePressUp(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.
Public methodGetNegativeButtonDoublePressUp(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.
Public methodGetNegativeButtonDown(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 being used as buttons.
Public methodGetNegativeButtonDown(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 being used as buttons.
Public methodGetNegativeButtonLongPress(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.
Public methodGetNegativeButtonLongPress(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.
Public methodGetNegativeButtonLongPressDown(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.
Public methodGetNegativeButtonLongPressDown(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.
Public methodGetNegativeButtonLongPressUp(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.
Public methodGetNegativeButtonLongPressUp(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.
Public methodGetNegativeButtonPrev(Int32)
Gets the negative button held state of an Action during the previous frame.
Public methodGetNegativeButtonPrev(String)
Gets the negative button held state of an Action during the previous frame.
Public methodGetNegativeButtonRepeating(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 being used as buttons.
Public methodGetNegativeButtonRepeating(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 being used as buttons.
Public methodGetNegativeButtonShortPress(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.
Public methodGetNegativeButtonShortPress(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.
Public methodGetNegativeButtonShortPressDown(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.
Public methodGetNegativeButtonShortPressDown(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.
Public methodGetNegativeButtonShortPressUp(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.
Public methodGetNegativeButtonShortPressUp(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.
Public methodGetNegativeButtonSinglePressDown(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.
Public methodGetNegativeButtonSinglePressDown(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.
Public methodGetNegativeButtonSinglePressHold(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.
Public methodGetNegativeButtonSinglePressHold(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.
Public methodGetNegativeButtonSinglePressUp(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.
Public methodGetNegativeButtonSinglePressUp(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.
Public methodGetNegativeButtonTimedPress(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.
Public methodGetNegativeButtonTimedPress(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.
Public methodGetNegativeButtonTimedPress(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.
Public methodGetNegativeButtonTimedPress(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.
Public methodGetNegativeButtonTimedPressDown(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.
Public methodGetNegativeButtonTimedPressDown(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.
Public methodGetNegativeButtonTimedPressUp(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.
Public methodGetNegativeButtonTimedPressUp(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.
Public methodGetNegativeButtonTimedPressUp(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.
Public methodGetNegativeButtonTimedPressUp(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.
Public methodGetNegativeButtonTimePressed(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.
Public methodGetNegativeButtonTimePressed(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.
Public methodGetNegativeButtonTimeUnpressed(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.
Public methodGetNegativeButtonTimeUnpressed(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.
Public methodGetNegativeButtonUp(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 being used as buttons.
Public methodGetNegativeButtonUp(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 being used as buttons.
Public methodGetSaveData
Gets save data for this player.
Public methodGetVibration
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.
Public methodIsCurrentInputSource(Int32, Controller)
Checks whether a particular controller contributed input to this Action in the current frame.
Public methodIsCurrentInputSource(Int32, ControllerType)
Checks whether any controller of type contributed input to this Action in the current frame.
Public methodIsCurrentInputSource(String, Controller)
Checks whether a particular controller contributed input to this Action in the current frame.
Public methodIsCurrentInputSource(String, ControllerType)
Checks whether any controller of controller type contributed input to this Action in the current frame.
Public methodIsCurrentInputSource(Int32, ControllerType, Int32)
Checks whether a particular controller contributed input to this Action in the current frame.
Public methodIsCurrentInputSource(String, ControllerType, Int32)
Checks whether a particular controller contributed input to this Action in the current frame.
Public methodRemoveInputEventDelegate(ActionInputActionEventData)
Remove a delegate to no longer receive input action events from any update loop for all actions.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, InputActionEventType)
Remove a delegate to no longer receive input action events from the specified update loop for all actions.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType)
Remove a delegate to no longer receive input action events from the specified update loop for all actions.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, Int32)
Remove a delegate to no longer receive input action events from any update loop for the specified action.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, String)
Remove a delegate to no longer receive input action events from any update loop for the specified action.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, InputActionEventType, Int32)
Remove a delegate to no longer receive input action events from any update loop for the specified action.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, InputActionEventType, String)
Remove a delegate to no longer receive input action events from any update loop for the specified action.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType)
Remove a delegate to no longer receive input action events from the specified update loop for all actions.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, Int32)
Remove a delegate to no longer receive input action events from the specified update loop for the specified action.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, String)
Remove a delegate to no longer receive input action events from the specified update loop for the specified action.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, Int32)
Remove a delegate to no longer receive input action events from the specified update loop for the specified action.
Public methodRemoveInputEventDelegate(ActionInputActionEventData, UpdateLoopType, InputActionEventType, String)
Remove a delegate to no longer receive input action events from the specified update loop for the specified action.
Public methodSetVibration(Int32, Single)
Sets vibration level for a motor at a specified index in all Joysticks assigned to the Player.
Public methodSetVibration(Int32, Single, Boolean)
Sets vibration level for a motor at a specified index in all Joysticks assigned to the Player.
Public methodSetVibration(Int32, Single, Single)
Sets vibration level for a motor at a specified index with a timeout in all Joysticks assigned to the Player.
Public methodSetVibration(Int32, Single, Single, Boolean)
Sets vibration level for a motor at a specified index with a timeout in all Joysticks assigned to the Player.
Public methodStopVibration
Stops vibration on all motors.
Top
See Also