A game about forced loneliness, made by TACStudios
tacstudios.tngl.sh
1using UnityEngine.InputSystem.Utilities;
2
3namespace UnityEngine.InputSystem
4{
5 /// <summary>
6 /// A collection of common usage string values as reported by <see cref="InputControl.usages"/>.
7 /// </summary>
8 public static class CommonUsages
9 {
10 /// <summary>
11 /// Primary 2D motion control.
12 /// </summary>
13 /// <remarks>
14 /// Example: Left stick on a gamepad.
15 /// </remarks>
16 public static readonly InternedString Primary2DMotion = new InternedString("Primary2DMotion");
17
18 /// <summary>
19 /// Secondary 2D motion control.
20 /// </summary>
21 /// <remarks>
22 /// Example: Right stick on a gamepad.
23 /// </remarks>
24 public static readonly InternedString Secondary2DMotion = new InternedString("Secondary2DMotion");
25
26 /// <summary>
27 /// The primary action control on any input device, such as a gamepad, mouse, or keyboard.
28 /// </summary>
29 /// <remarks>
30 /// Example: Primary mouse button (left button on right-handed configuration, right button on left-handed configuration),
31 /// south-button on a gamepad.
32 /// </remarks>
33 public static readonly InternedString PrimaryAction = new InternedString("PrimaryAction");
34
35 /// <summary>
36 /// Secondary action control on any input device, such as a gamepad, mouse, or keyboard.
37 /// </summary>
38 /// <remarks>
39 /// Example: Secondary mouse button (right button on right-handed configuration, left button on left-handed configuration),
40 /// east-button on a gamepad.
41 /// </remarks>
42 public static readonly InternedString SecondaryAction = new InternedString("SecondaryAction");
43
44 /// <summary>
45 /// The primary trigger control on input devices with triggers.
46 /// </summary>
47 /// <remarks>
48 /// Example: Right trigger-button on a gamepad.
49 /// </remarks>
50 public static readonly InternedString PrimaryTrigger = new InternedString("PrimaryTrigger");
51
52 /// <summary>
53 /// The secondary trigger control on input devices with triggers.
54 /// </summary>
55 /// <remarks>
56 /// Example: Left trigger-button on a gamepad.
57 /// </remarks>
58 public static readonly InternedString SecondaryTrigger = new InternedString("SecondaryTrigger");
59
60 /// <summary>
61 /// A modifier action control that modifies usage of other controls.
62 /// </summary>
63 /// <remarks>
64 /// Example: Keyboard modifier keys like CTRL, SHIFT, ALT, OPTION, etc.
65 /// </remarks>
66 public static readonly InternedString Modifier = new InternedString("Modifier");
67
68 /// <summary>
69 /// The spatial position control on input devices with spatial tracking.
70 /// </summary>
71 /// <remarks>
72 /// Example: User head position in tracking-space using e.g. a head-tracking system. This could for example be a VR tracking system or another user-facing tracking sensor.
73 /// </remarks>
74 public static readonly InternedString Position = new InternedString("Position");
75
76 /// <summary>
77 /// The spatial orientation control on input devices with spatial tracking.
78 /// </summary>
79 /// <remarks>
80 /// Example: User head-orientation in tracking-space using e.g. a head-tracking system. This could for example be a VR tracking system or another user-facing tracking sensor.
81 /// </remarks>
82 public static readonly InternedString Orientation = new InternedString("Orientation");
83
84 /// <summary>
85 /// The primary hat-switch control on input devices with hat-switches such as joysticks or gamepads.
86 /// </summary>
87 /// <remarks>
88 /// Example: Joystick or gamepad hat-switch.
89 /// </remarks>
90 public static readonly InternedString Hatswitch = new InternedString("Hatswitch");
91
92 /// <summary>
93 /// Button to navigate to previous location.
94 /// </summary>
95 /// <remarks>
96 /// Example: Escape on keyboard, B button on gamepad.
97 ///
98 /// In general, the "Back" control is used for moving backwards in the navigation history
99 /// of a UI. This is used, for example, in hierarchical menu structures to move back to parent menus
100 /// (e.g. from the "Settings" menu back to the "Main" menu). Consoles generally have stringent requirements
101 /// as to which button has to fulfill this role.
102 /// </remarks>
103 public static readonly InternedString Back = new InternedString("Back");
104
105 /// <summary>
106 /// Button to navigate to next location.
107 /// </summary>
108 public static readonly InternedString Forward = new InternedString("Forward");
109
110 /// <summary>
111 /// Button to bring up menu.
112 /// </summary>
113 public static readonly InternedString Menu = new InternedString("Menu");
114
115 /// <summary>
116 /// Button to confirm the current choice.
117 /// </summary>
118 public static readonly InternedString Submit = new InternedString("Submit");
119
120 ////REVIEW: isn't this the same as "Back"?
121 /// <summary>
122 /// Button to not accept the current choice.
123 /// </summary>
124 public static readonly InternedString Cancel = new InternedString("Cancel");
125
126 /// <summary>
127 /// Horizontal motion axis.
128 /// </summary>
129 /// <remarks>
130 /// Example: X axis on mouse.
131 /// </remarks>
132 public static readonly InternedString Horizontal = new InternedString("Horizontal");
133
134 /// <summary>
135 /// Vertical motion axis.
136 /// </summary>
137 /// <remarks>
138 /// Example: Y axis on mouse.
139 /// </remarks>
140 public static readonly InternedString Vertical = new InternedString("Vertical");
141
142 /// <summary>
143 /// Rotation around single, fixed axis.
144 /// </summary>
145 /// <remarks>
146 /// Example: twist on joystick or twist of pen (few pens support that).
147 /// </remarks>
148 public static readonly InternedString Twist = new InternedString("Twist");
149
150 /// <summary>
151 /// Pressure level axis.
152 /// </summary>
153 /// <remarks>
154 /// Example: pen pressure.
155 /// </remarks>
156 public static readonly InternedString Pressure = new InternedString("Pressure");
157
158 /// <summary>
159 /// Axis to scroll horizontally.
160 /// </summary>
161 public static readonly InternedString ScrollHorizontal = new InternedString("ScrollHorizontal");
162
163 /// <summary>
164 /// Axis to scroll vertically.
165 /// </summary>
166 public static readonly InternedString ScrollVertical = new InternedString("ScrollVertical");
167
168 /// <summary>
169 /// A screen-space point.
170 /// </summary>
171 /// <remarks>
172 /// Example: Touch contact point.
173 /// </remarks>
174 public static readonly InternedString Point = new InternedString("Point");
175
176 /// <summary>
177 /// Low-frequency haptic motor for force-feedback.
178 /// </summary>
179 public static readonly InternedString LowFreqMotor = new InternedString("LowFreqMotor");
180
181 /// <summary>
182 /// High-frequency haptic motor for force-feedback.
183 /// </summary>
184 public static readonly InternedString HighFreqMotor = new InternedString("HighFreqMotor");
185
186 /// <summary>
187 /// Device in left hand.
188 /// </summary>
189 /// <remarks>
190 /// Example: left hand XR controller.
191 /// </remarks>
192 public static readonly InternedString LeftHand = new InternedString("LeftHand");
193
194 /// <summary>
195 /// Device in right hand.
196 /// </summary>
197 /// <remarks>
198 /// Example: right hand XR controller.
199 /// </remarks>
200 public static readonly InternedString RightHand = new InternedString("RightHand");
201
202 /// <summary>
203 /// Axis representing charge of battery (1=full, 0=empty).
204 /// </summary>
205 public static readonly InternedString BatteryStrength = new InternedString("BatteryStrength");
206 }
207}