Interaction Entity System (#26)

* Interaction Entity System

* ye

* Update submodule

* Requires engine update to function, but doesn't use shitcode

* Fix conflicts

* Fix conflicts but for real

* Update submodule

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "engine"]
 	path = engine
 	url = https://github.com/space-wizards/space-station-14.git
-	branch = 0a231f0217a7b9f9ce7093bdd091ce3e3de1b69d
+	branch = 56508df91937fd456bc5411008575169d93b262b

Content.Server/Content.Server.csproj

@@ -57,7 +57,6 @@
   <ItemGroup>
     <Compile Include="EntryPoint.cs" />
     <Compile Include="GameObjects\Components\Doors\ServerDoorComponent.cs" />
-    <Compile Include="GameObjects\Components\Interactable\InteractableComponent.cs" />
     <Compile Include="GameObjects\Components\Power\PowerStorageComponent.cs" />
     <Compile Include="GameObjects\Components\Power\PowerGeneratorComponent.cs" />
     <Compile Include="GameObjects\Components\Power\PowerDevice.cs" />
@@ -65,8 +64,8 @@
     <Compile Include="GameObjects\Components\Power\PowerNodeComponent.cs" />
     <Compile Include="GameObjects\Components\Power\PowerProviderComponent.cs" />
     <Compile Include="GameObjects\Components\Power\PowerTransferComponent.cs" />
+    <Compile Include="GameObjects\EntitySystems\InteractionSystem.cs" />
     <Compile Include="GameObjects\EntitySystems\PowerSystem.cs" />
-    <Compile Include="Interfaces\GameObjects\Components\Interactable\IInteractableComponent.cs" />
     <Compile Include="Interfaces\GameObjects\Components\Items\IHandsComponent.cs" />
     <Compile Include="Interfaces\GameObjects\Components\Items\IInventoryComponent.cs" />
     <Compile Include="Interfaces\GameObjects\Components\Items\IItemComponent.cs" />
@@ -109,4 +108,7 @@
     <ContentAssemblies Include="$(OutputPath)Content.Server.pdb" Condition="'$(Configuration)' == 'Debug'" />
     <ContentAssemblies Include="$(OutputPath)Content.Shared.pdb" Condition="'$(Configuration)' == 'Debug'" />
   </ItemGroup>
+  <ItemGroup>
+    <Folder Include="GameObjects\Components\Interactable\" />
+  </ItemGroup>
 </Project>

Content.Server/EntryPoint.cs

@@ -53,9 +53,6 @@ namespace Content.Server
             factory.Register<ItemComponent>();
             factory.RegisterReference<ItemComponent, IItemComponent>();
             
-            factory.Register<InteractableComponent>();
-            factory.RegisterReference<InteractableComponent, IInteractableComponent>();
-
             factory.Register<DamageableComponent>();
             factory.Register<DestructibleComponent>();
             factory.Register<TemperatureComponent>();

Content.Server/GameObjects/Components/Doors/ServerDoorComponent.cs

@@ -1,41 +1,40 @@
-using Content.Server.Interfaces.GameObjects;
+using System;
+using Content.Server.Interfaces.GameObjects;
 using Content.Shared.GameObjects;
 using SS14.Server.GameObjects;
 using SS14.Shared.GameObjects;
+using SS14.Shared.Interfaces.GameObjects;
 using SS14.Shared.Interfaces.GameObjects.Components;
 using SS14.Shared.Log;
 using SS14.Shared.Maths;
