Improved QoL of /back and /warp (SubnauticaNitrox#1181)

dartasen · web-flow · commit f8cecafd69fd · 2020-07-27T18:13:39.000-07:00
* command type cleanup &amp; improved new commands

* minor

* review changes
diff --git a/NitroxModel/DataStructures/GameLogic/NitroxVector3.cs b/NitroxModel/DataStructures/GameLogic/NitroxVector3.cs
@@ -81,7 +81,7 @@ public static NitroxVector3 Cross(NitroxVector3 vector1, NitroxVector3 vector2)
 
         public override string ToString()
         {
-            return "[Vector3 - {" + X + ", " + Y + ", " + Z + "}]";
+            return $"[{X}, {Y}, {Z}]";
         }
     }
 }
diff --git a/NitroxServer/Communication/Packets/Processors/PlayerDeathEventProcessor.cs b/NitroxServer/Communication/Packets/Processors/PlayerDeathEventProcessor.cs
@@ -1,4 +1,5 @@
-﻿using NitroxModel.Packets;
+﻿using NitroxModel.DataStructures.GameLogic;
+using NitroxModel.Packets;
 using NitroxModel.Server;
 using NitroxServer.Communication.Packets.Processors.Abstract;
 using NitroxServer.GameLogic;
@@ -26,6 +27,12 @@ public override void Process(PlayerDeathEvent packet, Player player)
             }
 
             player.LastStoredPosition = packet.DeathPosition;
+
+            if (player.Permissions > Perms.MODERATOR)
+            {
+                player.SendPacket(new ChatMessage(ChatMessage.SERVER_ID, "You can use /back to go to your death location"));
+            }
+
             playerManager.SendPacketToOtherPlayers(packet, player);
         }
     }
