Click or drag to resize

InputState Methods

[This is preliminary documentation and is subject to change.]

The InputState type exposes the following members.

Methods
Extension Methods
  NameDescription
Public Extension MethodCode exampleFindFirst(FuncIDevice, IVirtualAxis, Boolean)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirst(FuncIDevice, IVirtualAxis, Boolean, InputCode)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirst(FuncIDevice, IVirtualAxis, Boolean, IEnumerableInputCode)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirst(IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean)Overloaded.
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).
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirst(IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean, InputCode)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstDownOverloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstDown(InputCode)Overloaded.
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.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstDown(IEnumerableInputCode)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstDown(IDevice, IVirtualAxis)Overloaded.
Queries all axes on all devices, and returns the first for which IsDown is true.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstDown(IDevice, IVirtualAxis, InputCode)Overloaded.
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.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstDown(IDevice, IVirtualAxis, IEnumerableInputCode)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstHeldOverloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstHeld(InputCode)Overloaded.
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.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstHeld(IEnumerableInputCode)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstHeld(IDevice, IVirtualAxis)Overloaded.
Queries all axes on all devices, and returns the first for which IsHeld is true.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstHeld(IDevice, IVirtualAxis, InputCode)Overloaded.
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.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstHeld(IDevice, IVirtualAxis, IEnumerableInputCode)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstUpOverloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstUp(InputCode)Overloaded.
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.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstUp(IEnumerableInputCode)Overloaded. (Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstUp(IDevice, IVirtualAxis)Overloaded.
Queries all axes on all devices, and returns the first for which IsUp is true.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstUp(IDevice, IVirtualAxis, InputCode)Overloaded.
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.
(Defined by InputStateExt.)
Public Extension MethodCode exampleFindFirstUp(IDevice, IVirtualAxis, IEnumerableInputCode)Overloaded. (Defined by InputStateExt.)
Top
See Also