Click or drag to resize

InputStateExtFindFirstHeld Method (InputState, IEnumerableInputCode)

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

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.

Namespace:  RavingBots.MultiInput
Assembly:  RavingBots.MultiInput (in RavingBots.MultiInput.dll) Version: 0.12
Syntax
C#
Copy
public static IDevice FindFirstHeld(
	this InputState state,
	IEnumerable<InputCode> axes
)

Parameters

state
Type: RavingBots.MultiInputInputState
InputState instance.
axes
Type: System.Collections.GenericIEnumerableInputCode
Axes to search through.

Return Value

Type: IDevice
Found device, or null.

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 held PadLeftTrigger or PadRightTrigger axis.
Copy
var state = FindObjectOfType<InputState>();
var axes = new List<InputCode> {
    InputCode.PadLeftTrigger,
    InputCode.PadRightTrigger
};
var device = state.FindFirstHeld(axes);
if (device != null) {
    Debug.LogFormat("Found held trigger on device {0}", device.Name);
} else {
    Debug.LogFormat("Held trigger not found");
}
See Also