A game about forced loneliness, made by TACStudios
1namespace UnityEngine.InputSystem
2{
3 /// <summary>
4 /// Determines how the triggering of an action or other input-related events are relayed to other GameObjects.
5 /// </summary>
6 [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1717:Only FlagsAttribute enums should have plural names")]
7 public enum PlayerNotifications
8 {
9 ////TODO: add a "None" behavior; for actions, users may want to poll (or use the generated interfaces)
10
11 /// <summary>
12 /// Use <see cref="GameObject.SendMessage(string,object)"/> to send a message to the <see cref="GameObject"/>
13 /// that <see cref="PlayerInput"/> belongs to.
14 ///
15 /// The message name will be the name of the action (e.g. "Jump"; it will not include the action map name),
16 /// and the object will be the <see cref="PlayerInput"/> on which the action was triggered.
17 ///
18 /// If the notification is for an action that was triggered, <see cref="SendMessageOptions"/> will be
19 /// <see cref="SendMessageOptions.RequireReceiver"/> (i.e. an error will be logged if there is no corresponding
20 /// method). Otherwise it will be <see cref="SendMessageOptions.DontRequireReceiver"/>.
21 /// </summary>
22 SendMessages,
23
24 /// <summary>
25 /// Like <see cref="SendMessages"/> but instead of using <see cref="GameObject.SendMessage(string,object)"/>,
26 /// use <see cref="GameObject.BroadcastMessage(string,object)"/>.
27 /// </summary>
28 BroadcastMessages,
29
30 /// <summary>
31 /// Have a separate <a href="https://docs.unity3d.com/ScriptReference/Events.UnityEvent.html">UnityEvent</a> for each notification.
32 /// Allows wiring up target methods to invoke such that the connection is persisted in Unity serialized data.
33 ///
34 /// See <see cref="PlayerInput.actionEvents"/> and related callbacks such as <see cref="PlayerInput.controlsChangedEvent"/>.
35 /// </summary>
36 InvokeUnityEvents,
37
38 ////TODO: Kill
39 /// <summary>
40 /// Use plain C# callbacks.
41 /// </summary>
42 InvokeCSharpEvents
43 }
44}