You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Packages/com.unity.inputsystem/Documentation~/Workflows.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,9 @@ The descriptions below describe these main workflows and link to more detailed d
16
16
17
17
|Workflows | Description |
18
18
|---|---|
19
-
|[**Using Actions**](Workflow-Actions.md)|This is the **recommended** workflow for most situations. In this workflow, you use the [Actions Editor window](./ActionsEditor.md) to configure sets of actions and bindings, then set up references and read the values for those actions in your code.|
20
-
|[**Using Actions and the PlayerInput Component**](Workflow-PlayerInput.md)|This workflow provides extra features that allow you to connect up **callbacks** directly from Actions to your own callback handler methods, removing the need to deal with Action references in your code. It also provides features that are useful in **local multiplayer** scenarios such as device assignment and split-screen functionality.|
21
-
|[**Directly read device states**](Workflow-Direct.md)|This workflow is a simplified, script-only approach which bypasses the actions and bindings features entirely. Instead your script explicitly references specific device controls (such as "left gamepad stick") and reads the values directly. This is suitable for **fast prototyping**, or single fixed platform scenarios. It is a **less flexible** workflow because it bypasses some of the main input system features.|
19
+
|[**Using Actions**](using-actions-workflow.md)|This is the **recommended** workflow for most situations. In this workflow, you use the [Actions Editor window](actions-editor.md) to configure sets of actions and bindings, then set up references and read the values for those actions in your code.|
20
+
|[**Using Actions and the PlayerInput Component**](using-playerinput-workflow.md)|This workflow provides extra features that allow you to connect up **callbacks** directly from Actions to your own callback handler methods, removing the need to deal with Action references in your code. It also provides features that are useful in **local multiplayer** scenarios such as device assignment and split-screen functionality.|
21
+
|[**Directly read device states**](using-direct-workflow.md)|This workflow is a simplified, script-only approach which bypasses the actions and bindings features entirely. Instead your script explicitly references specific device controls (such as "left gamepad stick") and reads the values directly. This is suitable for **fast prototyping**, or single fixed platform scenarios. It is a **less flexible** workflow because it bypasses some of the main input system features.|
22
22
23
23
> [!NOTE]
24
24
> Because the Input System has multiple workflows, the code samples used throughout this documentation also vary, often demonstrating techniques using various workflows. For example, some code samples may use Action references, and some may use the workflow of reading input directly from devices.
Copy file name to clipboardExpand all lines: Packages/com.unity.inputsystem/Documentation~/action-properties-panel-reference.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,6 @@ The Action Properties panel changes depending on the **Action Type** of the sele
14
14
|**Control Type**| Define the control type for the selected action. Refer to [Action and control types](action-and-control-types.md) for detailed information on control types. <br/><br/>This property is only available when **Action Type** is set to **Value** or **Pass Through**. |
15
15
|**Initial State Check**| Perform an initial state check when the Action is first enabled, to check the current state of any bound Control. <br/><br/>This setting is only available when Action Type is set to **Button** or **Pass Through**. It is always enabled for **Value**-type actions. Refer to [binding initial state checks|(binding-initial-state-checks.md) for detailed information.
Copy file name to clipboardExpand all lines: Packages/com.unity.inputsystem/Documentation~/add-processors-bindings-actions.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ You can add a processor to an action or binding in the Input Actions Editor.
10
10
11
11
When you create bindings for your [actions](Actions.md), you can choose to add Processors to the bindings. These process the values from the controls they bind to, before the system applies them to the Action value. For instance, you might want to invert the `Vector2` values from the controls along the Y-axis before passing these values to the Action that drives the input logic for your application. To do this, you can add an [Invert Vector2](built-in-processors.md) Processor to your binding.
12
12
13
-
If you're using Actions defined in the [Input Actions Editor](ActionsEditor.md), or in an [action asset](ActionAssets.md), you can add any Processor to your bindings in the Input Action editor:
13
+
If you're using Actions defined in the [Input Actions Editor](actions-editor.md), or in an [action asset](action-assets.md), you can add any Processor to your bindings in the Input Action editor:
14
14
15
15
1. Select the binding you want to add Processors to so that the Binding Properties panel shows up on the right side.
16
16
2. Select the **Add (+)** icon on the __Processors__ foldout to open a list of all available Processors that match your control type.
Processors on Actions work in the same way as Processors on bindings, but they affect all controls bound to an Action, rather than just the controls from a specific binding. If there are Processors on both the binding and the Action, the system processes the ones from the binding first.
35
35
36
-
You can add and edit Processors on Actions in the [Input Actions Editor](ActionsEditor.md), or in an [action asset](ActionAssets.md) the [same way](#processors-on-bindings) as you would for bindings: select an Action to edit, then add one or more Processors in the right window pane.
36
+
You can add and edit Processors on Actions in the [Input Actions Editor](actions-editor.md), or in an [action asset](action-assets.md) the [same way](#processors-on-bindings) as you would for bindings: select an Action to edit, then add one or more Processors in the right window pane.
37
37
38
38
If you create your Actions in code, you can add Processors like this:
You can have any number of Processors directly on an [`InputControl`](xref:UnityEngine.InputSystem.InputControl), which then process the values read from the Control. Whenever you call [`ReadValue`](xref:UnityEngine.InputSystem.InputControl-1) on a Control, all Processors on that Control process the value before it gets returned to you. You can use [`ReadUnprocessedValue`](xref:UnityEngine.InputSystem.InputControl-1) on a Control to bypass the Processors.
7
+
You can have any number of Processors directly on an [`InputControl`](xref:UnityEngine.InputSystem.InputControl), which then process the values read from the Control. Whenever you call [`ReadValue`](xref:UnityEngine.InputSystem.InputControl`1) on a Control, all Processors on that Control process the value before it gets returned to you. You can use [`ReadUnprocessedValue`](xref:UnityEngine.InputSystem.InputControl`1) on a Control to bypass the Processors.
8
8
9
9
The Input System adds Processors to a Control during device creation, if they're specified in the Control's [layout](Layouts.md). You can't add Processors to existing Controls after they've been created, so you can only add Processors to Controls when you're [creating custom devices](custom-devices.md). The devices that the Input System supports out of the box already have some useful Processors added on their Controls. For instance, sticks on gamepads have a [Stick Deadzone](built-in-processors.md) Processor.
Copy file name to clipboardExpand all lines: Packages/com.unity.inputsystem/Documentation~/binding-conflicts.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ For [composite bindings](./composite-bindings.md), magnitudes of the composite a
38
38
> The mechanism described here only applies to Actions that are part of the same [action map](./input-actions-editor-window-reference.md#action-maps-panel-reference) or [action assets](./action-assets.md).
39
39
40
40
> [!NOTE]
41
-
> To use automatic composite complexity as described below, in **Project Settings** > **Input System Package**, enable __Complexity-Based Shortcut Resolution__ ([`InputSettings.shortcutKeysConsumeInput`](xref:UnityEngine.InputSystem.InputSettings.shortcutKeysConsumeInput)) and leave __Action Priority Shortcut Resolution__ ([`InputSettings.shortcutKeysUseActionPriority`](xref:UnityEngine.InputSystem.InputSettings.shortcutKeysUseActionPriority)) disabled. If __Action Priority Shortcut Resolution__ is enabled, overlaps are resolved using each action's [`InputAction.Priority`](xref:UnityEngine.InputSystem.InputAction.Priority) instead. Refer to [Input settings](xref:input-system-settings#improved-shortcut-support) for details.
41
+
> To use automatic composite complexity as described below, in **Project Settings** > **Input System Package**, enable __Complexity-Based Shortcut Resolution__ ([`InputSettings.shortcutKeysConsumeInput`](xref:UnityEngine.InputSystem.InputSettings.shortcutKeysConsumeInput)) and leave __Action Priority Shortcut Resolution__ ([`InputSettings.shortcutKeysUseActionPriority`](xref:UnityEngine.InputSystem.InputSettings.shortcutKeysUseActionPriority)) disabled. If __Action Priority Shortcut Resolution__ is enabled, overlaps are resolved using each action's [`InputAction.Priority`](xref:UnityEngine.InputSystem.InputAction.Priority) instead. Refer to [Input settings](xref:input-system-settings) for details.
42
42
43
43
Inputs used in combinations with other inputs can also lead to ambiguities. If, for example, the **B** key on the Keyboard is bound both on its own as well as in combination with the **Shift** key, then if you first press **Shift** and then **B**, the latter key press would be a valid input for either of the Actions.
Copy file name to clipboardExpand all lines: Packages/com.unity.inputsystem/Documentation~/binding-properties-panel-reference.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ When you create a [composite binding](composite-bindings.md), the Binding Proper
26
26
|-|-|
27
27
|**Composite Type**|Select the [composite type](composite-bindings.md) of the selected binding. The options are: <br/>- **1D Axis**: Create a composite binding made of two buttons: one that pulls a 1D axis in its negative direction, and another that pulls it in its positive direction. <br/>- **2D Vector**: Create a composite binding that represents a 4-way button setup like the D-pad on gamepads. <br/>- **3D Vector**: Create a composite binding that represents a 6-way button where two combinations each control one axis of a 3D vector. <br/>- **One Modifier**: Create a composite binding that requires the user to hold down a "modifier" button in addition to another control from which the actual value of the binding is determined. <br/>- **Two Modifiers**: Create a composite binding that requires the user to hold down a "modifier" button in addition to another control from which the actual value of the binding is determined. |
28
28
29
-
For more information on the composite types that are available by default, refer to scripting documentation on [`InputSystem.Composites`](../api/UnityEngine.InputSystem.Composites). Others might also be available if your project contains custom composite binding types.
29
+
For more information on the composite types that are available by default, refer to scripting documentation on [`InputSystem.Composites`](../api/UnityEngine.InputSystem.Composites.html). Others might also be available if your project contains custom composite binding types.
30
30
31
31
### Axis binding reference
32
32
@@ -36,7 +36,7 @@ When **Composite Type** is set to **1D Axis**, the Binding Properties panel disp
36
36
|-|-|
37
37
|**Which Side Wins**|Define what happens when both buttons are triggered at the same time. <br/>- **Positive**: Prioritize the Positive binding. <br/>- **Negative**: Prioritize the Negative binding. <br/>- **Neither**: Do nothing when both bindings are triggered at the same time. |
38
38
39
-
For more details, refer to scripting reference documentation on [`Composites.AxisComposite`](..api/UnityEngine.InputSystem.Composites.AxisComposite.html).
39
+
For more details, refer to scripting reference documentation on [`Composites.AxisComposite`](../api/UnityEngine.InputSystem.Composites.AxisComposite.html).
40
40
41
41
### Vector binding reference
42
42
@@ -46,7 +46,7 @@ When **Composite Type** is set to **2D Vector** or **3D Vector**, the Binding Pr
46
46
|-|-|
47
47
|**Mode**| Select the process that the Input System uses to calculate a Vector2 or Vector3 from the input values provided. <br/>- **Analog**: Accept and use the floating-point values from controls. <br/>- **Digital**: Treat control values as on/off, and do not normalize the resulting vector. <br/>- **Digital Normalized**: Treat control values as on/off, and normalize the resulting vector. |
48
48
49
-
For more details on each mode, refer to scripting reference documentation on [`Vector2Composite.Mode`](../api/UnityEngine.InputSystem.Composites.Vector2Composite.Mode) and [`Vector3Composite.Mode`](../api/UnityEngine.InputSystem.Composites.Vector3Composite.Mode).
49
+
For more details on each mode, refer to scripting reference documentation on [`Vector2Composite.Mode`](../api/UnityEngine.InputSystem.Composites.Vector2Composite.Mode.html) and [`Vector3Composite.Mode`](../api/UnityEngine.InputSystem.Composites.Vector3Composite.Mode.html).
50
50
51
51
### Binding with modifier reference
52
52
@@ -57,8 +57,8 @@ When **Composite Type** is set to **One Modifier**, **Two Modifiers**, **Button
57
57
|**Override Modifiers Need To Be Pressed First**|**Note**: This property is obsolete. Use the **Modifiers Order** property instead.<br/><br/>Override the Input Consumption setting, so that the composite binding still triggers if the modifiers are pressed after the button. |
58
58
|**Modifiers order**| Define the order in which buttons and modifiers must be pressed in order to trigger the composite binding. <br/>- **Default**: Apply the Input Consumption setting. <br/>- **Ordered**: Only trigger the binding if the modifiers are in a pressed state before the button enters a pressed state. <br/>- **Unordered**: Allow the binding to trigger regardless of the order in which the buttons and modifiers enter a pressed state. |
59
59
60
-
For more details, refer to scripting reference documentation on [`OneModifierComposite`](..api/UnityEngine.InputSystem.Composites.OneModifierComposite.html), [`TwoModifiersComposite`](..api/UnityEngine.InputSystem.Composites.TwoModifiersComposite.html), [`ButtonWithOneModifier`](..api/UnityEngine.InputSystem.Composites.ButtonWithOneModifier.html), and [`ButtonWithTwoModifiers`](..api/UnityEngine.InputSystem.Composites.ButtonWithTwoModifiers.html).
60
+
For more details, refer to scripting reference documentation on [`OneModifierComposite`](../api/UnityEngine.InputSystem.Composites.OneModifierComposite.html), [`TwoModifiersComposite`](../api/UnityEngine.InputSystem.Composites.TwoModifiersComposite.html), [`ButtonWithOneModifier`](../api/UnityEngine.InputSystem.Composites.ButtonWithOneModifier.html), and [`ButtonWithTwoModifiers`](../api/UnityEngine.InputSystem.Composites.ButtonWithTwoModifiers.html).
Copy file name to clipboardExpand all lines: Packages/com.unity.inputsystem/Documentation~/configure-ui-input-action-map.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ You can modify, add, or remove bindings to the named actions in the UI action ma
23
23
* The names of the actions it contains
24
24
* Their respective **Action Types**.
25
25
26
-
To see the specific actions and types that the [UI Input Module](xref:UnityEngine.InputSystem.UI.InputSystemUIInputModule) class expects, refer to the [UI action map reference](ui-action-map-reference).
26
+
To see the specific actions and types that the [UI Input Module](xref:UnityEngine.InputSystem.UI.InputSystemUIInputModule) class expects, refer to the [UI action map reference](ui-action-map-reference.md).
0 commit comments