Console Unify API Changes (#3059)

* Remove unused IChatCommand.

* Lots of refactoring into a shared context.

* Removed ICommonSession from server concmd Execute.

* Added argStr parameter to concmd execute.

* The execute function of client concmds now returns void, use the new shell.RemoteExecuteCommand function to forward commands.

* Finally move shells and commands into shared.

* Console commands can now be registered directly without a class in a shared context.

* Engine API Changes.

* Repair rebase damage.

* Update Submodule.
This commit is contained in:
Acruid
2021-02-01 16:49:43 -08:00
committed by GitHub
parent 80ad2ef5b7
commit 8b5d66050a
119 changed files with 820 additions and 796 deletions

View File

@@ -1,9 +1,9 @@
using JetBrains.Annotations;
using Robust.Client.Interfaces.Console;
using Content.Client.GameObjects.EntitySystems;
using Robust.Shared.GameObjects.Systems;
using Content.Shared.Atmos;
using System;
using Robust.Shared.Console;
namespace Content.Client.Commands
{
@@ -13,32 +13,31 @@ namespace Content.Client.Commands
public string Command => "atvrange";
public string Description => "Sets the atmos debug range (as two floats, start [red] and end [blue])";
public string Help => "atvrange <start> <end>";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
if (args.Length != 2)
{
console.AddLine(Help);
return false;
shell.WriteLine(Help);
return;
}
if (!float.TryParse(args[0], out var xStart))
{
console.AddLine("Bad float START");
return false;
shell.WriteLine("Bad float START");
return;
}
if (!float.TryParse(args[1], out var xEnd))
{
console.AddLine("Bad float END");
return false;
shell.WriteLine("Bad float END");
return;
}
if (xStart == xEnd)
{
console.AddLine("Scale cannot be zero, as this would cause a division by zero in AtmosDebugOverlay.");
return false;
shell.WriteLine("Scale cannot be zero, as this would cause a division by zero in AtmosDebugOverlay.");
return;
}
var sys = EntitySystem.Get<AtmosDebugOverlaySystem>();
sys.CfgBase = xStart;
sys.CfgScale = xEnd - xStart;
return false;
}
}
@@ -48,17 +47,17 @@ namespace Content.Client.Commands
public string Command => "atvmode";
public string Description => "Sets the atmos debug mode. This will automatically reset the scale.";
public string Help => "atvmode <TotalMoles/GasMoles/Temperature> [<gas ID (for GasMoles)>]";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
if (args.Length < 1)
{
console.AddLine(Help);
return false;
shell.WriteLine(Help);
return;
}
if (!Enum.TryParse<AtmosDebugOverlayMode>(args[0], out var xMode))
{
console.AddLine("Invalid mode");
return false;
shell.WriteLine("Invalid mode");
return;
}
int xSpecificGas = 0;
float xBase = 0;
@@ -67,21 +66,21 @@ namespace Content.Client.Commands
{
if (args.Length != 2)
{
console.AddLine("A target gas must be provided for this mode.");
return false;
shell.WriteLine("A target gas must be provided for this mode.");
return;
}
if (!AtmosCommandUtils.TryParseGasID(args[1], out xSpecificGas))
{
console.AddLine("Gas ID not parsable or out of range.");
return false;
shell.WriteLine("Gas ID not parsable or out of range.");
return;
}
}
else
{
if (args.Length != 1)
{
console.AddLine("No further information is required for this mode.");
return false;
shell.WriteLine("No further information is required for this mode.");
return;
}
if (xMode == AtmosDebugOverlayMode.Temperature)
{
@@ -95,7 +94,6 @@ namespace Content.Client.Commands
sys.CfgSpecificGas = xSpecificGas;
sys.CfgBase = xBase;
sys.CfgScale = xScale;
return false;
}
}
@@ -105,21 +103,20 @@ namespace Content.Client.Commands
public string Command => "atvcbm";
public string Description => "Changes from red/green/blue to greyscale";
public string Help => "atvcbm <true/false>";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
if (args.Length != 1)
{
console.AddLine(Help);
return false;
shell.WriteLine(Help);
return;
}
if (!bool.TryParse(args[0], out var xFlag))
{
console.AddLine("Invalid flag");
return false;
shell.WriteLine("Invalid flag");
return;
}
var sys = EntitySystem.Get<AtmosDebugOverlaySystem>();
sys.CfgCBM = xFlag;
return false;
}
}
}

