55name : InputBinding
66type : class
77memory_category : Instances
8- summary : Defines which hardware binding should trigger the parent `Class.InputAction`.
9- description : |-
8+ summary : |
9+ Defines which hardware binding should trigger the parent `Class.InputAction`.
10+ description : |
1011 An `InputBinding` defines which hardware binding should trigger the parent
1112 `Class.InputAction`, for example a key press, gamepad button, or tap on a
1213 touch‑enabled device. There can be multiple `InputBinding` instances parented
@@ -19,10 +20,10 @@ tags: []
1920deprecation_message : ' '
2021properties :
2122 - name : InputBinding.Backward
22- summary : |-
23+ summary : |
2324 Specifies an alternate `Enum.KeyCode` for dispatching directionally
2425 "backward" inputs to the parent `Class.InputAction`.
25- description : |-
26+ description : |
2627 Specifies an alternate `Enum.KeyCode` for dispatching directionally
2728 "backward" inputs to `Class.InputAction:GetState()|GetState()` and the
2829 `Class.InputAction.StateChanged|StateChanged` event of the parent
@@ -45,10 +46,10 @@ properties:
4546 capabilities :
4647 - Input
4748 - name : InputBinding.Down
48- summary : |-
49+ summary : |
4950 Specifies an alternate `Enum.KeyCode` for dispatching directionally "down"
5051 inputs to the parent `Class.InputAction`.
51- description : |-
52+ description : |
5253 Specifies an alternate `Enum.KeyCode` for dispatching directionally "down"
5354 inputs to `Class.InputAction:GetState()|GetState()` and the
5455 `Class.InputAction.StateChanged|StateChanged` event of the parent
@@ -85,10 +86,10 @@ properties:
8586 capabilities :
8687 - Input
8788 - name : InputBinding.Forward
88- summary : |-
89+ summary : |
8990 Specifies an alternate `Enum.KeyCode` for dispatching directionally
9091 "forward" inputs to the parent `Class.InputAction`.
91- description : |-
92+ description : |
9293 Specifies an alternate `Enum.KeyCode` for dispatching directionally
9394 "forward" inputs to `Class.InputAction:GetState()|GetState()` and the
9495 `Class.InputAction.StateChanged|StateChanged` event of the parent
@@ -111,10 +112,10 @@ properties:
111112 capabilities :
112113 - Input
113114 - name : InputBinding.KeyCode
114- summary : |-
115+ summary : |
115116 Specifies the `Enum.KeyCode` which triggers the parent
116117 `Class.InputAction`.
117- description : |-
118+ description : |
118119 Specifies the `Enum.KeyCode` which triggers the parent
119120 `Class.InputAction`. The code type should match the input action's
120121 `Class.InputAction.Type|Type`, for example `Enum.KeyCode.E` for an action
@@ -138,10 +139,10 @@ properties:
138139 capabilities :
139140 - Input
140141 - name : InputBinding.Left
141- summary : |-
142+ summary : |
142143 Specifies an alternate `Enum.KeyCode` for dispatching directionally "left"
143144 inputs to the parent `Class.InputAction`.
144- description : |-
145+ description : |
145146 Specifies an alternate `Enum.KeyCode` for dispatching directionally "left"
146147 inputs to `Class.InputAction:GetState()|GetState()` and the
147148 `Class.InputAction.StateChanged|StateChanged` event of the parent
@@ -174,10 +175,10 @@ properties:
174175 capabilities :
175176 - Input
176177 - name : InputBinding.PressedThreshold
177- summary : |-
178+ summary : |
178179 Numerical value above which to fire an `Class.InputAction` with a
179180 `Class.InputAction.Type|Type` of `Enum.InputActionType|Bool`.
180- description : |-
181+ description : |
181182 Numerical value above which to fire an `Class.InputAction` with a
182183 `Class.InputAction.Type|Type` of `Enum.InputActionType|Bool`, for example
183184 when a gamepad trigger such as `Enum.KeyCode.ButtonL2` exceeds `0.5`
@@ -201,10 +202,10 @@ properties:
201202 capabilities :
202203 - Input
203204 - name : InputBinding.ReleasedThreshold
204- summary : |-
205+ summary : |
205206 Numerical value below which to fire an `Class.InputAction` with a
206207 `Class.InputAction.Type|Type` of `Enum.InputActionType|Bool`.
207- description : |-
208+ description : |
208209 Numerical value below which to fire an `Class.InputAction` with a
209210 `Class.InputAction.Type|Type` of `Enum.InputActionType|Bool`, for example
210211 when a gamepad trigger such as `Enum.KeyCode.ButtonL2` falls below `0.5`
@@ -228,18 +229,22 @@ properties:
228229 capabilities :
229230 - Input
230231 - name : InputBinding.ResponseCurve
231- summary : Numerical value to configure scaling for more precise thumbstick aiming.
232- description : |-
233- A numerical value to control the sensitivity of gamepad thumbstick input by applying
234- a quadratic response curve. Commonly used for camera control to make small thumbstick inputs more
235- precise, while ramping up quickly to allow for large movements with higher magnitude input.
232+ summary : |
233+ Numerical value to configure scaling for more precise thumbstick aiming.
234+ description : |
235+ A numerical value to control the sensitivity of gamepad thumbstick input
236+ by applying a quadratic response curve. Commonly used for camera control
237+ to make small thumbstick inputs more precise, while ramping up quickly to
238+ allow for large movements with higher magnitude input.
236239
237- Ranges between `1` to `10`, with higher values providing a more intense curve.
238- Default is `1`, at which input is returned exactly as received.
240+ Ranges between `1` to `10`, with higher values providing a more intense
241+ curve. Default is `1`, at which input is returned exactly as received.
239242
240243 Only applicable when the parent action's `Class.InputAction.Type|Type` is
241- `Enum.InputActionType|Direction2D` and the `Class.InputBinding.KeyCode|KeyCode`
242- is `Enum.KeyCode.Thumbstick1|Thumbstick1` or `Enum.KeyCode.Thumbstick2|Thumbstick2`.
244+ `Enum.InputActionType|Direction2D` and the
245+ `Class.InputBinding.KeyCode|KeyCode` is
246+ `Enum.KeyCode.Thumbstick1|Thumbstick1` or
247+ `Enum.KeyCode.Thumbstick2|Thumbstick2`.
243248 code_samples : []
244249 type : float
245250 tags : []
@@ -255,10 +260,10 @@ properties:
255260 capabilities :
256261 - Input
257262 - name : InputBinding.Right
258- summary : |-
263+ summary : |
259264 Specifies an alternate `Enum.KeyCode` for dispatching directionally
260265 "right" inputs to the parent `Class.InputAction`.
261- description : |-
266+ description : |
262267 Specifies an alternate `Enum.KeyCode` for dispatching directionally
263268 "right" inputs to `Class.InputAction:GetState()|GetState()` and the
264269 `Class.InputAction.StateChanged|StateChanged` event of the parent
@@ -291,10 +296,10 @@ properties:
291296 capabilities :
292297 - Input
293298 - name : InputBinding.Scale
294- summary : |-
299+ summary : |
295300 Amount by which to linearly scale the values of a directional
296301 `Class.InputAction`.
297- description : |-
302+ description : |
298303 Amount by which to linearly scale the values of an `Class.InputAction`
299304 with `Class.InputAction.Type|Type` of `Enum.InputActionType|Direction1D`,
300305 `Enum.InputActionType|Direction2D`, or `Enum.InputActionType|Direction3D`.
@@ -313,8 +318,10 @@ properties:
313318 capabilities :
314319 - Input
315320 - name : InputBinding.UIButton
316- summary : Connects a `Class.GuiButton` to a boolean action.
317- description : ' `Class.GuiButton` to connect to a boolean action.'
321+ summary : |
322+ Connects a `Class.GuiButton` to a boolean action.
323+ description : |
324+ `Class.GuiButton` to connect to a boolean action.
318325 code_samples : []
319326 type : GuiButton
320327 tags : []
@@ -330,10 +337,10 @@ properties:
330337 capabilities :
331338 - Input
332339 - name : InputBinding.Up
333- summary : |-
340+ summary : |
334341 Specifies an alternate `Enum.KeyCode` for dispatching directionally "up"
335342 inputs to the parent `Class.InputAction`.
336- description : |-
343+ description : |
337344 Specifies an alternate `Enum.KeyCode` for dispatching directionally "up"
338345 inputs to `Class.InputAction:GetState()|GetState()` and the
339346 `Class.InputAction.StateChanged|StateChanged` event of the parent
@@ -370,10 +377,10 @@ properties:
370377 capabilities :
371378 - Input
372379 - name : InputBinding.Vector2Scale
373- summary : |-
380+ summary : |
374381 Amount by which to linearly scale the values of a two-directional
375382 `Class.InputAction`.
376- description : |-
383+ description : |
377384 Amount by which to linearly scale the values of an `Class.InputAction`
378385 with `Class.InputAction.Type|Type` of `Enum.InputActionType|Direction2D`.
379386 code_samples : []
0 commit comments