A game about forced loneliness, made by TACStudios
tacstudios.tngl.sh
1# Standalone Input Module
2
3The module is designed to work as you would expect a controller / mouse input to work. Events for button presses, dragging, and similar are sent in response to input.
4
5The module sends pointer events to components as a mouse / input device is moved around, and uses the [Graphics Raycaster](script-GraphicRaycaster.md) and [Physics Raycaster](script-PhysicsRaycaster.md) to calculate which element is currently pointed at by a given pointer device. You can configure these raycasters to detect or ignore parts of your Scene, to suit your requirements.
6
7The module sends move events and submit / cancel events in response to Input tracked via the [Input](https://docs.unity3d.com/Manual/class-InputManager.html) window. This works for both keyboard and controller input. The tracked axis and keys can be configured in the module's inspector.
8
9
10## Properties
11
12|**_Property:_** |**_Function:_** |
13|:---|:---|
14|__Horizontal Axis__ | Type the desired manager name for the horizontal axis button. |
15|__Vertical Axis__ | Type the desired manager name for the vertical axis. |
16|__Submit Button__ | Type the desired manager name for the Submit button. |
17|__Cancel Button__ | Type the desired manager name for the Cancel button. |
18|__Input Actions Per Second__ | Number of keyboard/controller inputs allowed per second. |
19|__Repeat Delay__ | Delay in seconds before the input actions per second repeat rate takes effect. |
20|__Force Module Active__ | Enable this property to force this __Standalone Input Module__ to be active. |
21
22## Details
23The module uses:
24
25- Vertical / Horizontal axis for keyboard and controller navigation
26- Submit / Cancel button for sending submit and cancel events
27- Has a timeout between events to only allow a maximum number of events a second.
28
29The flow for the module is as follows
30
31- Send a Move event to the selected object if a valid axis from the Input window is entered
32- Send a submit or cancel event to the selected object if a submit or cancel button is pressed
33- Process Mouse input
34 - If it is a new press
35 - Send PointerEnter event (sent to every object up the hierarchy that can handle it)
36 - Send PointerPress event
37 - Cache the drag handler (first element in the hierarchy that can handle it)
38 - Send BeginDrag event to the drag handler
39 - Set the 'Pressed' object as Selected in the event system
40 - If this is a continuing press
41 - Process movement
42 - Send DragEvent to the cached drag handler
43 - Handle PointerEnter and PointerExit events if touch moves between objects
44 - If this is a release
45 - Send PointerUp event to the object that received the PointerPress
46 - If the current hover object is the same as the PointerPress object send a PointerClick event
47 - Send a Drop event if there was a drag handler cached
48 - Send a EndDrag event to the cached drag handler
49 - Process scroll wheel events