+using SS14.Shared.IoC;
+using Content.Server.GameObjects.EntitySystems;
 
 namespace Content.Server.GameObjects
 {
-    public class ServerDoorComponent : SharedDoorComponent
+    public class ServerDoorComponent : SharedDoorComponent, IAttackHand
     {
         public bool Opened { get; private set; }
 
         private float OpenTimeCounter;
         
-        private IInteractableComponent interactableComponent;
         private CollidableComponent collidableComponent;
 
         public override void Initialize()
         {
             base.Initialize();
 
-            interactableComponent = Owner.GetComponent<IInteractableComponent>();
-            interactableComponent.OnAttackHand += OnAttackHand;
             collidableComponent = Owner.GetComponent<CollidableComponent>();
             collidableComponent.OnBump += OnBump;
         }
 
         public override void OnRemove()
         {
-            interactableComponent.OnAttackHand -= OnAttackHand;
-            interactableComponent = null;
             collidableComponent.OnBump -= OnBump;
             collidableComponent = null;
         }
 
-        private void OnAttackHand(object sender, AttackHandEventArgs args)
+        public bool Attackhand(IEntity user)
         {
             if (Opened)
             {
@@ -45,6 +44,7 @@ namespace Content.Server.GameObjects
             {
                 Open();
             }
+            return true;
         }
 
         private void OnBump(object sender, BumpEventArgs args)

Content.Server/GameObjects/Components/Interactable/InteractableComponent.cs

@@ -1,80 +0,0 @@
-using Content.Server.Interfaces.GameObjects;
-using SS14.Server.Interfaces.GameObjects;
-using SS14.Shared.GameObjects;
-using SS14.Shared.Interfaces.GameObjects.Components;
-using SS14.Shared.Log;
-using System;
-
-namespace Content.Server.GameObjects
-{
-    public class InteractableComponent : Component, IInteractableComponent
-    {
-        public override string Name => "Interactable";
-
-        /// <inheritdoc />
-        public event EventHandler<AttackHandEventArgs> OnAttackHand;
-
-        /// <inheritdoc />
-        public event EventHandler<AttackByEventArgs> OnAttackBy;
-
-        private IClickableComponent clickableComponent;
-        private IServerTransformComponent transform;
-        private const float INTERACTION_RANGE = 2;
-        private const float INTERACTION_RANGE_SQUARED = INTERACTION_RANGE * INTERACTION_RANGE;
-
-        public override void Initialize()
-        {
-            transform = Owner.GetComponent<IServerTransformComponent>();
-            if (Owner.TryGetComponent<IClickableComponent>(out var component))
-            {
-                clickableComponent = component;
-                clickableComponent.OnClick += ClickableComponent_OnClick;
-            }
-            else
-            {
-                Logger.Error($"Interactable component must also have a clickable component to function! Prototype: {Owner.Prototype.ID}");
-            }
-            base.Initialize();
-        }
-
-        public override void Shutdown()
-        {
-            if (clickableComponent != null)
-            {
-                clickableComponent.OnClick -= ClickableComponent_OnClick;
-                clickableComponent = null;
-            }
-            transform = null;
-            base.Shutdown();
-        }
-
-        private void ClickableComponent_OnClick(object sender, ClickEventArgs e)
-        {
-            if (!e.User.TryGetComponent<IServerTransformComponent>(out var userTransform))
-            {
-                return;
-            }
-
-            var distance = (userTransform.WorldPosition - transform.WorldPosition).LengthSquared;
-            if (distance > INTERACTION_RANGE_SQUARED)
-            {
-                return;
-            }
-
-            if (!e.User.TryGetComponent<IHandsComponent>(out var hands))
-            {
-                return;
-            }
-
-            var item = hands.GetHand(hands.ActiveIndex);
-            if (item != null)
-            {
-                OnAttackBy?.Invoke(this, new AttackByEventArgs(Owner, e.User, item, hands.ActiveIndex));
-            }
-            else
-            {
-                OnAttackHand?.Invoke(this, new AttackHandEventArgs(Owner, e.User, hands.ActiveIndex));
-            }
-        }
-    }
-}

Content.Server/GameObjects/Components/Items/ItemComponent.cs

@@ -1,19 +1,17 @@
 using Content.Server.Interfaces.GameObjects;
 using SS14.Server.Interfaces.GameObjects;
 using SS14.Shared.GameObjects;
-using SS14.Shared.Interfaces.GameObjects.Components;
-using SS14.Shared.Log;
 using System;
+using SS14.Shared.Interfaces.GameObjects;
 
 namespace Content.Server.GameObjects
 {
-    public class ItemComponent : Component, IItemComponent
+    public class ItemComponent : Component, IItemComponent, EntitySystems.IAttackHand
     {
         public override string Name => "Item";
 
         /// <inheritdoc />
         public IInventorySlot ContainingSlot { get; private set; }
-        private IInteractableComponent interactableComponent;
 
         public void RemovedFromSlot()
         {
@@ -45,38 +43,15 @@ namespace Content.Server.GameObjects
             }
         }
 
-        public override void Initialize()
+        public bool Attackhand(IEntity user)
-        {
-            if (Owner.TryGetComponent<IInteractableComponent>(out var interactable))
-            {
-                interactableComponent = interactable;
-                interactableComponent.OnAttackHand += InteractableComponent_OnAttackHand;
-            }
-            else
-            {
-                Logger.Error($"Item component must have an interactable component to function! Prototype: {Owner.Prototype.ID}");
-            }
-            base.Initialize();
-        }
-
-        private void InteractableComponent_OnAttackHand(object sender, AttackHandEventArgs e)
         {
             if (ContainingSlot != null)
             {
-                return;
+                return false;
             }
-            var hands = e.User.GetComponent<IHandsComponent>();
+            var hands = user.GetComponent<IHandsComponent>();
-            hands.PutInHand(this, e.HandIndex, fallback: false);
+            hands.PutInHand(this, hands.ActiveIndex, fallback: false);
-        }
+            return true;
-
-        public override void Shutdown()
-        {
-            if (interactableComponent != null)
-            {
-                interactableComponent.OnAttackHand -= InteractableComponent_OnAttackHand;
-                interactableComponent = null;
-            }
-            base.Shutdown();
         }
     }
 }

Content.Server/GameObjects/Components/Items/ServerHandsComponent.cs

@@ -2,13 +2,11 @@
 using Content.Shared.GameObjects;
 using SS14.Server.GameObjects.Events;
 using SS14.Server.Interfaces.GameObjects;
-using SS14.Shared;
 using SS14.Shared.GameObjects;
 using SS14.Shared.Utility;
 using System;
 using System.Collections.Generic;
 using YamlDotNet.RepresentationModel;
-using Lidgren.Network;
 using SS14.Shared.Enums;
 
 namespace Content.Server.GameObjects

Content.Server/GameObjects/EntitySystems/InteractionSystem.cs

@@ -0,0 +1,149 @@
+using Content.Server.Interfaces.GameObjects;
+using SS14.Server.Interfaces.GameObjects;
+using SS14.Shared.GameObjects;
+using SS14.Shared.GameObjects.System;
+using SS14.Shared.Interfaces.GameObjects;
+using SS14.Shared.Interfaces.GameObjects.Components;
+using SS14.Shared.IoC;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Content.Server.GameObjects.EntitySystems
+{
+    /// <summary>
+    /// This interface gives components behavior when being clicked on or "attacked" by a user with an object in their hand
+    /// </summary>
+    public interface IAttackby
+    {
+        bool Attackby(IEntity user, IEntity attackwith);
+    }
+
+    /// <summary>
+    /// This interface gives components behavior when being clicked on or "attacked" by a user with an empty hand
+    /// </summary>
+    public interface IAttackHand
+    {
+        bool Attackhand(IEntity user);
+    }
+
+    public interface IUse
+    {
+        bool UseEntity(IEntity user);
+    }
+
+    /// <summary>
+    /// Governs interactions during clicking on entities
+    /// </summary>
+    public class InteractionSystem : EntitySystem
+    {
+        private const float INTERACTION_RANGE = 2;
+        private const float INTERACTION_RANGE_SQUARED = INTERACTION_RANGE * INTERACTION_RANGE;
+
+        public override void Initialize()
+        {
+            base.Initialize();
+
+            SubscribeEvent<ClickedOnEntityEventArgs>(UserInteraction, this);
+        }
+
+        public void UserInteraction(object sender, EntityEventArgs arg)
+        {
+            ClickedOnEntityEventArgs e = (ClickedOnEntityEventArgs)arg;
+            if (e.MouseButton != Clicktype.Left)
+                return;
+
+            IEntity user = EntityManager.GetEntity(e.Clicker);
+            IEntity attacked = EntityManager.GetEntity(e.Clicked);
+
+            if (!user.TryGetComponent<IServerTransformComponent>(out var userTransform))
+            {
+                return;
+            }
+
+            var distance = (userTransform.WorldPosition - attacked.GetComponent<IServerTransformComponent>().WorldPosition).LengthSquared;
+            if (distance > INTERACTION_RANGE_SQUARED)
+            {
+                return;
+            }
+
+            if (!user.TryGetComponent<IHandsComponent>(out var hands))
+            {
+                return;
+            }
+
+            var item = hands.GetHand(hands.ActiveIndex)?.Owner;
+
+            if (item != null && attacked != item)
+            {
+                Interaction(user, item, attacked);
+            }
+            else if(attacked == item)
+            {
+                UseInteraction(user, item);
+            }
+            else
+            {
+                Interaction(user, attacked);
+            }
+        }
+
+        /// <summary>
+        /// Uses a weapon/object on an entity
+        /// </summary>
+        /// <param name="user"></param>
+        /// <param name="weapon"></param>
+        /// <param name="attacked"></param>
+        public static void Interaction(IEntity user, IEntity weapon, IEntity attacked)
+        {
+            List<IAttackby> interactables = attacked.GetComponents<IAttackby>().ToList();
+
+            for(var i = 0; i < interactables.Count; i++)
+            {
+                if (interactables[i].Attackby(user, weapon)) //If an attackby returns a status completion we finish our attack
+                {
+                    return;
+                }
+            }
+
+            //Else check damage component to see if we damage if not attackby, and if so can we attack object
+        }
+
+        /// <summary>
+        /// Uses an empty hand on an entity
+        /// </summary>
+        /// <param name="user"></param>
+        /// <param name="attacked"></param>
+        public static void Interaction(IEntity user, IEntity attacked)
+        {
+            List<IAttackHand> interactables = attacked.GetComponents<IAttackHand>().ToList();
+
+            for (var i = 0; i < interactables.Count; i++)
+            {
+                if (interactables[i].Attackhand(user)) //If an attackby returns a status completion we finish our attack
+                {
+                    return;
+                }
+            }
+
+            //Else check damage component to see if we damage if not attackby, and if so can we attack object
+        }
+
+        /// <summary>
+        /// Activates/Uses an object in control/possession of a user
+        /// </summary>
+        /// <param name="user"></param>
+        /// <param name="attacked"></param>
+        public static void UseInteraction(IEntity user, IEntity used)
+        {
+            List<IUse> usables = used.GetComponents<IUse>().ToList();
+
+            for (var i = 0; i < usables.Count; i++)
+            {
+                if (usables[i].UseEntity(user)) //If an attackby returns a status completion we finish our attack
+                {
+                    return;
+                }
+            }
+        }
+    }
+}

Content.Server/Interfaces/GameObjects/Components/Interactable/IInteractableComponent.cs

@@ -1,48 +0,0 @@
-using SS14.Shared.Interfaces.GameObjects;
-using System;
-
-namespace Content.Server.Interfaces.GameObjects
-{
-    public interface IInteractableComponent : IComponent
-    {
-        /// <summary>
-        ///     Invoked when an entity is clicked with an empty hand.
-        /// </summary>
-        event EventHandler<AttackHandEventArgs> OnAttackHand;
-
-        /// <summary>
-        /// Invoked when an entity is clicked with an item.
-        /// </summary>
-        event EventHandler<AttackByEventArgs> OnAttackBy;
-    }
-
-    public class AttackByEventArgs : EventArgs
-    {
-        public readonly IEntity Target;
-        public readonly IEntity User;
-        public readonly IItemComponent Item;
-        public readonly string HandIndex;
-
-        public AttackByEventArgs(IEntity target, IEntity user, IItemComponent item, string handIndex)
-        {
-            Target = target;
-            User = user;
-            Item = item;
-            HandIndex = handIndex;
-        }
-    }
-
-    public class AttackHandEventArgs : EventArgs
-    {
-        public readonly IEntity Target;
-        public readonly IEntity User;
-        public readonly string HandIndex;
-
-        public AttackHandEventArgs(IEntity target, IEntity user, string handIndex)
-        {
-            Target = target;
-            User = user;
-            HandIndex = handIndex;
-        }
-    }
-}

Resources/Prototypes/Entities/Door.yml

@@ -4,7 +4,6 @@
   components:
   - type: Transform
   - type: Clickable
-  - type: Interactable
   - type: Sprite
     drawdepth: FloorPlaceable
     sprites:

Resources/Prototypes/Entities/Items.yml

@@ -3,7 +3,6 @@
   id: BaseItem
   components:
   - type: Transform
-  - type: Interactable
   - type: Item
   - type: Clickable
   - type: BoundingBox