Class StandaloneInputModule
A BaseInputModule designed for mouse / keyboard / controller input.
Inheritance
Inherited Members
Namespace: UnityEngine.EventSystems
Assembly: UnityEngine.UI.dll
Syntax
[AddComponentMenu("Event/Standalone Input Module")]
public class StandaloneInputModule : PointerInputModule
Remarks
Input module for working with, mouse, keyboard, or controller.
Constructors
StandaloneInputModule()
Protected default constructor. Use UnityEngine.GameObject.AddComponent<T>() to add a StandaloneInputModule to a GameObject.
Declaration
protected StandaloneInputModule()
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 |
|---|---|
| float |
repeatDelay
Delay in seconds before the input actions per second repeat rate takes effect.
Declaration
public float repeatDelay { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
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()
Called when the module is activated. Override this if you want custom code to execute when you activate your module.
Declaration
public override void ActivateModule()
Overrides
DeactivateModule()
Called when the module is deactivated. Override this if you want custom code to execute when you deactivate your module.
Declaration
public override void DeactivateModule()
Overrides
GetCurrentFocusedGameObject()
Returns the GameObject that is currently in focus.
Declaration
protected GameObject GetCurrentFocusedGameObject()
Returns
| Type | Description |
|---|---|
| GameObject | The last GameObject under the pointer, or |
Process()
Processes the touch, mouse, and navigation input of this frame, and sends the resulting events.
Declaration
public override void Process()
Overrides
ProcessMouseEvent()
Process all mouse events for the default mouse.
Declaration
protected void ProcessMouseEvent()
ProcessMouseEvent(int)
Process all mouse events.
Declaration
protected void ProcessMouseEvent(int id)
Parameters
| Type | Name | Description |
|---|---|---|
| int | id | The ID of the mouse to process the events of. |
ProcessMousePress(MouseButtonEventData)
Process any mouse button state changes.
Declaration
protected void ProcessMousePress(PointerInputModule.MouseButtonEventData data)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerInputModule.MouseButtonEventData | data | The event data of the mouse button to process. |
ProcessTouchPress(PointerEventData, bool, bool)
This method is called by Unity whenever a touch event is processed. Override this method with a custom implementation to process touch events yourself.
Declaration
protected void ProcessTouchPress(PointerEventData pointerEvent, bool pressed, bool released)
Parameters
| Type | Name | Description |
|---|---|---|
| PointerEventData | pointerEvent | Event data relating to the touch event, such as position and ID to be passed to the touch event destination object. |
| bool | pressed | This is true for the first frame of a touch event, and false thereafter. This can therefore be used to determine the instant a touch event occurred. |
| bool | released | This is true only for the last frame of a touch event. |
Remarks
This method can be overridden in derived classes to change how touch press events are handled.
SendMoveEventToSelectedObject()
Calculate and send a move event to the current selected object.
Declaration
protected bool SendMoveEventToSelectedObject()
Returns
| Type | Description |
|---|---|
| bool | If the move event was used by the selected object. |
SendSubmitEventToSelectedObject()
Calculate and send a submit event to the current selected object.
Declaration
protected bool SendSubmitEventToSelectedObject()
Returns
| Type | Description |
|---|---|
| bool | If the submit event was used by the selected object. |
SendUpdateEventToSelectedObject()
Send an update event to the current selected object.
Declaration
protected bool SendUpdateEventToSelectedObject()
Returns
| Type | Description |
|---|---|
| bool | True if the selected object used the event. |
ShouldActivateModule()
Should the module be activated.
Declaration
public override bool ShouldActivateModule()
Returns
| Type | Description |
|---|---|
| bool | True if the EventSystem can make this module the current one. |
Overrides
UpdateModule()
Updates the tracked mouse position, or releases any ongoing drag if the application has lost focus.
Declaration
public override void UpdateModule()