Ghost Roles (#3106)

* Add files for Ghost Roles.

* Work on Ghost Roles

* Improvements

* GHOST ROLES IS DONE

* mmm yes

* auto-update when setting rolename/roledescription

* well

* command graceful error

* Makes UI have a scrollbar when it has too many entries

* fix command fuckup

* Apply suggestions from code review

Co-authored-by: metalgearsloth <31366439+metalgearsloth@users.noreply.github.com>

Co-authored-by: metalgearsloth <31366439+metalgearsloth@users.noreply.github.com>

Content.Server/GameObjects/Components/Observer/GhostRoleComponent.cs

@@ -0,0 +1,75 @@
+using Content.Server.GameObjects.EntitySystems;
+using Robust.Server.Interfaces.Player;
+using Robust.Shared.GameObjects;
+using Robust.Shared.GameObjects.Systems;
+using Robust.Shared.Serialization;
+using Robust.Shared.ViewVariables;
+
+namespace Content.Server.GameObjects.Components.Observer
+{
+    public abstract class GhostRoleComponent : Component
+    {
+        private string _roleName;
+        private string _roleDescription;
+
+        // We do this so updating RoleName and RoleDescription in VV updates the open EUIs.
+
+        [ViewVariables(VVAccess.ReadWrite)]
+        public string RoleName
+        {
+            get
+            {
+                return _roleName;
+            }
+            private set
+            {
+                _roleName = value;
+                EntitySystem.Get<GhostRoleSystem>().UpdateAllEui();
+            }
+        }
+
+        [ViewVariables(VVAccess.ReadWrite)]
+        public string RoleDescription
+        {
+            get
+            {
+                return _roleDescription;
+            }
+            private set
+            {
+                _roleDescription = value;
+                EntitySystem.Get<GhostRoleSystem>().UpdateAllEui();
+            }
+        }
+
+        [ViewVariables(VVAccess.ReadOnly)]
+        public bool Taken { get; protected set; }
+
+        [ViewVariables]
+        public uint Identifier { get; set; }
+
+        public override void ExposeData(ObjectSerializer serializer)
+        {
+            base.ExposeData(serializer);
+
+            serializer.DataField(ref _roleName, "name", "Unknown");
+            serializer.DataField(ref _roleDescription, "description", "Unknown");
+        }
+
+        public override void Initialize()
+        {
+            base.Initialize();
+
+            EntitySystem.Get<GhostRoleSystem>().RegisterGhostRole(this);
+        }
+
+        protected override void Shutdown()
+        {
+            base.Shutdown();
+
+            EntitySystem.Get<GhostRoleSystem>().UnregisterGhostRole(this);
+        }
+
+        public abstract bool Take(IPlayerSession session);
+    }
+}

Content.Server/GameObjects/Components/Observer/GhostRoleMobSpawnerComponent.cs

@@ -0,0 +1,69 @@
+using System;
+using Content.Server.GameObjects.Components.Mobs;
+using Content.Server.Players;
+using JetBrains.Annotations;
+using Robust.Server.Interfaces.GameObjects;
+using Robust.Server.Interfaces.Player;
+using Robust.Shared.GameObjects;
+using Robust.Shared.IoC;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Serialization;
+using Robust.Shared.ViewVariables;
+
+namespace Content.Server.GameObjects.Components.Observer
+{
+    /// <summary>
+    ///     Allows a ghost to take this role, spawning a new entity.
+    /// </summary>
+    [RegisterComponent, ComponentReference(typeof(GhostRoleComponent))]
+    public class GhostRoleMobSpawnerComponent : GhostRoleComponent
+    {
+        public override string Name => "GhostRoleMobSpawner";
+
+
+        [ViewVariables]
+        private bool _deleteOnSpawn = true;
+
+        [ViewVariables(VVAccess.ReadWrite)]
+        private int _availableTakeovers = 1;
+
+        [ViewVariables]
+        private int _currentTakeovers = 0;
+
+        [CanBeNull, ViewVariables(VVAccess.ReadWrite)] public string Prototype { get; private set; }
+
+        public override void ExposeData(ObjectSerializer serializer)
+        {
+            base.ExposeData(serializer);
+
+            serializer.DataField(this, x => x.Prototype, "prototype", null);
+            serializer.DataField(ref _deleteOnSpawn, "deleteOnSpawn", true);
+            serializer.DataField(ref _availableTakeovers, "availableTakeovers", 1);
+        }
+
+        public override bool Take(IPlayerSession session)
+        {
+            if (Taken)
+                return false;
+
+            if(string.IsNullOrEmpty(Prototype))
+                throw new NullReferenceException("Prototype string cannot be null or empty!");
+
+            var mob = Owner.EntityManager.SpawnEntity(Prototype, Owner.Transform.Coordinates);
+
+            mob.EnsureComponent<MindComponent>();
+            session.ContentData().Mind.TransferTo(mob);
+
+            if (++_currentTakeovers < _availableTakeovers) return true;
+
+            Taken = true;
+
+            if (_deleteOnSpawn)
+                Owner.Delete();
+
+
+            return true;
+
+        }
+    }
+}

Content.Server/GameObjects/Components/Observer/GhostRolesEui.cs

@@ -0,0 +1,39 @@
+using Content.Server.Eui;
+using Content.Server.GameObjects.EntitySystems;
+using Content.Shared.Eui;
+using Content.Shared.GameObjects.Components.Observer;
+using Robust.Shared.GameObjects.Systems;
+
+namespace Content.Server.GameObjects.Components.Observer
+{
+    public class GhostRolesEui : BaseEui
+    {
+        public override GhostRolesEuiState GetNewState()
+        {
+            return new(EntitySystem.Get<GhostRoleSystem>().GetGhostRolesInfo());
+        }
+
+        public override void HandleMessage(EuiMessageBase msg)
+        {
+            base.HandleMessage(msg);
+
+            switch (msg)
+            {
+                case GhostRoleTakeoverRequestMessage req:
+                    EntitySystem.Get<GhostRoleSystem>().Takeover(Player, req.Identifier);
+                    break;
+
+                case GhostRoleWindowCloseMessage _:
+                    Closed();
+                    break;
+            }
+        }
+
+        public override void Closed()
+        {
+            base.Closed();
+
+            EntitySystem.Get<GhostRoleSystem>().CloseEui(Player);
+        }
+    }
+}

Content.Server/GameObjects/Components/Observer/GhostTakeoverAvailableComponent.cs

@@ -0,0 +1,38 @@
+using System;
+using Content.Server.GameObjects.Components.Mobs;
+using Content.Server.GameObjects.EntitySystems;
+using Content.Server.Players;
+using Robust.Server.Interfaces.Player;
+using Robust.Shared.GameObjects;
+using Robust.Shared.GameObjects.Systems;
+
+namespace Content.Server.GameObjects.Components.Observer
+{
+    /// <summary>
+    ///     Allows a ghost to take over the Owner entity.
+    /// </summary>
+    [RegisterComponent, ComponentReference(typeof(GhostRoleComponent))]
+    public class GhostTakeoverAvailableComponent : GhostRoleComponent
+    {
+        public override string Name => "GhostTakeoverAvailable";
+
+        public override bool Take(IPlayerSession session)
+        {
+            if (Taken)
+                return false;
+
+            Taken = true;
+
+            var mind = Owner.EnsureComponent<MindComponent>();
+
+            if(mind.HasMind)
+                throw new Exception("MindComponent already has a mind!");
+
+            session.ContentData().Mind.TransferTo(Owner);
+
+            EntitySystem.Get<GhostRoleSystem>().UnregisterGhostRole(this);
+
+            return true;
+        }
+    }
+}