Struct InputControlScheme.MatchResult | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct InputControlScheme.MatchResult

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

    Inherited Members
    System.ValueType.Equals(System.Object)
    System.ValueType.GetHashCode()
    System.ValueType.ToString()
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    Namespace: UnityEngine.Experimental.Input
    Syntax
    public struct MatchResult : IEnumerable<InputControlScheme.MatchResult.Match>, 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
    isOptional

    hasMissingRequiredDevices

    Whether there are missing required devices.

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

    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
    IEnumerator<InputControlScheme.MatchResult.Match>

    An enumerate going over each individual match.

    See Also

    PickDevicesFrom<TDevices>(TDevices)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023