11//------------------------------------------------------------------------------
22// <auto-generated>
33// This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
4- // version 1.7 .0
5- // from Assets/SampleViewer/Samples/Geometry /InputActions.inputactions
4+ // version 1.14 .0
5+ // from Assets/SampleViewer/Resources/InputActions /InputActions.inputactions
66//
77// Changes to this file may cause incorrect behavior and will be lost if
88// the code is regenerated.
1515using UnityEngine . InputSystem ;
1616using UnityEngine . InputSystem . Utilities ;
1717
18+ /// <summary>
19+ /// Provides programmatic access to <see cref="InputActionAsset" />, <see cref="InputActionMap" />, <see cref="InputAction" /> and <see cref="InputControlScheme" /> instances defined in asset "Assets/SampleViewer/Resources/InputActions/InputActions.inputactions".
20+ /// </summary>
21+ /// <remarks>
22+ /// This class is source generated and any manual edits will be discarded if the associated asset is reimported or modified.
23+ /// </remarks>
24+ /// <example>
25+ /// <code>
26+ /// using namespace UnityEngine;
27+ /// using UnityEngine.InputSystem;
28+ ///
29+ /// // Example of using an InputActionMap named "Player" from a UnityEngine.MonoBehaviour implementing callback interface.
30+ /// public class Example : MonoBehaviour, MyActions.IPlayerActions
31+ /// {
32+ /// private MyActions_Actions m_Actions; // Source code representation of asset.
33+ /// private MyActions_Actions.PlayerActions m_Player; // Source code representation of action map.
34+ ///
35+ /// void Awake()
36+ /// {
37+ /// m_Actions = new MyActions_Actions(); // Create asset object.
38+ /// m_Player = m_Actions.Player; // Extract action map object.
39+ /// m_Player.AddCallbacks(this); // Register callback interface IPlayerActions.
40+ /// }
41+ ///
42+ /// void OnDestroy()
43+ /// {
44+ /// m_Actions.Dispose(); // Destroy asset object.
45+ /// }
46+ ///
47+ /// void OnEnable()
48+ /// {
49+ /// m_Player.Enable(); // Enable all actions within map.
50+ /// }
51+ ///
52+ /// void OnDisable()
53+ /// {
54+ /// m_Player.Disable(); // Disable all actions within map.
55+ /// }
56+ ///
57+ /// #region Interface implementation of MyActions.IPlayerActions
58+ ///
59+ /// // Invoked when "Move" action is either started, performed or canceled.
60+ /// public void OnMove(InputAction.CallbackContext context)
61+ /// {
62+ /// Debug.Log($"OnMove: {context.ReadValue<Vector2>()}");
63+ /// }
64+ ///
65+ /// // Invoked when "Attack" action is either started, performed or canceled.
66+ /// public void OnAttack(InputAction.CallbackContext context)
67+ /// {
68+ /// Debug.Log($"OnAttack: {context.ReadValue<float>()}");
69+ /// }
70+ ///
71+ /// #endregion
72+ /// }
73+ /// </code>
74+ /// </example>
1875public partial class @InputActions : IInputActionCollection2 , IDisposable
1976{
77+ /// <summary>
78+ /// Provides access to the underlying asset instance.
79+ /// </summary>
2080 public InputActionAsset asset { get ; }
81+
82+ /// <summary>
83+ /// Constructs a new instance.
84+ /// </summary>
2185 public @InputActions ( )
2286 {
2387 asset = InputActionAsset . FromJson ( @"{
@@ -80,57 +144,76 @@ public @InputActions()
80144 m_DrawingControls_LeftShift = m_DrawingControls . FindAction ( "LeftShift" , throwIfNotFound : true ) ;
81145 }
82146
147+ ~ @InputActions ( )
148+ {
149+ UnityEngine . Debug . Assert ( ! m_DrawingControls . enabled , "This will cause a leak and performance issues, InputActions.DrawingControls.Disable() has not been called." ) ;
150+ }
151+
152+ /// <summary>
153+ /// Destroys this asset and all associated <see cref="InputAction"/> instances.
154+ /// </summary>
83155 public void Dispose ( )
84156 {
85157 UnityEngine . Object . Destroy ( asset ) ;
86158 }
87159
160+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.bindingMask" />
88161 public InputBinding ? bindingMask
89162 {
90163 get => asset . bindingMask ;
91164 set => asset . bindingMask = value ;
92165 }
93166
167+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.devices" />
94168 public ReadOnlyArray < InputDevice > ? devices
95169 {
96170 get => asset . devices ;
97171 set => asset . devices = value ;
98172 }
99173
174+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.controlSchemes" />
100175 public ReadOnlyArray < InputControlScheme > controlSchemes => asset . controlSchemes ;
101176
177+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.Contains(InputAction)" />
102178 public bool Contains ( InputAction action )
103179 {
104180 return asset . Contains ( action ) ;
105181 }
106182
183+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.GetEnumerator()" />
107184 public IEnumerator < InputAction > GetEnumerator ( )
108185 {
109186 return asset . GetEnumerator ( ) ;
110187 }
111188
189+ /// <inheritdoc cref="IEnumerable.GetEnumerator()" />
112190 IEnumerator IEnumerable . GetEnumerator ( )
113191 {
114192 return GetEnumerator ( ) ;
115193 }
116194
195+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.Enable()" />
117196 public void Enable ( )
118197 {
119198 asset . Enable ( ) ;
120199 }
121200
201+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.Disable()" />
122202 public void Disable ( )
123203 {
124204 asset . Disable ( ) ;
125205 }
126206
207+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.bindings" />
127208 public IEnumerable < InputBinding > bindings => asset . bindings ;
128209
210+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.FindAction(string, bool)" />
129211 public InputAction FindAction ( string actionNameOrId , bool throwIfNotFound = false )
130212 {
131213 return asset . FindAction ( actionNameOrId , throwIfNotFound ) ;
132214 }
133215
216+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionAsset.FindBinding(InputBinding, out InputAction)" />
134217 public int FindBinding ( InputBinding bindingMask , out InputAction action )
135218 {
136219 return asset . FindBinding ( bindingMask , out action ) ;
@@ -141,17 +224,47 @@ public int FindBinding(InputBinding bindingMask, out InputAction action)
141224 private List < IDrawingControlsActions > m_DrawingControlsActionsCallbackInterfaces = new List < IDrawingControlsActions > ( ) ;
142225 private readonly InputAction m_DrawingControls_LeftClick ;
143226 private readonly InputAction m_DrawingControls_LeftShift ;
227+ /// <summary>
228+ /// Provides access to input actions defined in input action map "DrawingControls".
229+ /// </summary>
144230 public struct DrawingControlsActions
145231 {
146232 private @InputActions m_Wrapper ;
233+
234+ /// <summary>
235+ /// Construct a new instance of the input action map wrapper class.
236+ /// </summary>
147237 public DrawingControlsActions ( @InputActions wrapper ) { m_Wrapper = wrapper ; }
238+ /// <summary>
239+ /// Provides access to the underlying input action "DrawingControls/LeftClick".
240+ /// </summary>
148241 public InputAction @LeftClick => m_Wrapper . m_DrawingControls_LeftClick ;
242+ /// <summary>
243+ /// Provides access to the underlying input action "DrawingControls/LeftShift".
244+ /// </summary>
149245 public InputAction @LeftShift => m_Wrapper . m_DrawingControls_LeftShift ;
246+ /// <summary>
247+ /// Provides access to the underlying input action map instance.
248+ /// </summary>
150249 public InputActionMap Get ( ) { return m_Wrapper . m_DrawingControls ; }
250+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionMap.Enable()" />
151251 public void Enable ( ) { Get ( ) . Enable ( ) ; }
252+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionMap.Disable()" />
152253 public void Disable ( ) { Get ( ) . Disable ( ) ; }
254+ /// <inheritdoc cref="UnityEngine.InputSystem.InputActionMap.enabled" />
153255 public bool enabled => Get ( ) . enabled ;
256+ /// <summary>
257+ /// Implicitly converts an <see ref="DrawingControlsActions" /> to an <see ref="InputActionMap" /> instance.
258+ /// </summary>
154259 public static implicit operator InputActionMap ( DrawingControlsActions set ) { return set . Get ( ) ; }
260+ /// <summary>
261+ /// Adds <see cref="InputAction.started"/>, <see cref="InputAction.performed"/> and <see cref="InputAction.canceled"/> callbacks provided via <param cref="instance" /> on all input actions contained in this map.
262+ /// </summary>
263+ /// <param name="instance">Callback instance.</param>
264+ /// <remarks>
265+ /// If <paramref name="instance" /> is <c>null</c> or <paramref name="instance"/> have already been added this method does nothing.
266+ /// </remarks>
267+ /// <seealso cref="DrawingControlsActions" />
155268 public void AddCallbacks ( IDrawingControlsActions instance )
156269 {
157270 if ( instance == null || m_Wrapper . m_DrawingControlsActionsCallbackInterfaces . Contains ( instance ) ) return ;
@@ -164,6 +277,13 @@ public void AddCallbacks(IDrawingControlsActions instance)
164277 @LeftShift . canceled += instance . OnLeftShift ;
165278 }
166279
280+ /// <summary>
281+ /// Removes <see cref="InputAction.started"/>, <see cref="InputAction.performed"/> and <see cref="InputAction.canceled"/> callbacks provided via <param cref="instance" /> on all input actions contained in this map.
282+ /// </summary>
283+ /// <remarks>
284+ /// Calling this method when <paramref name="instance" /> have not previously been registered has no side-effects.
285+ /// </remarks>
286+ /// <seealso cref="DrawingControlsActions" />
167287 private void UnregisterCallbacks ( IDrawingControlsActions instance )
168288 {
169289 @LeftClick . started -= instance . OnLeftClick ;
@@ -174,12 +294,25 @@ private void UnregisterCallbacks(IDrawingControlsActions instance)
174294 @LeftShift . canceled -= instance . OnLeftShift ;
175295 }
176296
297+ /// <summary>
298+ /// Unregisters <param cref="instance" /> and unregisters all input action callbacks via <see cref="DrawingControlsActions.UnregisterCallbacks(IDrawingControlsActions)" />.
299+ /// </summary>
300+ /// <seealso cref="DrawingControlsActions.UnregisterCallbacks(IDrawingControlsActions)" />
177301 public void RemoveCallbacks ( IDrawingControlsActions instance )
178302 {
179303 if ( m_Wrapper . m_DrawingControlsActionsCallbackInterfaces . Remove ( instance ) )
180304 UnregisterCallbacks ( instance ) ;
181305 }
182306
307+ /// <summary>
308+ /// Replaces all existing callback instances and previously registered input action callbacks associated with them with callbacks provided via <param cref="instance" />.
309+ /// </summary>
310+ /// <remarks>
311+ /// If <paramref name="instance" /> is <c>null</c>, calling this method will only unregister all existing callbacks but not register any new callbacks.
312+ /// </remarks>
313+ /// <seealso cref="DrawingControlsActions.AddCallbacks(IDrawingControlsActions)" />
314+ /// <seealso cref="DrawingControlsActions.RemoveCallbacks(IDrawingControlsActions)" />
315+ /// <seealso cref="DrawingControlsActions.UnregisterCallbacks(IDrawingControlsActions)" />
183316 public void SetCallbacks ( IDrawingControlsActions instance )
184317 {
185318 foreach ( var item in m_Wrapper . m_DrawingControlsActionsCallbackInterfaces )
@@ -188,10 +321,30 @@ public void SetCallbacks(IDrawingControlsActions instance)
188321 AddCallbacks ( instance ) ;
189322 }
190323 }
324+ /// <summary>
325+ /// Provides a new <see cref="DrawingControlsActions" /> instance referencing this action map.
326+ /// </summary>
191327 public DrawingControlsActions @DrawingControls => new DrawingControlsActions ( this ) ;
328+ /// <summary>
329+ /// Interface to implement callback methods for all input action callbacks associated with input actions defined by "DrawingControls" which allows adding and removing callbacks.
330+ /// </summary>
331+ /// <seealso cref="DrawingControlsActions.AddCallbacks(IDrawingControlsActions)" />
332+ /// <seealso cref="DrawingControlsActions.RemoveCallbacks(IDrawingControlsActions)" />
192333 public interface IDrawingControlsActions
193334 {
335+ /// <summary>
336+ /// Method invoked when associated input action "LeftClick" is either <see cref="UnityEngine.InputSystem.InputAction.started" />, <see cref="UnityEngine.InputSystem.InputAction.performed" /> or <see cref="UnityEngine.InputSystem.InputAction.canceled" />.
337+ /// </summary>
338+ /// <seealso cref="UnityEngine.InputSystem.InputAction.started" />
339+ /// <seealso cref="UnityEngine.InputSystem.InputAction.performed" />
340+ /// <seealso cref="UnityEngine.InputSystem.InputAction.canceled" />
194341 void OnLeftClick ( InputAction . CallbackContext context ) ;
342+ /// <summary>
343+ /// Method invoked when associated input action "LeftShift" is either <see cref="UnityEngine.InputSystem.InputAction.started" />, <see cref="UnityEngine.InputSystem.InputAction.performed" /> or <see cref="UnityEngine.InputSystem.InputAction.canceled" />.
344+ /// </summary>
345+ /// <seealso cref="UnityEngine.InputSystem.InputAction.started" />
346+ /// <seealso cref="UnityEngine.InputSystem.InputAction.performed" />
347+ /// <seealso cref="UnityEngine.InputSystem.InputAction.canceled" />
195348 void OnLeftShift ( InputAction . CallbackContext context ) ;
196349 }
197350}
0 commit comments