diff --git a/NitroxServer/ConsoleCommands/Abstract/CallArgs.cs b/NitroxServer/ConsoleCommands/Abstract/CallArgs.cs
@@ -5,7 +5,7 @@ namespace NitroxServer.ConsoleCommands.Abstract
 {
     public abstract partial class Command
     {
-        public class CallArgs
+        public sealed class CallArgs
         {
             public Command Command { get; }
             public string[] Args { get; }
@@ -25,11 +25,6 @@ public bool IsValid(int index)
                 return index < Args.Length && index >= 0 && Args.Length != 0;
             }
 
-            public string Get(int index)
-            {
-                return Get<string>(index);
-            }
-
             public string GetTillEnd(int startIndex = 0)
             {
                 // TODO: Proper argument capture/parse instead of this argument join hack
@@ -41,6 +36,12 @@ public string GetTillEnd(int startIndex = 0)
                 return string.Empty;
             }
 
+            public string Get(int index)
+            {
+                return Get<string>(index);
+            }
+
+            //TODO: Remove ability to use indexes and use an internal counter instead
             public T Get<T>(int index)
             {
                 IParameter<object> param = Command.Parameters[index];
diff --git a/NitroxServer/ConsoleCommands/Abstract/Type/TypeBoolean.cs b/NitroxServer/ConsoleCommands/Abstract/Type/TypeBoolean.cs
@@ -1,20 +1,19 @@
 ﻿using System;
-using System.Collections.Generic;
 using System.Linq;
 using NitroxModel.Helper;
 
 namespace NitroxServer.ConsoleCommands.Abstract.Type
 {
     public class TypeBoolean : Parameter<bool?>, IParameter<object>
     {
-        private static readonly IList<string> noValues = new List<string>
+        private static readonly string[] noValues = new string[]
         {
             bool.FalseString,
             "no",
             "off"
         };
 
-        private static readonly IList<string> yesValues = new List<string>
+        private static readonly string[] yesValues = new string[]
         {
             bool.TrueString,
             "yes",
@@ -31,7 +30,6 @@ public override bool IsValid(string arg)
         public override bool? Read(string arg)
         {
             Validate.IsTrue(IsValid(arg), "Invalid boolean value received");
-
             return yesValues.Contains(arg, StringComparer.OrdinalIgnoreCase);
         }
 
diff --git a/NitroxServer/ConsoleCommands/Abstract/Type/TypeEnum.cs b/NitroxServer/ConsoleCommands/Abstract/Type/TypeEnum.cs
@@ -3,7 +3,7 @@
 
 namespace NitroxServer.ConsoleCommands.Abstract.Type
 {
-    public class TypeEnum<T> : Parameter<object> where T : struct
+    public class TypeEnum<T> : Parameter<object> where T : struct, Enum
     {
         public TypeEnum(string name, bool required) : base(name, required)
         {
@@ -12,16 +12,12 @@ public TypeEnum(string name, bool required) : base(name, required)
 
         public override bool IsValid(string arg)
         {
-            T result;
-            return Enum.TryParse(arg, true, out result);
+            return Enum.TryParse(arg, true, out T result);
         }
 
         public override object Read(string arg)
         {
-            T value;
-
-            Validate.IsTrue(Enum.TryParse(arg, true, out value), "Unknown value received");
-
+            Validate.IsTrue(Enum.TryParse(arg, true, out T value), "Unknown value received");
             return value;
         }
     }
diff --git a/NitroxServer/ConsoleCommands/Abstract/Type/TypeFloat.cs b/NitroxServer/ConsoleCommands/Abstract/Type/TypeFloat.cs
@@ -8,16 +8,12 @@ public TypeFloat(string name, bool isRequired) : base(name, isRequired) { }
 
         public override bool IsValid(string arg)
         {
-            float value;
-            return float.TryParse(arg, out value);
+            return float.TryParse(arg, out float value);
         }
 
         public override float? Read(string arg)
         {
-            float value;
-
-            Validate.IsTrue(float.TryParse(arg, out value), "Invalid decimal number received");
-
+            Validate.IsTrue(float.TryParse(arg, out float value), "Invalid decimal number received");
             return value;
         }
 
diff --git a/NitroxServer/ConsoleCommands/Abstract/Type/TypeInt.cs b/NitroxServer/ConsoleCommands/Abstract/Type/TypeInt.cs
@@ -8,16 +8,12 @@ public TypeInt(string name, bool isRequired) : base(name, isRequired) { }
 
         public override bool IsValid(string arg)
         {
-            int value;
-            return int.TryParse(arg, out value);
+            return int.TryParse(arg, out int value);
         }
 
         public override int? Read(string arg)
         {
-            int value;
-
-            Validate.IsTrue(int.TryParse(arg, out value), "Invalid integer received");
-
+            Validate.IsTrue(int.TryParse(arg, out int value), "Invalid integer received");
             return value;
         }
 
diff --git a/NitroxServer/ConsoleCommands/Abstract/Type/TypePlayer.cs b/NitroxServer/ConsoleCommands/Abstract/Type/TypePlayer.cs
@@ -15,14 +15,12 @@ public TypePlayer(string name, bool required) : base(name, required)
 
         public override bool IsValid(string arg)
         {
-            Player player;
-            return playerManager.TryGetPlayerByName(arg, out player);
+            return playerManager.TryGetPlayerByName(arg, out Player player);
         }
 
         public override Player Read(string arg)
         {
-            Player player;
-            Validate.IsTrue(playerManager.TryGetPlayerByName(arg, out player), "Player not found");
+            Validate.IsTrue(playerManager.TryGetPlayerByName(arg, out Player player), "Player not found");
             return player;
         }
     }
diff --git a/NitroxServer/ConsoleCommands/BackCommand.cs b/NitroxServer/ConsoleCommands/BackCommand.cs
@@ -1,6 +1,5 @@
 ﻿using NitroxModel.DataStructures.GameLogic;
 using NitroxModel.Helper;
-using NitroxModel.Logger;
 using NitroxServer.ConsoleCommands.Abstract;
 
 namespace NitroxServer.ConsoleCommands
@@ -23,7 +22,7 @@ protected override void Execute(CallArgs args)
             }
 
             player.Teleport(player.LastStoredPosition.Value);
-            SendMessage(args.Sender, $"Teleported back {player.LastStoredPosition.Value}");
+            SendMessage(args.Sender, $"Teleported back to {player.LastStoredPosition.Value}");
         }
     }
 }
diff --git a/NitroxServer/ConsoleCommands/BroadcastCommand.cs b/NitroxServer/ConsoleCommands/BroadcastCommand.cs
@@ -7,11 +7,8 @@ namespace NitroxServer.ConsoleCommands
 {
     internal class BroadcastCommand : Command
     {
-        private readonly PlayerManager playerManager;
-
-        public BroadcastCommand(PlayerManager playerManager) : base("broadcast", Perms.ADMIN, "Broadcasts a message on the server", true)
+        public BroadcastCommand() : base("broadcast", Perms.ADMIN, "Broadcasts a message on the server", true)
         {
-            this.playerManager = playerManager;
             AddAlias("say");
             AddParameter(new TypeString("message", true));
         }
diff --git a/NitroxServer/ConsoleCommands/WarpCommand.cs b/NitroxServer/ConsoleCommands/WarpCommand.cs
@@ -7,19 +7,31 @@ namespace NitroxServer.ConsoleCommands
 {
     internal class WarpCommand : Command
     {
-        public WarpCommand() : base("warpto", Perms.ADMIN, "Teleports you on a player")
+        public WarpCommand() : base("warp", Perms.ADMIN, "Allows to teleport players")
         {
             AddParameter(new TypePlayer("name", true));
+            AddParameter(new TypePlayer("name", false));
         }
 
         protected override void Execute(CallArgs args)
         {
-            Validate.IsTrue(args.Sender.HasValue, "This command can't be used by CONSOLE");
+            Player destination;
+            Player sender;
 
-            Player otherPlayer = args.Get<Player>(0);
-            args.Sender.Value.Teleport(otherPlayer.Position);
+            if (args.IsValid(1))
+            {
+                destination = args.Get<Player>(1);
+                sender = args.Get<Player>(0);
+            }
+            else
+            {
+                Validate.IsTrue(args.Sender.HasValue, "This command can't be used by CONSOLE");
+                destination = args.Get<Player>(0);
+                sender = args.Sender.Value;
+            }
 
-            SendMessage(args.Sender, $"Teleported to {otherPlayer.Name}");
+            sender.Teleport(destination.Position);
+            SendMessage(sender, $"Teleported to {destination.Name}");
         }
     }
 }
diff --git a/NitroxServer/Player.cs b/NitroxServer/Player.cs
@@ -130,11 +130,6 @@ public List<EquippedItemData> GetEquipment()
             return equippedItems.ToList();
         }
 
-        public override string ToString()
-        {
-            return $"[Player {{{nameof(Id)}: {Id}}}, {{{nameof(Name)}: {Name}}}]";
-        }
-
         public bool CanSee(Entity entity)
         {
             return entity.ExistsInGlobalRoot || HasCellLoaded(entity.AbsoluteEntityCell);
@@ -154,6 +149,11 @@ public void Teleport(NitroxVector3 destination)
             LastStoredPosition = playerTeleported.DestinationFrom;
         }
 
+        public override string ToString()
+        {
+            return $"[Player - Id: {Id}, Name: {Name}, Perms: {Permissions}, Position: {Position}]";
+        }
+
         protected bool Equals(Player other)
         {
             return Id == other.Id;

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public static NitroxVector3 Cross(NitroxVector3 vector1, NitroxVector3 vector2)`
`81`	`81`
`82`	`82`	`public override string ToString()`
`83`	`83`	`{`
`84`		`- return "[Vector3 - {" + X + ", " + Y + ", " + Z + "}]";`
	`84`	`+ return $"[{X}, {Y}, {Z}]";`
`85`	`85`	`}`
`86`	`86`	`}`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-using NitroxModel.Packets;`
	`1`	`+using NitroxModel.DataStructures.GameLogic;`
	`2`	`+using NitroxModel.Packets;`
`2`	`3`	`using NitroxModel.Server;`
`3`	`4`	`using NitroxServer.Communication.Packets.Processors.Abstract;`
`4`	`5`	`using NitroxServer.GameLogic;`
`@@ -26,6 +27,12 @@ public override void Process(PlayerDeathEvent packet, Player player)`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`player.LastStoredPosition = packet.DeathPosition;`
	`30`	`+`
	`31`	`+ if (player.Permissions > Perms.MODERATOR)`
	`32`	`+ {`
	`33`	`+ player.SendPacket(new ChatMessage(ChatMessage.SERVER_ID, "You can use /back to go to your death location"));`
	`34`	`+ }`
	`35`	`+`
`29`	`36`	`playerManager.SendPacketToOtherPlayers(packet, player);`
`30`	`37`	`}`
`31`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace NitroxServer.ConsoleCommands.Abstract`
`5`	`5`	`{`
`6`	`6`	`public abstract partial class Command`
`7`	`7`	`{`
`8`		`- public class CallArgs`
	`8`	`+ public sealed class CallArgs`
`9`	`9`	`{`
`10`	`10`	`public Command Command { get; }`
`11`	`11`	`public string[] Args { get; }`
`@@ -25,11 +25,6 @@ public bool IsValid(int index)`
`25`	`25`	`return index < Args.Length && index >= 0 && Args.Length != 0;`
`26`	`26`	`}`
`27`	`27`
`28`		`- public string Get(int index)`
`29`		`- {`
`30`		`- return Get<string>(index);`
`31`		`- }`
`32`		`-`
`33`	`28`	`public string GetTillEnd(int startIndex = 0)`
`34`	`29`	`{`
`35`	`30`	`// TODO: Proper argument capture/parse instead of this argument join hack`
`@@ -41,6 +36,12 @@ public string GetTillEnd(int startIndex = 0)`
`41`	`36`	`return string.Empty;`
`42`	`37`	`}`
`43`	`38`
	`39`	`+ public string Get(int index)`
	`40`	`+ {`
	`41`	`+ return Get<string>(index);`
	`42`	`+ }`
	`43`	`+`
	`44`	`+ //TODO: Remove ability to use indexes and use an internal counter instead`
`44`	`45`	`public T Get<T>(int index)`
`45`	`46`	`{`
`46`	`47`	`IParameter<object> param = Command.Parameters[index];`
Original file line number	Diff line number	Diff line change
`@@ -1,20 +1,19 @@`
`1`	`1`	`using System;`
`2`		`-using System.Collections.Generic;`
`3`	`2`	`using System.Linq;`
`4`	`3`	`using NitroxModel.Helper;`
`5`	`4`
`6`	`5`	`namespace NitroxServer.ConsoleCommands.Abstract.Type`
`7`	`6`	`{`
`8`	`7`	`public class TypeBoolean : Parameter<bool?>, IParameter<object>`
`9`	`8`	`{`
`10`		`- private static readonly IList<string> noValues = new List<string>`
	`9`	`+ private static readonly string[] noValues = new string[]`
`11`	`10`	`{`
`12`	`11`	`bool.FalseString,`
`13`	`12`	`"no",`
`14`	`13`	`"off"`
`15`	`14`	`};`
`16`	`15`
`17`		`- private static readonly IList<string> yesValues = new List<string>`
	`16`	`+ private static readonly string[] yesValues = new string[]`
`18`	`17`	`{`
`19`	`18`	`bool.TrueString,`
`20`	`19`	`"yes",`
`@@ -31,7 +30,6 @@ public override bool IsValid(string arg)`
`31`	`30`	`public override bool? Read(string arg)`
`32`	`31`	`{`
`33`	`32`	`Validate.IsTrue(IsValid(arg), "Invalid boolean value received");`
`34`		`-`
`35`	`33`	`return yesValues.Contains(arg, StringComparer.OrdinalIgnoreCase);`
`36`	`34`	`}`
`37`	`35`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace NitroxServer.ConsoleCommands.Abstract.Type`
`5`	`5`	`{`
`6`		`- public class TypeEnum<T> : Parameter<object> where T : struct`
	`6`	`+ public class TypeEnum<T> : Parameter<object> where T : struct, Enum`
`7`	`7`	`{`
`8`	`8`	`public TypeEnum(string name, bool required) : base(name, required)`
`9`	`9`	`{`
`@@ -12,16 +12,12 @@ public TypeEnum(string name, bool required) : base(name, required)`
`12`	`12`
`13`	`13`	`public override bool IsValid(string arg)`
`14`	`14`	`{`
`15`		`- T result;`
`16`		`- return Enum.TryParse(arg, true, out result);`
	`15`	`+ return Enum.TryParse(arg, true, out T result);`
`17`	`16`	`}`
`18`	`17`
`19`	`18`	`public override object Read(string arg)`
`20`	`19`	`{`
`21`		`- T value;`
`22`		`-`
`23`		`- Validate.IsTrue(Enum.TryParse(arg, true, out value), "Unknown value received");`
`24`		`-`
	`20`	`+ Validate.IsTrue(Enum.TryParse(arg, true, out T value), "Unknown value received");`
`25`	`21`	`return value;`
`26`	`22`	`}`
`27`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,16 +8,12 @@ public TypeFloat(string name, bool isRequired) : base(name, isRequired) { }`
`8`	`8`
`9`	`9`	`public override bool IsValid(string arg)`
`10`	`10`	`{`
`11`		`- float value;`
`12`		`- return float.TryParse(arg, out value);`
	`11`	`+ return float.TryParse(arg, out float value);`
`13`	`12`	`}`
`14`	`13`
`15`	`14`	`public override float? Read(string arg)`
`16`	`15`	`{`
`17`		`- float value;`
`18`		`-`
`19`		`- Validate.IsTrue(float.TryParse(arg, out value), "Invalid decimal number received");`
`20`		`-`
	`16`	`+ Validate.IsTrue(float.TryParse(arg, out float value), "Invalid decimal number received");`
`21`	`17`	`return value;`
`22`	`18`	`}`
`23`	`19`
Original file line number	Diff line number	Diff line change
`@@ -8,16 +8,12 @@ public TypeInt(string name, bool isRequired) : base(name, isRequired) { }`
`8`	`8`
`9`	`9`	`public override bool IsValid(string arg)`
`10`	`10`	`{`
`11`		`- int value;`
`12`		`- return int.TryParse(arg, out value);`
	`11`	`+ return int.TryParse(arg, out int value);`
`13`	`12`	`}`
`14`	`13`
`15`	`14`	`public override int? Read(string arg)`
`16`	`15`	`{`
`17`		`- int value;`
`18`		`-`
`19`		`- Validate.IsTrue(int.TryParse(arg, out value), "Invalid integer received");`
`20`		`-`
	`16`	`+ Validate.IsTrue(int.TryParse(arg, out int value), "Invalid integer received");`
`21`	`17`	`return value;`
`22`	`18`	`}`
`23`	`19`
Original file line number	Diff line number	Diff line change
`@@ -15,14 +15,12 @@ public TypePlayer(string name, bool required) : base(name, required)`
`15`	`15`
`16`	`16`	`public override bool IsValid(string arg)`
`17`	`17`	`{`
`18`		`- Player player;`
`19`		`- return playerManager.TryGetPlayerByName(arg, out player);`
	`18`	`+ return playerManager.TryGetPlayerByName(arg, out Player player);`
`20`	`19`	`}`
`21`	`20`
`22`	`21`	`public override Player Read(string arg)`
`23`	`22`	`{`
`24`		`- Player player;`
`25`		`- Validate.IsTrue(playerManager.TryGetPlayerByName(arg, out player), "Player not found");`
	`23`	`+ Validate.IsTrue(playerManager.TryGetPlayerByName(arg, out Player player), "Player not found");`
`26`	`24`	`return player;`
`27`	`25`	`}`
`28`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`using NitroxModel.DataStructures.GameLogic;`
`2`	`2`	`using NitroxModel.Helper;`
`3`		`-using NitroxModel.Logger;`
`4`	`3`	`using NitroxServer.ConsoleCommands.Abstract;`
`5`	`4`
`6`	`5`	`namespace NitroxServer.ConsoleCommands`
`@@ -23,7 +22,7 @@ protected override void Execute(CallArgs args)`
`23`	`22`	`}`
`24`	`23`
`25`	`24`	`player.Teleport(player.LastStoredPosition.Value);`
`26`		`- SendMessage(args.Sender, $"Teleported back {player.LastStoredPosition.Value}");`
	`25`	`+ SendMessage(args.Sender, $"Teleported back to {player.LastStoredPosition.Value}");`
`27`	`26`	`}`
`28`	`27`	`}`
`29`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,8 @@ namespace NitroxServer.ConsoleCommands`
`7`	`7`	`{`
`8`	`8`	`internal class BroadcastCommand : Command`
`9`	`9`	`{`
`10`		`- private readonly PlayerManager playerManager;`
`11`		`-`
`12`		`- public BroadcastCommand(PlayerManager playerManager) : base("broadcast", Perms.ADMIN, "Broadcasts a message on the server", true)`
	`10`	`+ public BroadcastCommand() : base("broadcast", Perms.ADMIN, "Broadcasts a message on the server", true)`
`13`	`11`	`{`
`14`		`- this.playerManager = playerManager;`
`15`	`12`	`AddAlias("say");`
`16`	`13`	`AddParameter(new TypeString("message", true));`
`17`	`14`	`}`