Struct InputControlScheme.MatchResult

The result of matching a list of InputDevice against a list of InputControlScheme.DeviceRequirement in an InputControlScheme.

Namespace: UnityEngine.InputSystem
Syntax
public struct MatchResult : IEnumerable<InputControlScheme.MatchResult.Match>, IEnumerable, IDisposable

Properties

devices

The devices that got picked from the available devices.

Declaration
public InputControlList<InputDevice> devices { get; }
Property Value
Type Description
InputControlList<InputDevice>

hasMissingOptionalDevices

Whether there are missing optional devices.

Declaration
public bool hasMissingOptionalDevices { get; }
Property Value
Type Description
System.Boolean
See Also

hasMissingRequiredDevices

Whether there are missing required devices.

Declaration
public bool hasMissingRequiredDevices { get; }
Property Value
Type Description
System.Boolean
See Also

isSuccessfulMatch

Whether the device requirements got successfully matched.

Declaration
public bool isSuccessfulMatch { get; }
Property Value
Type Description
System.Boolean

Item[Int32]

Declaration
public InputControlScheme.MatchResult.Match this[int index] { get; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type Description
InputControlScheme.MatchResult.Match

Methods

Dispose()

Discard the list of devices.

Declaration
public void Dispose()

GetEnumerator()

Enumerate the match for each individual InputControlScheme.DeviceRequirement in the control scheme.

Declaration
public IEnumerator<InputControlScheme.MatchResult.Match> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<InputControlScheme.MatchResult.Match>

An enumerate going over each individual match.

See Also