docs.unity3d.com
    Show / Hide Table of Contents

    Class RecordingInputModule

    Inheritance
    Object
    RecordingInputModule
    Namespace: UnityEngine.EventSystems
    Syntax
    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

    forceModuleActive

    Force this module to be active.

    Declaration
    public bool forceModuleActive { get; set; }
    Property Value
    Type Description
    Boolean
    Remarks

    If there is no module active with higher priority (ordered in the inspector) this module will be forced active even if valid enabling conditions are not met.

    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

    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()

    CaptureScreenshots()

    Declaration
    public void CaptureScreenshots()

    DeactivateModule()

    See BaseInputModule.

    Declaration
    public override void DeactivateModule()

    GetActiveGameObjects()

    Declaration
    public List<GameObject> GetActiveGameObjects()
    Returns
    Type Description
    List<GameObject>

    GetChildren(List<GameObject>)

    Declaration
    public static List<GameObject> GetChildren(List<GameObject> objs)
    Parameters
    Type Name Description
    List<GameObject> objs
    Returns
    Type Description
    List<GameObject>

    IsModuleSupported()

    Declaration
    public override bool IsModuleSupported()
    Returns
    Type Description
    Boolean

    IsPlaybackCompleted()

    Declaration
    public bool IsPlaybackCompleted()
    Returns
    Type Description
    Boolean

    OnEnable()

    Declaration
    protected override void OnEnable()

    Pause(String)

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

    Process()

    Declaration
    public override void Process()

    ProcessDrag(PointerEventData)

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

    ProcessMove(PointerEventData)

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

    SaveRecordingSegment()

    Declaration
    public void SaveRecordingSegment()

    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

    ShouldActivateModule()

    Declaration
    public override bool ShouldActivateModule()
    Returns
    Type Description
    Boolean

    Update()

    Declaration
    protected virtual void Update()

    UpdateModule()

    Declaration
    public override void UpdateModule()
    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