Click or drag to resize

InputStateExtFindFirstHeld Method (InputState, IDevice, IVirtualAxis)

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

Queries all axes on all devices, and returns the first for which IsHeld is true.

Namespace:  RavingBots.MultiInput
Assembly:  RavingBots.MultiInput (in RavingBots.MultiInput.dll) Version: 0.12
Syntax
C#
Copy
public static bool FindFirstHeld(
	this InputState state,
	out IDevice foundDevice,
	out IVirtualAxis foundAxis
)

Parameters

state
Type: RavingBots.MultiInputInputState
InputState instance.
foundDevice
Type: RavingBots.MultiInputIDevice
If this method returned true, set to the found device. Otherwise, set to null.
foundAxis
Type: RavingBots.MultiInputIVirtualAxis
If this method returned true, set to the found axis. Otherwise, set to null. You can check the axis code via Code property.

Return Value

Type: Boolean
true if IsHeld was true for at least one axis, false otherwise.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type InputState. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Examples
The following example shows how you can use this method to find first input axis that reports non-zero value.
Copy
var state = FindObjectOfType<InputState>();
IDevice device;
IVirtualAxis axis;
if (state.FindFirstHeld(out device, out axis)) {
    Debug.LogFormat("Found non-zero value on device {0}, axis {1}", device.Name, axis.Code);
} else {
    Debug.LogFormat("Non-zero value not found");
}
See Also