View File

@@ -1,6 +1,6 @@
using Content.Client.UserInterface;
using JetBrains.Annotations;
using Robust.Client.Interfaces.Console;
using Robust.Shared.Console;
namespace Content.Client.Commands
{
@@ -11,10 +11,9 @@ namespace Content.Client.Commands
public string Description => "Opens the credits window";
public string Help => "credits";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
new CreditsWindow().Open();
return false;
}
}
}

View File

@@ -1,6 +1,6 @@
using Content.Client.GameObjects.EntitySystems.AI;
using JetBrains.Annotations;
using Robust.Client.Interfaces.Console;
using Robust.Shared.Console;
using Robust.Shared.GameObjects.Systems;
namespace Content.Client.Commands
@@ -16,12 +16,13 @@ namespace Content.Client.Commands
public string Description => "Handles all tooltip debugging above AI mobs";
public string Help => "debugai [hide/paths/thonk]";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
#if DEBUG
if (args.Length < 1)
{
return true;
shell.RemoteExecuteCommand(argStr);
return;
}
var anyAction = false;
@@ -50,9 +51,10 @@ namespace Content.Client.Commands
}
}
return !anyAction;
if(!anyAction)
shell.RemoteExecuteCommand(argStr);
#else
return true;
shell.RemoteExecuteCommand(argStr);
#endif
}
}

View File

@@ -1,9 +1,10 @@
using System;
using Content.Client.GameObjects.Components;
using Content.Client.GameObjects.EntitySystems;
using Content.Client.Interfaces;
using Content.Shared.GameObjects;
using Robust.Client.Interfaces.Console;
using Robust.Client.Interfaces.GameObjects.Components;
using Robust.Shared.Console;
using Robust.Shared.GameObjects.Systems;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.IoC;
@@ -17,12 +18,10 @@ namespace Content.Client.Commands
public string Description => "Toggles visibility of markers such as spawn points.";
public string Help => "";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
EntitySystem.Get<MarkerSystem>()
.MarkersVisible ^= true;
return false;
}
}
@@ -33,12 +32,10 @@ namespace Content.Client.Commands
public string Description => "Makes entities below the floor always visible.";
public string Help => $"Usage: {Command}";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
EntitySystem.Get<SubFloorHideSystem>()
.EnableAll ^= true;
return false;
}
}
@@ -49,7 +46,7 @@ namespace Content.Client.Commands
public string Description => "Makes entities below the floor always visible until the client is restarted.";
public string Help => $"Usage: {Command}";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
EntitySystem.Get<SubFloorHideSystem>()
.EnableAll = true;
@@ -64,8 +61,6 @@ namespace Content.Client.Commands
sprite.DrawDepth = (int) DrawDepth.Overlays;
}
}
return false;
}
}
@@ -75,14 +70,12 @@ namespace Content.Client.Commands
public string Description => "Send a notify client side.";
public string Help => "notify <message>";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
var message = args[0];
var notifyManager = IoCManager.Resolve<IClientNotifyManager>();
notifyManager.PopupMessage(message);
return false;
}
}
@@ -92,18 +85,18 @@ namespace Content.Client.Commands
public string Description => "Creates and teleports you to a new uninitialized map for mapping.";
public string Help => $"Usage: {Command} <mapname> / {Command} <id> <mapname>";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
if (args.Length == 0)
{
console.AddLine(Help);
return false;
shell.WriteLine(Help);
return;
}
console.Commands["togglelight"].Execute(console);
console.Commands["showsubfloorforever"].Execute(console);
shell.ConsoleHost.RegisteredCommands["togglelight"].Execute(shell, string.Empty, Array.Empty<string>());
shell.ConsoleHost.RegisteredCommands["showsubfloorforever"].Execute(shell, string.Empty, Array.Empty<string>());
return true;
shell.RemoteExecuteCommand(argStr);
}
}
}

