Class RecordingInputModule

Inheritance
Object
UIBehaviour
BaseInputModule
PointerInputModule
RecordingInputModule
Inherited Members
UnityEngine.EventSystems.UIBehaviour.OnValidate()
UnityEngine.EventSystems.UIBehaviour.Reset()
Namespace: UnityEngine.EventSystems
Syntax
[AddComponentMenu("Event/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

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

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

DeactivateModule()

See BaseInputModule.

Declaration
public override void DeactivateModule()
Overrides

IsModuleSupported()

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

IsPlaybackCompleted()

Declaration
public bool IsPlaybackCompleted()
Returns
Type Description
Boolean

OnEnable()

Declaration
protected override void OnEnable()
Overrides

Pause(String)

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

Process()

Declaration
public override void Process()
Overrides

ProcessDrag(PointerEventData)

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

ProcessMove(PointerEventData)

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

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
Overrides

Update()

Declaration
protected virtual void Update()

UpdateModule()

Declaration
public override void UpdateModule()
Overrides