Verbs (#124)

Right click verbs work.

Content.Shared/Content.Shared.csproj

@@ -70,7 +70,9 @@
     <Compile Include="GameObjects\Components\Power\SharedPowerCellComponent.cs" />
     <Compile Include="GameObjects\Components\Storage\SharedStorageComponent.cs" />
     <Compile Include="GameObjects\ContentNetIDs.cs" />
+    <Compile Include="GameObjects\EntitySystemMessages\VerbSystemMessages.cs" />
     <Compile Include="GameObjects\PhysicalConstants.cs" />
+    <Compile Include="GameObjects\Verb.cs" />
     <Compile Include="Physics\CollisionGroup.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="GameObjects\Components\Items\SharedHandsComponent.cs" />

Content.Shared/GameObjects/Components/Items/SharedHandsComponent.cs

@@ -37,4 +37,16 @@ namespace Content.Shared.GameObjects
             Directed = true;
         }
     }
+
+    [Serializable, NetSerializable]
+    public class ClientAttackByInHandMsg : ComponentMessage
+    {
+        public string Index { get; }
+
+        public ClientAttackByInHandMsg(string index)
+        {
+            Directed = true;
+            Index = index;
+        }
+    }
 }

Content.Shared/GameObjects/EntitySystemMessages/VerbSystemMessages.cs

@@ -0,0 +1,63 @@
+using System;
+using System.Collections.Generic;
+using SS14.Shared.GameObjects;
+using SS14.Shared.Serialization;
+
+namespace Content.Shared.GameObjects.EntitySystemMessages
+{
+    public static class VerbSystemMessages
+    {
+        [Serializable, NetSerializable]
+        public class RequestVerbsMessage : EntitySystemMessage
+        {
+            public readonly EntityUid EntityUid;
+
+            public RequestVerbsMessage(EntityUid entityUid)
+            {
+                EntityUid = entityUid;
+            }
+        }
+
+        [Serializable, NetSerializable]
+        public class VerbsResponseMessage : EntitySystemMessage
+        {
+            public readonly List<VerbData> Verbs;
+            public readonly EntityUid Entity;
+
+            public VerbsResponseMessage(List<VerbData> verbs, EntityUid entity)
+            {
+                Verbs = verbs;
+                Entity = entity;
+            }
+
+            [Serializable, NetSerializable]
+            public readonly struct VerbData
+            {
+                public readonly string Text;
+                public readonly string Key;
+                public readonly bool Available;
+
+                public VerbData(string text, string key, bool available)
+                {
+                    Text = text;
+                    Key = key;
+                    Available = available;
+                }
+            }
+        }
+
+        [Serializable, NetSerializable]
+        public class UseVerbMessage : EntitySystemMessage
+        {
+            public readonly EntityUid EntityUid;
+            public readonly string VerbKey;
+
+            public UseVerbMessage(EntityUid entityUid, string verbKey)
+            {
+                EntityUid = entityUid;
+                VerbKey = verbKey;
+            }
+        }
+
+    }
+}

Content.Shared/GameObjects/Verb.cs

