docs.unity3d.com
    Show / Hide Table of Contents

    Class RecordingInputModule

    Inheritance
    Object
    UIBehaviour
    BaseInputModule
    PointerInputModule
    RecordingInputModule
    Inherited Members
    PointerInputModule.kMouseLeftId
    PointerInputModule.kMouseRightId
    PointerInputModule.kMouseMiddleId
    PointerInputModule.kFakeTouchesId
    PointerInputModule.m_PointerData
    PointerInputModule.GetPointerData(Int32, PointerEventData, Boolean)
    PointerInputModule.RemovePointerData(PointerEventData)
    PointerInputModule.GetTouchPointerEventData(Touch, Boolean, Boolean)
    PointerInputModule.CopyFromTo(PointerEventData, PointerEventData)
    PointerInputModule.StateForMouseButton(Int32)
    PointerInputModule.GetMousePointerEventData()
    PointerInputModule.GetMousePointerEventData(Int32)
    PointerInputModule.GetLastPointerEventData(Int32)
    PointerInputModule.IsPointerOverGameObject(Int32)
    PointerInputModule.ClearSelection()
    PointerInputModule.ToString()
    PointerInputModule.DeselectIfSelectionChanged(GameObject, BaseEventData)
    BaseInputModule.m_RaycastResultCache
    BaseInputModule.m_InputOverride
    BaseInputModule.OnDisable()
    BaseInputModule.FindFirstRaycast(List<RaycastResult>)
    BaseInputModule.DetermineMoveDirection(Single, Single)
    BaseInputModule.DetermineMoveDirection(Single, Single, Single)
    BaseInputModule.FindCommonRoot(GameObject, GameObject)
    BaseInputModule.HandlePointerExitAndEnter(PointerEventData, GameObject)
    BaseInputModule.GetAxisEventData(Single, Single, Single)
    BaseInputModule.GetBaseEventData()
    BaseInputModule.input
    BaseInputModule.inputOverride
    BaseInputModule.eventSystem
    UIBehaviour.Start()
    UIBehaviour.OnDestroy()
    UIBehaviour.IsActive()
    UnityEngine.EventSystems.UIBehaviour.OnValidate()
    UnityEngine.EventSystems.UIBehaviour.Reset()
    UIBehaviour.OnRectTransformDimensionsChange()
    UIBehaviour.OnBeforeTransformParentChanged()
    UIBehaviour.OnTransformParentChanged()
    UIBehaviour.OnDidApplyAnimationProperties()
    UIBehaviour.OnCanvasGroupChanged()
    UIBehaviour.OnCanvasHierarchyChanged()
    UIBehaviour.IsDestroyed()
    Namespace: UnityEngine.EventSystems
    Syntax
    [AddComponentMenu("Automated QA/Recording Input Module")]
    public class RecordingInputModule : PointerInputModule

    Constructors

    RecordingInputModule()

    Declaration
    protected RecordingInputModule()

    Properties

    cancelButton

    Input manager name for the 'cancel' button.

    Declaration
    public string cancelButton { get; set; }
    Property Value
    Type Description
    String

    horizontalAxis

    Name of the horizontal axis for movement (if axis events are used).

    Declaration
    public string horizontalAxis { get; set; }
    Property Value
    Type Description
    String

    inputActionsPerSecond

    Number of keyboard / controller inputs allowed per second.

    Declaration
    public float inputActionsPerSecond { get; set; }
    Property Value
    Type Description
    Single

    Instance

    Declaration
    public static RecordingInputModule Instance { get; set; }
    Property Value
    Type Description
    RecordingInputModule

    isWorkInProgress

    Declaration
    [SerializeField]
    [HideInInspector]
    public static bool isWorkInProgress { get; set; }
    Property Value
    Type Description
    Boolean

    RecordingMode

    Declaration
    public RecordingMode RecordingMode { get; }
    Property Value
    Type Description
    RecordingMode

    repeatDelay

    Delay in seconds before the input actions per second repeat rate takes effect.

    Declaration
    public float repeatDelay { get; set; }
    Property Value
    Type Description
    Single
    Remarks

    If the same direction is sustained, the inputActionsPerSecond property can be used to control the rate at which events are fired. However, it can be desirable that the first repetition is delayed, so the user doesn't get repeated actions by accident.

    submitButton

    Maximum number of input events handled per second.

    Declaration
    public string submitButton { get; set; }
    Property Value
    Type Description
    String

    verticalAxis

    Name of the vertical axis for movement (if axis events are used).

    Declaration
    public string verticalAxis { get; set; }
    Property Value
    Type Description
    String

    Methods

    ActivateModule()

    See BaseInputModule.

    Declaration
    public override void ActivateModule()
    Overrides
    BaseInputModule.ActivateModule()

    AddTouchData(RecordingInputModule.TouchData)

    Declaration
    public void AddTouchData(RecordingInputModule.TouchData data)
    Parameters
    Type Name Description
    RecordingInputModule.TouchData data

    Awake()

    Declaration
    protected override void Awake()
    Overrides
    UIBehaviour.Awake()

    CaptureScreenshots()

    Declaration
    public void CaptureScreenshots()

    ClearTouchData()

    Declaration
    public void ClearTouchData()

    DeactivateModule()

    See BaseInputModule.

    Declaration
    public override void DeactivateModule()
    Overrides
    BaseInputModule.DeactivateModule()

    EndRecording()

    Declaration
    public void EndRecording()

    GetCurrentIndex()

    Declaration
    public int GetCurrentIndex()
    Returns
    Type Description
    Int32

    GetTouchData()

    Declaration
    public List<RecordingInputModule.TouchData> GetTouchData()
    Returns
    Type Description
    List<RecordingInputModule.TouchData>

    InsertTouchData(Int32, RecordingInputModule.TouchData[])

    Declaration
    public void InsertTouchData(int index, params RecordingInputModule.TouchData[] data)
    Parameters
    Type Name Description
    Int32 index
    RecordingInputModule.TouchData[] data

    IsModuleSupported()

    Declaration
    public override bool IsModuleSupported()
    Returns
    Type Description
    Boolean
    Overrides
    BaseInputModule.IsModuleSupported()

    IsPlaybackActive()

    Declaration
    public bool IsPlaybackActive()
    Returns
    Type Description
    Boolean

    IsPlaybackCompleted()

    Declaration
    public bool IsPlaybackCompleted()
    Returns
    Type Description
    Boolean

    OnEnable()

    Declaration
    protected override void OnEnable()
    Overrides
    BaseInputModule.OnEnable()

    Pause(String)

    Declaration
    public void Pause(string signal)
    Parameters
    Type Name Description
    String signal

    Process()

    Declaration
    public override void Process()
    Overrides
    BaseInputModule.Process()

    ProcessDrag(PointerEventData)

    Declaration
    protected override void ProcessDrag(PointerEventData pointerEvent)
    Parameters
    Type Name Description
    PointerEventData pointerEvent
    Overrides
    PointerInputModule.ProcessDrag(PointerEventData)

    ProcessMove(PointerEventData)

    Declaration
    protected override void ProcessMove(PointerEventData pointerEvent)
    Parameters
    Type Name Description
    PointerEventData pointerEvent
    Overrides
    PointerInputModule.ProcessMove(PointerEventData)

    SaveRecordingSegment()

    Declaration
    public void SaveRecordingSegment()

    Screenshot()

    Declaration
    public static void Screenshot()

    SendSignal(String)

    Declaration
    public void SendSignal(string name)
    Parameters
    Type Name Description
    String name

    SetConfigMode(RecordingMode, Boolean)

    Declaration
    public void SetConfigMode(RecordingMode mode, bool persist = false)
    Parameters
    Type Name Description
    RecordingMode mode
    Boolean persist

    SetTouchData(List<RecordingInputModule.TouchData>)

    Declaration
    public void SetTouchData(List<RecordingInputModule.TouchData> data)
    Parameters
    Type Name Description
    List<RecordingInputModule.TouchData> data

    ShouldActivateModule()

    Declaration
    public override bool ShouldActivateModule()
    Returns
    Type Description
    Boolean
    Overrides
    BaseInputModule.ShouldActivateModule()

    Update()

    Declaration
    protected virtual void Update()

    UpdateModule()

    Declaration
    public override void UpdateModule()
    Overrides
    BaseInputModule.UpdateModule()
    Back to top
    Terms of use
    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