View File

@@ -1,6 +1,6 @@
using Content.Client.GameObjects.EntitySystems.AI;
using JetBrains.Annotations;
using Robust.Client.Interfaces.Console;
using Robust.Shared.Console;
using Robust.Shared.GameObjects.Systems;
namespace Content.Client.Commands
@@ -13,12 +13,13 @@ namespace Content.Client.Commands
public string Description => "Toggles visibility of pathfinding debuggers.";
public string Help => "pathfinder [hide/nodes/routes/graph/regioncache/regions]";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
#if DEBUG
if (args.Length < 1)
{
return true;
shell.RemoteExecuteCommand(argStr);
return;
}
var anyAction = false;
@@ -63,9 +64,10 @@ namespace Content.Client.Commands
}
}
return !anyAction;
if(!anyAction)
shell.RemoteExecuteCommand(argStr);
#else
return true;
shell.RemoteExecuteCommand(argStr);
#endif
}
}

View File

@@ -1,7 +1,7 @@
using Content.Shared.GameObjects.Components.Body.Mechanism;
using Robust.Client.Console;
using Robust.Client.GameObjects;
using Robust.Client.Interfaces.Console;
using Robust.Shared.Console;
using Robust.Shared.Containers;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.IoC;
@@ -14,7 +14,7 @@ namespace Content.Client.Commands
public string Description => $"Reverts the effects of {ShowMechanismsCommand.CommandName}";
public string Help => $"{Command}";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
var componentManager = IoCManager.Resolve<IComponentManager>();
var mechanisms = componentManager.EntityQuery<IMechanism>();
@@ -41,9 +41,7 @@ namespace Content.Client.Commands
}
}
IoCManager.Resolve<IClientConsole>().ProcessCommand("hidecontainedcontext");
return false;
IoCManager.Resolve<IClientConsoleHost>().ExecuteCommand("hidecontainedcontext");
}
}
}

View File

@@ -1,7 +1,7 @@
using Content.Shared.GameObjects.Components.Body.Mechanism;
using Robust.Client.Console;
using Robust.Client.GameObjects;
using Robust.Client.Interfaces.Console;
using Robust.Shared.Console;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.IoC;
@@ -16,7 +16,7 @@ namespace Content.Client.Commands
public string Description => "Makes mechanisms visible, even when they shouldn't be.";
public string Help => $"{Command}";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
var componentManager = IoCManager.Resolve<IComponentManager>();
var mechanisms = componentManager.EntityQuery<IMechanism>();
@@ -29,9 +29,7 @@ namespace Content.Client.Commands
}
}
IoCManager.Resolve<IClientConsole>().ProcessCommand("showcontainedcontext");
return false;
IoCManager.Resolve<IClientConsoleHost>().ExecuteCommand("showcontainedcontext");
}
}
}

View File

@@ -1,5 +1,5 @@
using Content.Shared;
using Robust.Client.Interfaces.Console;
using Robust.Shared.Console;
using Robust.Shared.Interfaces.Configuration;
using Robust.Shared.IoC;
@@ -13,16 +13,14 @@ namespace Content.Client.Commands
public string Help => "";
public bool Execute(IDebugConsole console, params string[] args)
public void Execute(IConsoleShell shell, string argStr, string[] args)
{
var configurationManager = IoCManager.Resolve<IConfigurationManager>();
var cvar = CCVars.OutlineEnabled;
var old = configurationManager.GetCVar(cvar);
configurationManager.SetCVar(cvar, !old);
console.AddLine($"Draw outlines set to: {configurationManager.GetCVar(cvar)}");
return false;
shell.WriteLine($"Draw outlines set to: {configurationManager.GetCVar(cvar)}");
}
}
}