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
An Input Action Asset is an Asset containing [Input Actions](Actions.md)as well as their associated [Bindings](ActionBindings.md) and [Control Schemes](ActionBindings.md#control-schemes). These Assets are distinguished by the `.inputactions` file extension and are stored in a plain JSON format.
7
+
An Input Action Asset is an Asset which contains [Input Actions](Actions.md)and their associated [Bindings](ActionBindings.md) and [Control Schemes](ActionBindings.md#control-schemes). These Assets have the `.inputactions` file extension and are stored in a plain JSON format.
8
8
9
9
## Creating Input Action Assets
10
10
11
-
To create an Asset containing[Input Actions](Actions.md) in Unity, right-click in the __Project__ window or go to __Assets > Create > Input Actions__ from Unity's main menu.
11
+
To create an Asset that contains[Input Actions](Actions.md) in Unity, right-click in the __Project__ window or go to __Assets > Create > Input Actions__ from Unity's main menu.
12
12
13
13
## Editing Input Action Assets
14
14
15
-
To bring up the Action editor, double-click an `.inputactions` Asset in the Project Browser, or click the __Edit Asset__ button in the inspector for that Asset. You can have more than one editor window open at the same time, but not for the same Asset.
15
+
To bring up the Action editor, double-click an `.inputactions` Asset in the Project Browser, or select the __Edit Asset__ button in the Inspector for that Asset. You can have more than one editor window open at the same time, but not for the same Asset.
16
16
17
17
18
18
19
-
The Action editor comes up as a separate window which you can also dock into Unity's main UI.
19
+
The Action editor appears as a separate window, which you can also dock into Unity's main UI.
20
20
21
-
>__Note__: For details about how Action Maps, Actions, and Bindings work, see the documentation on [Actions](Actions.md).
21
+
>__Note__: For details about how Action Maps, Actions, and Bindings work, see documentation on [Actions](Actions.md).
22
22
23
-
By default, Unity doesn't save edits you make in the Action Asset window when you save the Project. To save your changes, click__Save Asset__ in the window's toolbar. To discard your changes, close the window and choose __Don't Save__ when prompted. Alternatively, you can toggle auto-saving on by enabling the __Auto-Save__ checkbox in the toolbar. This saves any changes to that Asset.
23
+
By default, Unity doesn't save edits you make in the Action Asset window when you save the Project. To save your changes, select__Save Asset__ in the window's toolbar. To discard your changes, close the window and choose __Don't Save__ when prompted. Alternatively, you can toggle auto-saving on by enabling the __Auto-Save__ checkbox in the toolbar. This saves any changes to that Asset.
24
24
25
25
>__Note__: This setting affects all `.inputactions` Assets, and persists across Unity Editor sessions.
26
26
27
-
The editor window is divided into three panes:
27
+
The Action editor window is divided into three panes:
28
28
29
-
1. The left pane lists the Action Maps in the Asset. Each Map is a collection of Actions that you can enable or disable in bulk.
29
+
1. The left pane lists the Action Maps in the Asset. Each Action Map is a collection of Actions that you can enable or disable in bulk.
30
30
2. The middle pane contains the Actions in the currently selected Action Map, and the bindings associated with each Action.
31
31
3. The right pane contains the properties of the currently selected Action or Binding.
32
32
@@ -49,18 +49,16 @@ Use the following keyboard shortcuts to quickly trigger common operations:
* To add a new Action Map, click the plus icon in the header of the Action Map column.
55
-
* To rename an existing Action Map, either long-click the name, or right-click the Action Map and select __Rename__ from the context menu.
52
+
* To add a new Action Map, select the Add (+) icon in the header of the Action Map column.
53
+
* To rename an existing Action Map, either long-click the name, or right-click the Action Map and select __Rename__ from the context menu. Note that Action Map names can't contain slashes (`/`).
56
54
* To delete an existing Action Map, either right-click it and select __Delete__ from the context menu, or use the Delete key (Windows) / ⌘⌫ (Mac).
57
55
* To duplicate an existing Action Map, either right-click it and select __Duplicate__ from the context menu, or use Ctrl-D (Windows) / ⌘D (Mac).
58
56
59
57
### Editing Actions
60
58
61
59
62
60
63
-
* To add a new Action, click the plus icon in the header of the Action column.
61
+
* To add a new Action, select the Add (+) icon in the header of the Action column.
64
62
* To rename an existing Action, either long-click the name, or right-click the Action Map and select __Rename__ from the context menu.
65
63
* To delete an existing Action, either right-click it and select __Delete__ from the context menu, or use the Delete key (Windows) / ⌘⌫ (Mac).
66
64
* To duplicate an existing Action, either right-click it and select __Duplicate__ from the context menu, or use Ctrl-D (Windows) / ⌘D (Mac).
@@ -71,7 +69,7 @@ If you select an Action, you can edit it's properties in the right-hand pane of
71
69
72
70
### Editing Bindings
73
71
74
-
* To add a new Binding, click the plus icon on the action you want to add it to, and select the binding type from the menu that appears.
72
+
* To add a new Binding, select the Add (+) icon on the action you want to add it to, and select the binding type from the menu that appears.
75
73
* To delete an existing Binding, either right-click it and select __Delete__ from the context menu, or use the Delete key (Windows) / ⌘⌫ (Mac).
76
74
* To duplicate an existing Binding, either right-click it and select __Duplicate__ from the context menu, or use Ctrl-D (Windows) / ⌘D (Mac).
77
75
@@ -81,39 +79,39 @@ If you select a Binding, you can edit its properties in the right-hand pane of t
81
79
82
80
#### Picking Controls
83
81
84
-
The most important property of any Binding is the [control path](Controls.md#control-paths) it's bound to. To edit it, open the __Path__ drop-down list. This pops up a Control picker window.
82
+
The most important property of any Binding is the [control path](Controls.md#control-paths) it's bound to. To edit it, open the __Path__ drop-down list. This displays a Control picker window.
85
83
86
84
87
85
88
86
In the Control picker window, you can explore a tree of Input Devices and Controls that the Input System recognizes, and bind to these Controls. Unity filters this list by the Action's [`Control Type`](../api/UnityEngine.InputSystem.InputAction.html#UnityEngine_InputSystem_InputAction_expectedControlType) property. For example, if the Control type is `Vector2`, you can only select a Control that generates two-dimensional values, like a stick.
89
87
90
-
The Device and Control tree is organized hierarchically from generic to specific. For example, navigate to __Gamepad__, and choose the Control path `<Gamepad>/buttonSouth`, this matches the lower action button on any gamepad. On the other hand, if you navigate to __Gamepad__, then scroll down to __More Specific Gamepads__ and select __PS4 Controller__, and then choose the Control path `<DualShockGamepad>/buttonSouth`, this only matches the "cross" button on PlayStation gamepads, and doesn't match any other gamepads.
88
+
The Device and Control tree is organized hierarchically from generic to specific. For example, the __Gamepad__Control path `<Gamepad>/buttonSouth`matches the lower action button on any gamepad. Alternatively, if you navigate to __Gamepad__ > __More Specific Gamepads__ and select __PS4 Controller__, and then choose the Control path `<DualShockGamepad>/buttonSouth`, this only matches the "Cross" button on PlayStation gamepads, and doesn't match any other gamepads.
91
89
92
-
Instead of browsing the tree to find the Control you want, it's easier to let the Input System listen for input. To do that, click the __Listen__ button. At first, the list of Controls is empty. Once you start clicking buttons or actuating Controls on the Devices you want to bind to, the Control picker window starts listing any Bindings that match the controls you pressed. Click any of these Bindings to select it.
90
+
Instead of browsing the tree to find the Control you want, it's easier to let the Input System listen for input. To do that, select the __Listen__ button. At first, the list of Controls is empty. Once you start pressing buttons or actuating Controls on the Devices you want to bind to, the Control picker window starts listing any Bindings that match the controls you pressed. Select any of these Bindings to view them.
93
91
94
-
Finally, you can choose to manually edit the Binding path, instead of using the Control picker. To do that, click the __T__ button next to the Control path popup. This changes the popup to a text field, where you can enter any Binding string. This also allows you to use wildcard (`*`) characters in your Bindings. For example, you can use a Binding path such as `<Touchscreen>/touch*/press` to bind to any finger being pressed on the touchscreen, instead of manually binding to `<Touchscreen>/touch0/press`, `<Touchscreen>/touch1/press` and so on.
92
+
Finally, you can choose to manually edit the Binding path, instead of using the Control picker. To do that, select the __T__ button next to the Control path popup. This changes the popup to a text field, where you can enter any Binding string. This also allows you to use wildcard (`*`) characters in your Bindings. For example, you can use a Binding path such as `<Touchscreen>/touch*/press` to bind to any finger being pressed on the touchscreen, instead of manually binding to `<Touchscreen>/touch0/press`, `<Touchscreen>/touch1/press` and so on.
95
93
96
94
#### Editing Composite Bindings
97
95
98
96
Composite Bindings are Bindings consisting of multiple parts, which form a Control together. For instance, a [2D Vector Composite](ActionBindings.md#2d-vector) uses four buttons (left, right, up, down) to simulate a 2D stick input. See the [Composite Bindings](ActionBindings.md#composite-bindings) documentation to learn more.
99
97
100
-
To create a Composite Binding, in the Input Action Asset editor window, click the plus icon on the Action you want to add it to, and select the Composite Binding type from the popup menu. This creates multiple Binding entries for the Action: one for the Composite as a whole, and then, one level below that, one for each Composite part. The Composite itself doesn't have a Binding path property, but its individual parts do, and you can edit these parts like any other Binding. Once you bind all the Composite's parts, the Composite can work together as if you bound a single control to the Action.
98
+
To create a Composite Binding, in the Input Action Asset editor window, select the Add (+) icon on the Action you want to add it to, and select the Composite Binding type from the popup menu. This creates multiple Binding entries for the Action: one for the Composite as a whole, and then, one level below that, one for each Composite part. The Composite itself doesn't have a Binding path property, but its individual parts do, and you can edit these parts like any other Binding. Once you bind all the Composite's parts, the Composite can work together as if you bound a single control to the Action.
101
99
102
100
### Editing Control Schemes
103
101
104
102
Input Action Assets can have multiple [Control Schemes](ActionBindings.md#control-schemes), which let you enable or disable different sets of Bindings for your Actions for different types of Devices.
To see the Control Schemes in the Input Action Asset editor window, open the Control Scheme drop-down list in the top left of the window. This menu lets you add or remove Control Schemes to your Asset. If the Asset contains any Control Schemes, you can select a Control Scheme, and then the window only shows bindings that belong to that Scheme. If you select a binding, you can now pick the Control Schemes for which this binding should be active in the __Properties__ view to the left of the window. When you add a new Control Scheme, or select an existing Control Scheme, and then click__Edit Control Scheme…__, you can edit the name of the Control Scheme and which devices the Scheme should be active for.
106
+
To see the Control Schemes in the Input Action Asset editor window, open the Control Scheme drop-down list in the top left of the window. This menu lets you add or remove Control Schemes to your Asset. If the Asset contains any Control Schemes, you can select a Control Scheme, and then the window only shows bindings that belong to that Scheme. If you select a binding, you can now pick the Control Schemes for which this binding should be active in the __Properties__ view to the left of the window. When you add a new Control Scheme, or select an existing Control Scheme, and then select__Edit Control Scheme…__, you can edit the name of the Control Scheme and which devices the Scheme should be active for.
109
107
110
108
## Using Input Action Assets
111
109
112
110
### Auto-generating script code for Actions
113
111
114
112
One of the most convenient ways to work with `.inputactions` Assets in scripts is to automatically generate a C# wrapper class for them. This removes the need to manually look up Actions and Action Maps using their names, and also provides an easier way to set up callbacks.
115
113
116
-
To enable this option, tick the __Generate C# Class__ checkbox in the importer properties in the Inspector of the `.inputactions` Asset, then click__Apply__.
114
+
To enable this option, tick the __Generate C# Class__ checkbox in the importer properties in the Inspector of the `.inputactions` Asset, then select__Apply__.
0 commit comments