@@ -0,0 +1,132 @@
+using System;
+using System.Collections.Generic;
+using JetBrains.Annotations;
+using SS14.Shared.Interfaces.GameObjects;
+
+namespace Content.Shared.GameObjects
+{
+    /// <summary>
+    ///     A verb is an action in the right click menu of an entity.
+    /// </summary>
+    /// <remarks>
+    ///     To add a verb to an entity, define it as a nested class inside the owning component,
+    ///     and mark it with <see cref="VerbAttribute"/>
+    /// </remarks>
+    [UsedImplicitly]
+    public abstract class Verb
+    {
+        /// <summary>
+        ///     If true, this verb requires the user to be inside within
+        ///     <see cref="InteractionRange"/> meters from the entity on which this verb resides.
+        /// </summary>
+        public virtual bool RequireInteractionRange => true;
+
+        public const float InteractionRange = 2;
+        public const float InteractionRangeSquared = InteractionRange * InteractionRange;
+
+        /// <summary>
+        ///     Gets the text string that will be shown to <paramref name="user"/> in the right click menu.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <param name="component">The component instance for which this verb is being loaded.</param>
+        /// <returns>The text string that is shown in the right click menu for this verb.</returns>
+        public abstract string GetText(IEntity user, IComponent component);
+
+        /// <summary>
+        ///     Gets whether this verb is "disabled" in the right click menu.
+        ///     The verb is still visible in disabled state, but greyed out.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <param name="component">The component instance for which this verb is being loaded.</param>
+        /// <returns>True if the verb is disabled, false otherwise.</returns>
+        public abstract bool IsDisabled(IEntity user, IComponent component);
+
+        /// <summary>
+        ///     Invoked when this verb is activated from the right click menu.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <param name="component">The component instance for which this verb is being loaded.</param>
+        public abstract void Activate(IEntity user, IComponent component);
+    }
+
+    /// <inheritdoc />
+    /// <summary>
+    ///     Sub class of <see cref="T:Content.Shared.GameObjects.Verb" /> that works on a specific type of component,
+    ///     to reduce casting boiler plate for implementations.
+    /// </summary>
+    /// <typeparam name="T">The type of component that this verb will run on.</typeparam>
+    public abstract class Verb<T> : Verb where T : IComponent
+    {
+        /// <summary>
+        ///     Gets the text string that will be shown to <paramref name="user"/> in the right click menu.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <param name="component">The component instance for which this verb is being loaded.</param>
+        /// <returns>The text string that is shown in the right click menu for this verb.</returns>
+        protected abstract string GetText(IEntity user, T component);
+
+        /// <summary>
+        ///     Gets whether this verb is "disabled" in the right click menu.
+        ///     The verb is still visible in disabled state, but greyed out.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <param name="component">The component instance for which this verb is being loaded.</param>
+        /// <returns>True if the verb is disabled, false otherwise.</returns>
+        protected abstract bool IsDisabled(IEntity user, T component);
+
+        /// <summary>
+        ///     Invoked when this verb is activated from the right click menu.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <param name="component">The component instance for which this verb is being loaded.</param>
+        protected abstract void Activate(IEntity user, T component);
+
+
+        public sealed override string GetText(IEntity user, IComponent component)
+        {
+            return GetText(user, (T) component);
+        }
+
+        public sealed override bool IsDisabled(IEntity user, IComponent component)
+        {
+            return IsDisabled(user, (T) component);
+        }
+
+        public sealed override void Activate(IEntity user, IComponent component)
+        {
+            Activate(user, (T) component);
+        }
+    }
+
+    /// <summary>
+    ///     This attribute should be used on <see cref="Verb"/> implementations nested inside component classes,
+    ///     so that they're automatically detected.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Class, Inherited = false)]
+    public sealed class VerbAttribute : Attribute
+    {
+    }
+
+    public static class VerbUtility
+    {
+        // TODO: This is a quick hack. Verb objects should absolutely be cached properly.
+        // This works for now though.
+        public static IEnumerable<(IComponent, Verb)> GetVerbs(IEntity entity)
+        {
+            foreach (var component in entity.GetAllComponents())
+            {
+                var type = component.GetType();
+                foreach (var nestedType in type.GetNestedTypes())
+                {
+                    if (!typeof(Verb).IsAssignableFrom(nestedType) || nestedType.IsAbstract)
+                    {
+                        continue;
+                    }
+
+                    var verb = (Verb) Activator.CreateInstance(nestedType);
+                    yield return (component, verb);
+                }
+            }
+        }
+    }
+}

Content.Shared/Input/ContentKeyFunctions.cs

@@ -13,5 +13,6 @@ namespace Content.Shared.Input
         public static readonly BoundKeyFunction UseItemInHand = "UseItemInHand"; // use hand item on world entity
         public static readonly BoundKeyFunction ActivateItemInWorld = "ActivateItemInWorld"; // default action on world entity
         public static readonly BoundKeyFunction ThrowItemInHand = "ThrowItemInHand";
+        public static readonly BoundKeyFunction OpenContextMenu = "OpenContextMenu";
     }
 }