docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class StickDeadzoneProcessor

    Processes a Vector2 to apply deadzoning according to the magnitude of the vector (rather than just clamping individual axes). Normalizes to the min/max range.

    Inheritance
    object
    InputProcessor
    InputProcessor<Vector2>
    StickDeadzoneProcessor
    Inherited Members
    InputProcessor<Vector2>.ProcessAsObject(object, InputControl)
    InputProcessor<Vector2>.Process(void*, int, InputControl)
    InputProcessor.cachingPolicy
    Namespace: UnityEngine.InputSystem.Processors
    Assembly: Unity.InputSystem.dll
    Syntax
    public class StickDeadzoneProcessor : InputProcessor<Vector2>

    Fields

    max

    Declaration
    public float max
    Field Value
    Type Description
    float
    See Also
    AxisDeadzoneProcessor

    min

    Value at which the lower bound deadzone starts.

    Declaration
    public float min
    Field Value
    Type Description
    float
    Remarks

    Values in the input at or below min will get dropped and values will be scaled to the range between min and max.

    See Also
    AxisDeadzoneProcessor

    Methods

    Process(Vector2, InputControl)

    Process the given value and return the result.

    Declaration
    public override Vector2 Process(Vector2 value, InputControl control = null)
    Parameters
    Type Name Description
    Vector2 value

    Input value to process.

    InputControl control

    Control that the value originally came from. This can be null if the value did not originate from a control. This can be the case, for example, if the processor sits on a composite binding (InputBindingComposite) as composites are not directly associated with controls but rather source their values through their child bindings.

    Returns
    Type Description
    Vector2

    Processed input value.

    Overrides
    InputProcessor<Vector2>.Process(Vector2, InputControl)
    Remarks

    The implementation of this method must not be stateful.

    See Also
    AxisDeadzoneProcessor

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()
    See Also
    AxisDeadzoneProcessor

    See Also

    AxisDeadzoneProcessor

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Fields
      • max
      • min
    • Methods
      • Process(Vector2, InputControl)
      • ToString()
    • See Also
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)