InputStateExtFindFirst Method (InputState, FuncIDevice, IVirtualAxis, Boolean, IEnumerableInputCode)

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

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.

Namespace: RavingBots.MultiInput
Assembly: RavingBots.MultiInput (in RavingBots.MultiInput.dll) Version: 0.12

Syntax

Copy

public static IDevice FindFirst(
	this InputState state,
	Func<IDevice, IVirtualAxis, bool> predicate,
	IEnumerable<InputCode> axes
)

Parameters

state: Type: RavingBots.MultiInputInputState
InputState instance.
predicate: Type: SystemFuncIDevice, IVirtualAxis, Boolean
Predicate for the search. Takes a IDevice object, an instance of IVirtualAxis that belongs to that device, and should return true if said axis reports a value that interests you.
axes: Type: System.Collections.GenericIEnumerableInputCode
Axes to search through.

Return Value

Type: IDevice
Found device, or null if none were found.

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 device that reports a value of at least 0.5 on PadLeftTrigger or PadRightTrigger axes.

Copy

var state = FindObjectOfType<InputState>();
var axes = new List<InputCode> {
    InputCode.PadLeftTrigger,
    InputCode.PadRightTrigger
};
var device = state.FindFirst(a => a.Value >= 0.5f, axes);
if (device != null) {
    Debug.LogFormat("Found Value >= 0.5 on device {0}", device.Name);
} else {
    Debug.LogFormat("Value >= 0.5 not found");
}

Reference

InputStateExt Class

FindFirst Overload

RavingBots.MultiInput Namespace

InputStateFindFirst(IDevice, IVirtualAxis, FuncIDevice, IVirtualAxis, Boolean, IEnumerableInputCode)

InputStateExtFindFirstDown(InputState, IEnumerableInputCode)

InputStateExtFindFirstUp(InputState, IEnumerableInputCode)

InputStateExtFindFirstHeld(InputState, IEnumerableInputCode)