themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Merge pull request #2576 from SignatureBeef/otapi3

Browse source 
Reduce status text spam (e.g. load/save world)
This commit is contained in:
Chris 2022-03-11 18:58:39 +10:30 • committed by GitHub
commit e7f05415c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 211 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -12,6 +12,9 @@ This is the rolling changelog for TShock for Terraria. Use past tense when addin
* Do not forget to sign every line you change with your name. (@hakusaro)
* If there is no section called "Upcoming changes" below this line, please add one with `## Upcoming changes` as the first line, and then a bulleted item directly after with the first change.
## Upcoming changes (TShock 5.0.0)
* Reduced load/save console spam. (@SignatureBeef, @YehnBeep)
## Upcoming changes
## TShock 4.5.15

34
TShockAPI/Modules/Module.cs Normal file
View file

@ -0,0 +1,34 @@
/*
TShock, a server mod for Terraria
Copyright (C) 2011-2019 Pryaxis & TShock Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
using System;
namespace TShockAPI.Modules
{
public abstract class Module : IDisposable
{
/// <summary>
/// Entry point of the module
/// </summary>
public abstract void Initialise();
/// <summary>
/// Resource cleanup, e.g. hooks and events
/// </summary>
public virtual void Dispose() { }
}
}

101
TShockAPI/Modules/ModuleManager.cs Normal file
View file

@ -0,0 +1,101 @@
/*
TShock, a server mod for Terraria
Copyright (C) 2011-2019 Pryaxis & TShock Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
namespace TShockAPI.Modules
{
public class ModuleManager : IDisposable
{
private List<Module> _modules = new();
/// <summary>
/// Discovers <see cref="Module"/> derived classes from across the assembly
/// </summary>
/// <returns>Type definitions of the modules that can be created</returns>
IEnumerable<Type> CollectModules() => Assembly.GetExecutingAssembly()
.GetTypes()
.Where(t => typeof(Module).IsAssignableFrom(t) && !t.IsAbstract)
;
/// <summary>
/// Initialises <see cref="Module"/> derived classes defined across the assembly
/// </summary>
/// <param name="parameters">Additional constructor arguments allowed for modules</param>
public void Initialise(object[] parameters)
{
foreach (var moduleType in CollectModules())
InitialiseModule(moduleType, parameters);
}
/// <summary>
/// Initialises a module by its type definition
/// </summary>
/// <param name="moduleType">The type of the module</param>
/// <param name="parameters">Additional constructor arguments allowed for modules</param>
public void InitialiseModule(Type moduleType, object[] parameters)
{
if (!typeof(Module).IsAssignableFrom(moduleType))
throw new NotSupportedException($"Cannot load module {moduleType.FullName} as it does not derive from {typeof(Module).FullName}");
var args = new List<object>();
ConstructorInfo constructor = null;
foreach (var ctor in moduleType.GetConstructors())
{
args.Clear();
var ctorParams = ctor.GetParameters();
foreach (var prm in ctorParams)
{
var matching_objects = parameters.Where(p => prm.ParameterType.IsAssignableFrom(p.GetType()));
if (matching_objects.Count() == 1)
args.Add(matching_objects.Single());
else
{
// skip this ctor since we cannot find a suitable parameter for it.
break;
}
}
if (args.Count() == ctorParams.Length)
constructor = ctor;
}
if (constructor is not null)
{
var module = (Module)constructor.Invoke(args.ToArray());
_modules.Add(module);
module.Initialise();
}
}
/// <summary>
/// Disposes of the module and the manager instance
/// </summary>
public void Dispose()
{
foreach (var module in _modules)
module.Dispose();
_modules.Clear();
}
}
}

66
TShockAPI/Modules/ReduceConsoleSpam.cs Normal file
View file

@ -0,0 +1,66 @@
/*
TShock, a server mod for Terraria
Copyright (C) 2011-2019 Pryaxis & TShock Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
using System;
namespace TShockAPI.Modules
{
public class ReduceConsoleSpam : Module
{
public override void Initialise() =>
OTAPI.Hooks.Main.StatusTextChange += OnMainStatusTextChange;
public override void Dispose() =>
OTAPI.Hooks.Main.StatusTextChange -= OnMainStatusTextChange;
/// <summary>
/// Holds the last status text value, to determine if there is a suitable change to report.
/// </summary>
private string _lastStatusText = null;
/// <summary>
/// Aims to reduce the amount of console spam by filtering out load/save progress
/// </summary>
/// <param name="sender"></param>
/// <param name="e">OTAPI event</param>
private void OnMainStatusTextChange(object sender, OTAPI.Hooks.Main.StatusTextChangeArgs e)
{
bool replace(string text)
{
if (e.Value.StartsWith(text))
{
var segment = e.Value.Substring(0, text.Length);
if (_lastStatusText != segment)
{
Console.WriteLine(segment); // write it manually instead of terraria which causes double writes
_lastStatusText = segment;
}
e.Value = "";
return true;
}
return false;
}
_ = replace("Resetting game objects")
|| replace("Settling liquids")
|| replace("Loading world data")
|| replace("Saving world data")
|| replace("Validating world save");
}
}
}

7
TShockAPI/TShock.cs
View file

@ -46,6 +46,7 @@ using TShockAPI.Localization;
using TShockAPI.Configuration;
using Terraria.GameContent.Creative;
using System.Runtime.InteropServices;
using TShockAPI.Modules;
namespace TShockAPI
{
@ -149,6 +150,8 @@ namespace TShockAPI
/// </summary>
public static event Action Initialized;
public static ModuleManager ModuleManager { get; } = new ModuleManager();
/// <summary>Version - The version required by the TerrariaAPI to be passed back for checking &amp; loading the plugin.</summary>
/// <value>value - The version number specified in the Assembly, based on the VersionNum variable set in this class.</value>
public override Version Version
@ -421,6 +424,8 @@ namespace TShockAPI
EnglishLanguage.Initialize();
ModuleManager.Initialise(new object[] { this });
if (Config.Settings.RestApiEnabled)
RestApi.Start();
@ -463,6 +468,8 @@ namespace TShockAPI
}
SaveManager.Instance.Dispose();
ModuleManager.Dispose();
ServerApi.Hooks.GamePostInitialize.Deregister(this, OnPostInit);
ServerApi.Hooks.GameUpdate.Deregister(this, OnUpdate);
ServerApi.Hooks.GameHardmodeTileUpdate.Deregister(this, OnHardUpdate);