docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class AnyKeyControl

    A control that simply checks the entire state it's been assigned for whether there's any non-zero bytes. If there are, the control returns 1.0; otherwise it returns 0.0.

    Inheritance
    object
    InputControl
    InputControl<float>
    AxisControl
    ButtonControl
    AnyKeyControl
    Inherited Members
    ButtonControl.pressPoint
    ButtonControl.pressPointOrDefault
    ButtonControl.IsValueConsideredPressed(float)
    ButtonControl.isPressed
    ButtonControl.wasPressedThisFrame
    ButtonControl.wasReleasedThisFrame
    ButtonControl.CalculateOptimizedControlDataType()
    AxisControl.clamp
    AxisControl.clampMin
    AxisControl.clampMax
    AxisControl.clampConstant
    AxisControl.invert
    AxisControl.normalize
    AxisControl.normalizeMin
    AxisControl.normalizeMax
    AxisControl.normalizeZero
    AxisControl.scale
    AxisControl.scaleFactor
    AxisControl.Preprocess(float)
    AxisControl.FinishSetup()
    AxisControl.WriteValueIntoState(float, void*)
    AxisControl.CompareValue(void*, void*)
    AxisControl.EvaluateMagnitude(void*)
    InputControl<float>.valueType
    InputControl<float>.valueSizeInBytes
    InputControl<float>.value
    InputControl<float>.ReadValue()
    InputControl<float>.ReadValueFromPreviousFrame()
    InputControl<float>.ReadDefaultValue()
    InputControl<float>.ReadValueFromState(void*)
    InputControl<float>.ReadValueFromStateWithCaching(void*)
    InputControl<float>.ReadUnprocessedValueFromStateWithCaching(void*)
    InputControl<float>.ReadUnprocessedValue()
    InputControl<float>.ReadValueFromStateAsObject(void*)
    InputControl<float>.ReadValueFromStateIntoBuffer(void*, void*, int)
    InputControl<float>.WriteValueFromBufferIntoState(void*, int, void*)
    InputControl<float>.WriteValueFromObjectIntoState(object, void*)
    InputControl<float>.ReadValueFromBufferAsObject(void*, int)
    InputControl<float>.ProcessValue(float)
    InputControl<float>.ProcessValue(ref float)
    InputControl.name
    InputControl.displayName
    InputControl.shortDisplayName
    InputControl.path
    InputControl.layout
    InputControl.variants
    InputControl.device
    InputControl.parent
    InputControl.children
    InputControl.usages
    InputControl.aliases
    InputControl.stateBlock
    InputControl.noisy
    InputControl.synthetic
    InputControl.this[string]
    InputControl.magnitude
    InputControl.ToString()
    InputControl.EvaluateMagnitude()
    InputControl.TryGetChildControl(string)
    InputControl.TryGetChildControl<TControl>(string)
    InputControl.GetChildControl(string)
    InputControl.GetChildControl<TControl>(string)
    InputControl.RefreshConfigurationIfNeeded()
    InputControl.RefreshConfiguration()
    InputControl.m_StateBlock
    InputControl.currentStatePtr
    InputControl.previousFrameStatePtr
    InputControl.defaultStatePtr
    InputControl.noiseMaskPtr
    InputControl.stateOffsetRelativeToDeviceRoot
    InputControl.optimizedControlDataType
    InputControl.ApplyParameterChanges()
    Namespace: UnityEngine.InputSystem.Controls
    Assembly: Unity.InputSystem.dll
    Syntax
    public class AnyKeyControl : ButtonControl
    Remarks

    This control is used by anyKey to create a button that is toggled on as long as any of the keys on the keyboard is pressed.

    wasPressedThisFrame is true in any frame in which a key goes down, even if other keys are already held. wasReleasedThisFrame is only true in the frame in which the last held key is released. This means that there can be several presses in a row without a release in between.

    Constructors

    AnyKeyControl()

    Default initialization. Sets state size to 1 bit and format to FormatBit.

    Declaration
    public AnyKeyControl()
    See Also
    anyKey

    Methods

    ReadUnprocessedValueFromState(void*)

    Read value from provided statePtr.

    Declaration
    public override float ReadUnprocessedValueFromState(void* statePtr)
    Parameters
    Type Name Description
    void* statePtr

    State pointer to read from.

    Returns
    Type Description
    float

    The controls current value.

    Overrides
    AxisControl.ReadUnprocessedValueFromState(void*)
    Remarks

    Read value from provided statePtr without any caching.

    See Also
    value

    Extension Methods

    InputControlExtensions.CheckStateIsAtDefault(InputControl)
    InputControlExtensions.CheckStateIsAtDefault(InputControl, void*, void*)
    InputControlExtensions.CheckStateIsAtDefaultIgnoringNoise(InputControl)
    InputControlExtensions.CheckStateIsAtDefaultIgnoringNoise(InputControl, void*)
    InputControlExtensions.CompareState(InputControl, void*, void*)
    InputControlExtensions.CompareState(InputControl, void*, void*, void*)
    InputControlExtensions.CompareStateIgnoringNoise(InputControl, void*)
    InputControlExtensions.FindControlsRecursive<TControl>(InputControl, IList<TControl>, Func<TControl, bool>)
    InputControlExtensions.FindInParentChain<TControl>(InputControl)
    InputControlExtensions.GetStatePtrFromStateEvent(InputControl, InputEventPtr)
    InputControlExtensions.HasValueChangeInEvent(InputControl, InputEventPtr)
    InputControlExtensions.HasValueChangeInState(InputControl, void*)
    InputControlExtensions.IsActuated(InputControl, float)
    InputControlExtensions.IsPressed(InputControl, float)
    InputControlExtensions.ReadDefaultValueAsObject(InputControl)
    InputControlExtensions.ReadValueAsObject(InputControl)
    InputControlExtensions.ReadValueFromEventAsObject(InputControl, InputEventPtr)
    InputControlExtensions.ReadValueIntoBuffer(InputControl, void*, int)
    InputControlExtensions.ResetToDefaultStateInEvent(InputControl, InputEventPtr)
    InputControlExtensions.WriteValueFromObjectIntoEvent(InputControl, InputEventPtr, object)
    InputControlExtensions.WriteValueIntoEvent<TValue>(InputControl, TValue, InputEventPtr)
    InputControlExtensions.WriteValueIntoState(InputControl, void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl, TValue, void*)
    InputControlExtensions.AccumulateValueInEvent(InputControl<float>, void*, InputEventPtr)
    InputControlExtensions.QueueValueChange<TValue>(InputControl<TValue>, TValue, double)
    InputControlExtensions.ReadUnprocessedValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr)
    InputControlExtensions.ReadUnprocessedValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.WriteValueIntoEvent<TValue>(InputControl<TValue>, TValue, InputEventPtr)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl<TValue>, TValue, void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl<TValue>, void*)
    InputControlExtensions.WriteValueIntoState<TValue, TState>(InputControl<TValue>, TValue, ref TState)

    See Also

    anyKey
    In This Article
    Back to top
    Copyright © 2026 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)