Skip to content

Commit

Permalink
Add a way for bulk abstracting prototypes (#24140)
Browse files Browse the repository at this point in the history
* Ignored Prototypes

* respath it

* add multi-file support
  • Loading branch information
EmoGarbage404 authored Jan 17, 2024
1 parent b0e7a6d commit 1ed71f5
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 5 deletions.
59 changes: 54 additions & 5 deletions Content.Shared/Entry/EntryPoint.cs
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
using Content.Shared.CCVar;
using Content.Shared.Chemistry.Reaction;
using Content.Shared.Chemistry.Reagent;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using Content.Shared.Humanoid.Markings;
using Content.Shared.IoC;
using Content.Shared.Localizations;
using Content.Shared.Maps;
using Robust.Shared;
using Robust.Shared.Configuration;
using Robust.Shared.ContentPack;
using Robust.Shared.Map;
using Robust.Shared.Network;
using Robust.Shared.Prototypes;
using Robust.Shared.Serialization.Markdown;
using Robust.Shared.Serialization.Markdown.Sequence;
using Robust.Shared.Serialization.Markdown.Value;
using Robust.Shared.Utility;

namespace Content.Shared.Entry
{
public sealed class EntryPoint : GameShared
{
[Dependency] private readonly IPrototypeManager _prototypeManager = default!;
[Dependency] private readonly ITileDefinitionManager _tileDefinitionManager = default!;
[Dependency] private readonly IResourceManager _resMan = default!;

private readonly ResPath _ignoreFileDirectory = new("/IgnoredPrototypes/");

public override void PreInit()
{
Expand All @@ -32,6 +37,7 @@ public override void Shutdown()

public override void Init()
{
IgnorePrototypes();
}

public override void PostInit()
Expand Down Expand Up @@ -96,5 +102,48 @@ private void PrototypeReload(PrototypesReloadedEventArgs obj)
def.AssignTileId(_tileDefinitionManager[def.ID].TileId);
}
}

private void IgnorePrototypes()
{
if (!TryReadFile(out var sequences))
return;

foreach (var sequence in sequences)
{
foreach (var node in sequence.Sequence)
{
var path = new ResPath(((ValueDataNode) node).Value);

if (string.IsNullOrEmpty(path.Extension))
{
_prototypeManager.AbstractDirectory(path);
}
else
{
_prototypeManager.AbstractFile(path);
}
}
}
}

private bool TryReadFile([NotNullWhen(true)] out List<SequenceDataNode>? sequence)
{
sequence = new();

foreach (var path in _resMan.ContentFindFiles(_ignoreFileDirectory))
{
if (!_resMan.TryContentFileRead(path, out var stream))
continue;

using var reader = new StreamReader(stream, EncodingHelpers.UTF8);
var documents = DataNodeParser.ParseYamlStream(reader).FirstOrDefault();

if (documents == null)
continue;

sequence.Add((SequenceDataNode) documents.Root);
}
return true;
}
}
}
8 changes: 8 additions & 0 deletions Resources/IgnoredPrototypes/ignoredPrototypes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# This is a basic list that specifies files for which the prototypes inside of them will be made abstract.
# This supports all prototype kinds and is intended to allow servers to remove prototypes in a relatively clean way.
# This method does not break inheritance, but you will still have to remove usages.

# e.g., you can specify both directories and specific files by adding lines like:
#
# - /Prototypes/Guidebook
# - /Prototypes/Catalog/uplink_catalog.yml

0 comments on commit 1ed71f5

Please sign in to comment.