@@ -81,9 +81,13 @@ public static void AddActionMap(this InputActionAsset asset, InputActionMap map)
81
81
/// <summary>
82
82
/// Remove the given action map from the asset.
83
83
/// </summary>
84
- /// <param name="asset">Asset to add the action map to .</param>
84
+ /// <param name="asset">The asset to remove the action from .</param>
85
85
/// <param name="map">An action map. If the given map is not part of the asset, the method
86
86
/// does nothing.</param>
87
+ /// <remarks>Any action contained in the removed map will remain unchanged and still be
88
+ /// associated with its parent input action map. If this operation is successful, map will no
89
+ /// longer be associated with <paramref name="asset"/> and <see cref="InputActionMap.asset"/> will
90
+ /// return <c>null</c>.</remarks>
87
91
/// <exception cref="ArgumentNullException"><paramref name="asset"/> or <paramref name="map"/> is <c>null</c>.</exception>
88
92
/// <exception cref="InvalidOperationException"><paramref name="map"/> is currently enabled (see <see
89
93
/// cref="InputActionMap.enabled"/>) or is part of an <see cref="InputActionAsset"/> that has <see cref="InputActionMap"/>s
@@ -116,6 +120,10 @@ public static void RemoveActionMap(this InputActionAsset asset, InputActionMap m
116
120
/// <param name="nameOrId">The name or ID (see <see cref="InputActionMap.id"/>) of a map in the
117
121
/// asset. Note that lookup is case-insensitive. If no map with the given name or ID is found,
118
122
/// the method does nothing.</param>
123
+ /// <remarks>Any action contained in the removed map will remain unchanged and still be
124
+ /// associated with its parent input action map. If this operation is successful, map will no
125
+ /// longer be associated with <paramref name="asset"/> and <see cref="InputActionMap.asset"/> will
126
+ /// return <c>null</c>.</remarks>
119
127
/// <exception cref="ArgumentNullException"><paramref name="asset"/> or <paramref name="nameOrId"/> is <c>null</c>.</exception>
120
128
/// <exception cref="InvalidOperationException">The map referenced by <paramref name="nameOrId"/> is currently enabled
121
129
/// (see <see cref="InputActionMap.enabled"/>).</exception>
0 commit comments