Class InputSystemUIInputModule

Input module that takes its input from InputAction.

Inheritance

System.Object

InputSystemUIInputModule

Namespace: UnityEngine.InputSystem.UI

Syntax

public class InputSystemUIInputModule : BaseInputModule

Remarks

This UI input module has the advantage over other such modules that it doesn't have to know what devices and types of devices input is coming from. Instead, the actions hide the actual sources of input from the module.

Properties

actionsAsset

Declaration

public InputActionAsset actionsAsset { get; set; }

Property Value

Type	Description
InputActionAsset

cancel

An InputAction delivering a System.Boolean used for sending events.

Declaration

public InputActionReference cancel { get; set; }

Property Value

Type	Description
InputActionReference

leftClick

An InputAction delivering a System.Boolean used for sending events.

Declaration

public InputActionReference leftClick { get; set; }

Property Value

Type	Description
InputActionReference

middleClick

An InputAction delivering a System.Boolean used for sending events.

Declaration

public InputActionReference middleClick { get; set; }

Property Value

Type	Description
InputActionReference

move

An InputAction delivering a 2D motion vector. used for sending events.

Declaration

public InputActionReference move { get; set; }

Property Value

Type	Description
InputActionReference

point

An InputAction delivering a 2D screen position. used as a cursor for pointing at UI elements.

Declaration

public InputActionReference point { get; set; }

Property Value

Type	Description
InputActionReference

repeatDelay

Declaration

public float repeatDelay { get; set; }

Property Value

Type	Description
System.Single

repeatRate

Declaration

public float repeatRate { get; set; }

Property Value

Type	Description
System.Single

rightClick

An InputAction delivering a System.Boolean used for sending events.

Declaration

public InputActionReference rightClick { get; set; }

Property Value

Type	Description
InputActionReference

scrollWheel

An InputAction delivering a scroll wheel value. used for sending events.

Declaration

public InputActionReference scrollWheel { get; set; }

Property Value

Type	Description
InputActionReference

submit

An InputAction delivering a System.Boolean used for sending events.

Declaration

public InputActionReference submit { get; set; }

Property Value

Type	Description
InputActionReference

trackedDeviceDragThresholdMultiplier

Declaration

public float trackedDeviceDragThresholdMultiplier { get; set; }

Property Value

Type	Description
System.Single

trackedDeviceOrientation

Declaration

public InputActionReference trackedDeviceOrientation { get; set; }

Property Value

Type	Description
InputActionReference

trackedDevicePosition

Declaration

public InputActionReference trackedDevicePosition { get; set; }

Property Value

Type	Description
InputActionReference

trackedDeviceSelect

Declaration

public InputActionReference trackedDeviceSelect { get; set; }

Property Value

Type	Description
InputActionReference

Methods

ActivateModule()

Declaration

public override void ActivateModule()

Awake()

Declaration

protected override void Awake()

DisableAllActions()

This is a quick accessor for disabling all actions currently enabled. Currently, action ownership is ambiguous, and we need a way to enable/disable inspector-set actions.

Declaration

public void DisableAllActions()

EnableAllActions()

This is a quick accessor for enabling all actions. Currently, action ownership is ambiguous, and we need a way to enable/disable inspector-set actions.

Declaration

public void EnableAllActions()

OnDestroy()

Declaration

protected override void OnDestroy()

OnDisable()

Declaration

protected override void OnDisable()

OnEnable()

Declaration

protected override void OnEnable()

Process()

Declaration

public override void Process()