Class InputStateHistory<TValue> | Input System | 1.0.2
docs.unity.cn
    Show / Hide Table of Contents

    Class InputStateHistory<TValue>

    Records value changes of a given control over time.

    Inheritance
    Object
    InputStateHistory
    InputStateHistory<TValue>
    Inherited Members
    InputStateHistory.Count
    InputStateHistory.version
    InputStateHistory.historyDepth
    InputStateHistory.extraMemoryPerRecord
    InputStateHistory.updateMask
    InputStateHistory.controls
    InputStateHistory.onRecordAdded
    InputStateHistory.onShouldRecordStateChange
    InputStateHistory.Clear()
    InputStateHistory.AddRecord(InputStateHistory.Record)
    InputStateHistory.StartRecording()
    InputStateHistory.StopRecording()
    InputStateHistory.RecordStateChange(InputControl, InputEventPtr)
    InputStateHistory.RecordStateChange(InputControl, Void*, Double)
    InputStateHistory.Dispose()
    InputStateHistory.Destroy()
    InputStateHistory.RecordIndexToUserIndex(Int32)
    InputStateHistory.UserIndexToRecordIndex(Int32)
    InputStateHistory.GetRecord(Int32)
    InputStateHistory.AllocateRecord(Int32)
    InputStateHistory.ReadValue<TValue>(InputStateHistory.RecordHeader*)
    InputStateHistory.ReadValueAsObject(InputStateHistory.RecordHeader*)
    InputStateHistory.IInputStateChangeMonitor.NotifyControlStateChanged(InputControl, Double, InputEventPtr, Int64)
    InputStateHistory.IInputStateChangeMonitor.NotifyTimerExpired(InputControl, Double, Int64, Int32)
    Namespace: UnityEngine.InputSystem.LowLevel
    Syntax
    public class InputStateHistory<TValue> : InputStateHistory, IDisposable, IEnumerable<InputStateHistory.Record>, IEnumerable, IInputStateChangeMonitor, IReadOnlyList<InputStateHistory<TValue>.Record> where TValue : struct
    Type Parameters
    Name Description
    TValue

    Constructors

    InputStateHistory(Nullable<Int32>)

    Declaration
    public InputStateHistory(int? maxStateSizeInBytes = default(int? ))
    Parameters
    Type Name Description
    Nullable<Int32> maxStateSizeInBytes

    InputStateHistory(String)

    Declaration
    public InputStateHistory(string path)
    Parameters
    Type Name Description
    String path

    InputStateHistory(InputControl<TValue>)

    Declaration
    public InputStateHistory(InputControl<TValue> control)
    Parameters
    Type Name Description
    InputControl<TValue> control

    Properties

    Item[Int32]

    Declaration
    public InputStateHistory<TValue>.Record this[int index] { get; set; }
    Parameters
    Type Name Description
    Int32 index
    Property Value
    Type Description
    InputStateHistory.Record<>

    Methods

    AddRecord(InputStateHistory<TValue>.Record)

    Declaration
    public InputStateHistory<TValue>.Record AddRecord(InputStateHistory<TValue>.Record record)
    Parameters
    Type Name Description
    InputStateHistory.Record<> record
    Returns
    Type Description
    InputStateHistory.Record<>

    Finalize()

    Declaration
    protected void Finalize()

    GetEnumerator()

    Declaration
    public IEnumerator<InputStateHistory<TValue>.Record> GetEnumerator()
    Returns
    Type Description
    IEnumerator<InputStateHistory.Record<>>

    RecordStateChange(InputControl<TValue>, TValue, Double)

    Declaration
    public InputStateHistory<TValue>.Record RecordStateChange(InputControl<TValue> control, TValue value, double time = -1)
    Parameters
    Type Name Description
    InputControl<TValue> control
    TValue value
    Double time
    Returns
    Type Description
    InputStateHistory.Record<>

    Explicit Interface Implementations

    IEnumerable.GetEnumerator()

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type Description
    IEnumerator
    Implements
    IEnumerable.GetEnumerator()
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX
    on 22 January 2021