InputStateExt Class |
[This is preliminary documentation and is subject to change.]
Various convenience extension methods for InputState.
Inheritance HierarchyNamespace: RavingBots.MultiInput
Assembly: RavingBots.MultiInput (in RavingBots.MultiInput.dll) Version: 0.12
SyntaxC#
public static class InputStateExt
The InputStateExt type exposes the following members.
Methods| Name | Description | |
|---|---|---|
   | FindFirst(InputState, FuncIDevice, IVirtualAxis, Boolean) |
Overload of
FindFirst(InputState, IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean) that
only returns the device. Use this form if you only need the device object.
|
| FindFirst(InputState, FuncIDevice, IVirtualAxis, Boolean, InputCode) |
Overload of
FindFirst(InputState, IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean) that
only returns the device and limits the search to selected axes, given as params argument.
Use this form if you only need the device object and you're specifying input codes manually.
|
| FindFirst(InputState, FuncIDevice, IVirtualAxis, Boolean, IEnumerableInputCode) |
Overload of
FindFirst(InputState, IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean) that
only returns the device and limits
the search to selected axes, given as IEnumerableT argument.
Use this form if you only need the device object and you have a collection of input codes.
|
| FindFirst(InputState, IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean) |
Queries all axes on all devices, and returns first for which a given predicate
returns true. If you don't require a custom predicate (i.e. you just want to check
IsHeld or similar), you should use simpler variants like
FindFirstHeld(InputState, IDevice, IVirtualAxis).
|
| FindFirst(InputState, IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean, InputCode) |
Overload of
FindFirst(InputState, IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean) that
limits
the search to selected axes, given as params argument. Use this form if you're specifying input codes
manually.
|
| FindFirstDown(InputState) |
Overload of FindFirstDown(InputState, IDevice, IVirtualAxis) that
only returns the device. Use this form if you only need the device object.
|
| FindFirstDown(InputState, InputCode) |
Overload of FindFirstDown(InputState, IDevice, IVirtualAxis) that
only returns the device and limits the search to selected axes, given as params argument.
Use this form if you only need the device object and you're specifying input codes manually.
|
| FindFirstDown(InputState, IEnumerableInputCode) |
Overload of FindFirstDown(InputState, IDevice, IVirtualAxis) that
only returns the device and limits
the search to selected axes, given as IEnumerableT argument.
Use this form if you only need the device object and you have a collection of input codes.
|
| FindFirstDown(InputState, IDevice, IVirtualAxis) |
Queries all axes on all devices, and returns the first for which IsDown
is true.
|
| FindFirstDown(InputState, IDevice, IVirtualAxis, InputCode) |
Overload of FindFirstDown(InputState, IDevice, IVirtualAxis) that limits
the search to selected axes, given as params argument. Use this form if you're specifying input codes
manually.
|
| FindFirstDown(InputState, IDevice, IVirtualAxis, IEnumerableInputCode) |
Overload of FindFirstDown(InputState, IDevice, IVirtualAxis) that limits
the search to selected axes, given as IEnumerableT argument.
Use this form if you have a collection of input codes.
|
| FindFirstHeld(InputState) |
Overload of FindFirstHeld(InputState, IDevice, IVirtualAxis) that
only returns the device. Use this form if you only need the device object.
|
| FindFirstHeld(InputState, InputCode) |
Overload of FindFirstHeld(InputState, IDevice, IVirtualAxis) that
only returns the device and limits the search to selected axes, given as params argument.
Use this form if you only need the device object and you're specifying input codes manually.
|
| FindFirstHeld(InputState, IEnumerableInputCode) |
Overload of FindFirstHeld(InputState, IDevice, IVirtualAxis) that
only returns the device and limits
the search to selected axes, given as IEnumerableT argument.
Use this form if you only need the device object and you have a collection of input codes.
|
| FindFirstHeld(InputState, IDevice, IVirtualAxis) |
Queries all axes on all devices, and returns the first for which IsHeld
is true.
|
| FindFirstHeld(InputState, IDevice, IVirtualAxis, InputCode) |
Overload of FindFirstHeld(InputState, IDevice, IVirtualAxis) that limits
the search to selected axes, given as params argument. Use this form if you're specifying input codes
manually.
|
| FindFirstHeld(InputState, IDevice, IVirtualAxis, IEnumerableInputCode) |
Overload of FindFirstHeld(InputState, IDevice, IVirtualAxis) that limits
the search to selected axes, given as IEnumerableT argument.
Use this form if you have a collection of input codes.
|
| FindFirstUp(InputState) |
Overload of FindFirstUp(InputState, IDevice, IVirtualAxis) that
only returns the device. Use this form if you only need the device object.
|
| FindFirstUp(InputState, InputCode) |
Overload of FindFirstUp(InputState, IDevice, IVirtualAxis) that
only returns the device and limits the search to selected axes, given as params argument.
Use this form if you only need the device object and you're specifying input codes manually.
|
| FindFirstUp(InputState, IEnumerableInputCode) |
Overload of FindFirstUp(InputState, IDevice, IVirtualAxis) that
only returns the device and limits
the search to selected axes, given as IEnumerableT argument.
Use this form if you only need the device object and you have a collection of input codes.
|
| FindFirstUp(InputState, IDevice, IVirtualAxis) |
Queries all axes on all devices, and returns the first for which IsUp
is true.
|
| FindFirstUp(InputState, IDevice, IVirtualAxis, InputCode) |
Overload of FindFirstUp(InputState, IDevice, IVirtualAxis) that limits
the search to selected axes, given as params argument. Use this form if you're specifying input codes
manually.
|
| FindFirstUp(InputState, IDevice, IVirtualAxis, IEnumerableInputCode) |
Overload of FindFirstUp(InputState, IDevice, IVirtualAxis) that limits
the search to selected axes, given as IEnumerableT argument.
Use this form if you have a collection of input codes.
|
Fields| Name | Description | |
|---|---|---|
 | AllAxes |
Collection containing all values from InputCode enumeration, provided for convenience.
|
See Also