Serialization v3 content PR (#3491)

* serv3 in shared pt 1

* beginning of deepclone api

* progress in implementing ideepclone & serv3 in content

* adds target

* its cant hurt you it cant hurt you

* more changes to content.server

* adds dataclasses

* almost there

* renamed & edited entry

* finishes refactoring content to use serv3

* gasmixture runtimes, next: reagentunit

* fucin hell that was an annoying one

* adds flags

* fixes some yaml errors

* removes comment

* fixes generic components for now

* removes todo
actually clones values my god paul
fixes bug involving resolving custom data classes from other proj
renames dataclass
fixes spritecomp
adds WithFormat.Constants support

* adds deepclone to ResistanceSet

* adds a bunch of deepclone implementations
adds a deepclone analyzer (TODO)
adds a deep clone fallback for classes & structs

* fixes a bunch of runtimes

* adds deepclone to entityuid

* adds generator to sln

* gets rid of warnings

* fixes

* argh

* componentdata refactors

* more deepclone impl

* heck me i reworked all of content deepclone

* renames custom dataclasstarget

* misc

* reworks prototypes

* deepclone nuke

* renamed customdataclass attribute

* fixes everything

* misc fixed

* the killcommit

* getting there

* changed yamlfieldattribute namespace

* adds back iselfserialize

* renames everything to data(field/definition)

* ouch

* Fix most errors on content

* Fix more errors in content

* Fix some components

* work on tests

* fixes some customdataclasses

* fuggin shit

* yes

* yeas

* Remove data classes

* Data field naming fixes

* arg

* Git resetti RobustToolbox

* Merge fixes

* General fixes

* Fix startup serialization errors

* Fix DamageContainerPrototype when supported classes or types are null

* Implement construction graph step type serializer

* Fix up construction serialization

* Fix up construction serialization part 2

* Fix null list in technology database component

* Fix body serialization

* Fix entity storage serialization

* Fix actions serialization

* Fix AI serialization

* Fix reaction serialization

* Fix body serialization

* Fix grid atmosphere serialization

* Rename IServ3Manager to ISerializationManager

* Convert every non generic serializer to the new format, general fixes

* Serialization and body system fix

* pushinheritance fix

* Update all prototypes to have a parent and have consistent id/parent properties

* Merge fixes

* smh my head

* cuddling slaps

* Content commit for engine PR

* stuff

* more fixes

* argh

* yes even you are fixed

* changelog fixes

* fixes seeds

* argh

* Test fixes

* Add writing for alert order prototype

* Fix alert order writing

* FIX

* its been alot ok

* Fix the rest of the visualizers

* Fix server alerts component tests

* Fix alert prototype tests not using the read value

* Fix alert prototype tests initializing serialization multiple times

* THIS IS AN AMERICAN CODEBASE GOD BLESS THE USA

* Add ImplicitDataDefinitionForInheritors to IMechanismBehavior
Fixes the behaviors not being found

* Fix NRE in strap component
Good night to the 1 buckle optimization

* Fix clothing component slot flags serialization tag

* Fix body component in all components test

* Merge fixes

* ffs

* Make construction graph prototype use serialization hooks

* human yaml linted

* a

* Do the thing for construction

* stuff

* a

* monke see yaml linter

* LINT HARDER

* Remove redundant todo

* yes

* Add skip hook argument to readers and copiers

* we gamin

* test/datafield fixes

* adds more verbose validation

* moves linter to action

* Improve construction graph step type serializer error message

* Fix ammo box component NRE

* gamin

* some updates to the linter

* yes

* removes that test

* misc fixes

* array fix
priority fix
misc fixes

* adds proper info the validation

* adds alwaysrelevant usa

* Make yaml linter take half as long to run (~50% less)

* Make yaml linter 5 times faster (~80% less execution time)

* based vera being based

* fixes mapsaving

* warning cleanup & moves surpressor

* removes old msbuild targets

* Revert "Make yaml linter 5 times faster (~80% less execution time)"

This reverts commit 3e6091359a26252c3e98828199553de668031c63.

* Add -nowarn to yaml linter run configuration

* Improve yaml linter message feedback

* Make dependencies an argument instead of a property on the serialization manager

* yamllinting slaps

* Clean up type serializers

* Move yaml linter code to its own method

* Fix yaml errors

* Change yaml linter action name and remove -nowarn

* yaml linter please shut

* Git resetti robust toolbox

Co-authored-by: Paul <ritter.paul1+git@googlemail.com>
Co-authored-by: DrSmugleaf <DrSmugleaf@users.noreply.github.com>
This commit is contained in:
Paul Ritter
2021-03-05 01:08:38 +01:00
committed by GitHub
parent 05d4d9692c
commit 5c50b1f6ed
545 changed files with 4547 additions and 6650 deletions

View File

@@ -1,21 +1,21 @@
#nullable enable
using Content.Shared.Interfaces.Chemistry;
using Robust.Shared.GameObjects;
using Robust.Shared.Serialization;
using Robust.Shared.Serialization.Manager.Attributes;
namespace Content.Shared.Chemistry
{
//Default metabolism for reagents. Metabolizes the reagent with no effects
/// <summary>
/// Default metabolism for reagents. Metabolizes the reagent with no effects
/// </summary>
[DataDefinition]
public class DefaultMetabolizable : IMetabolizable
{
//Rate of metabolism in units / second
private double _metabolismRate = 1;
public double MetabolismRate => _metabolismRate;
void IExposeData.ExposeData(ObjectSerializer serializer)
{
serializer.DataField(ref _metabolismRate, "rate", 1);
}
/// <summary>
/// Rate of metabolism in units / second
/// </summary>
[DataField("rate")]
public double MetabolismRate { get; set; } = 1;
ReagentUnit IMetabolizable.Metabolize(IEntity solutionEntity, string reagentId, float tickTime)
{

View File

@@ -1,12 +1,11 @@
#nullable enable
using System;
using System.Collections.Generic;
using Content.Server.Interfaces.Chemistry;
using Content.Shared.Interfaces;
using Content.Shared.Interfaces.Chemistry;
using Robust.Shared.IoC;
using Robust.Shared.Prototypes;
using Robust.Shared.Serialization;
using YamlDotNet.RepresentationModel;
using Robust.Shared.Serialization.Manager.Attributes;
using Robust.Shared.ViewVariables;
namespace Content.Shared.Chemistry
{
@@ -16,14 +15,21 @@ namespace Content.Shared.Chemistry
[Prototype("reaction")]
public class ReactionPrototype : IPrototype
{
private string _id = default!;
private string _name = default!;
private Dictionary<string, ReactantPrototype> _reactants = default!;
private Dictionary<string, ReagentUnit> _products = default!;
private IReactionEffect[] _effects = default!;
[DataField("reactants")] private Dictionary<string, ReactantPrototype> _reactants = new();
[DataField("products")] private Dictionary<string, ReagentUnit> _products = new();
[DataField("effects", serverOnly: true)] private List<IReactionEffect> _effects = new();
[ViewVariables]
[field: DataField("id", required: true)]
public string ID { get; } = default!;
[ViewVariables]
[field: DataField("parent")]
public string? Parent { get; }
[field: DataField("name")]
public string Name { get; } = string.Empty;
public string ID => _id;
public string Name => _name;
/// <summary>
/// Reactants required for the reaction to occur.
/// </summary>
@@ -37,39 +43,19 @@ namespace Content.Shared.Chemistry
/// </summary>
public IReadOnlyList<IReactionEffect> Effects => _effects;
public string? Sound { get; private set; }
[Dependency] private readonly IModuleManager _moduleManager = default!;
public void LoadFrom(YamlMappingNode mapping)
{
var serializer = YamlObjectSerializer.NewReader(mapping);
serializer.DataField(ref _id, "id", string.Empty);
serializer.DataField(ref _name, "name", string.Empty);
serializer.DataField(ref _reactants, "reactants", new Dictionary<string, ReactantPrototype>());
serializer.DataField(ref _products, "products", new Dictionary<string, ReagentUnit>());
serializer.DataField(this, x => x.Sound, "sound", "/Audio/Effects/Chemistry/bubbles.ogg");
if (_moduleManager.IsServerModule)
{
//TODO: Don't have a check for if this is the server
//Some implementations of IReactionEffect can't currently be moved to shared, so this is here to prevent the client from breaking when reading server-only IReactionEffects.
serializer.DataField(ref _effects, "effects", Array.Empty<IReactionEffect>());
}
else
{
_effects = Array.Empty<IReactionEffect>(); //To ensure _effects isn't null since it is only serializable on the server right snow
}
}
// TODO SERV3: Empty on the client, (de)serialize on the server with module manager is server module
[DataField("sound", serverOnly: true)] public string? Sound { get; private set; } = "/Audio/Effects/Chemistry/bubbles.ogg";
}
/// <summary>
/// Prototype for chemical reaction reactants.
/// </summary>
public class ReactantPrototype : IExposeData
[DataDefinition]
public class ReactantPrototype
{
private ReagentUnit _amount;
[DataField("amount")]
private ReagentUnit _amount = ReagentUnit.New(1);
[DataField("catalyst")]
private bool _catalyst;
/// <summary>
@@ -80,11 +66,5 @@ namespace Content.Shared.Chemistry
/// Whether or not the reactant is a catalyst. Catalysts aren't removed when a reaction occurs.
/// </summary>
public bool Catalyst => _catalyst;
void IExposeData.ExposeData(ObjectSerializer serializer)
{
serializer.DataField(ref _amount, "amount", ReagentUnit.New(1));
serializer.DataField(ref _catalyst, "catalyst", false);
}
}
}

View File

@@ -1,86 +1,72 @@
#nullable enable
using System;
using System.Collections.Generic;
using Content.Shared.Interfaces;
using Content.Shared.Interfaces.Chemistry;
using Content.Shared.Interfaces.GameObjects.Components;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.Map;
using Robust.Shared.Maths;
using Robust.Shared.Prototypes;
using Robust.Shared.Serialization;
using YamlDotNet.RepresentationModel;
using Robust.Shared.Serialization.Manager.Attributes;
using Robust.Shared.ViewVariables;
namespace Content.Shared.Chemistry
{
[Prototype("reagent")]
[DataDefinition]
public class ReagentPrototype : IPrototype
{
[Dependency] private readonly IModuleManager _moduleManager = default!;
[DataField("metabolism", serverOnly: true)]
private readonly List<IMetabolizable> _metabolism = new() {new DefaultMetabolizable()};
private string _id = default!;
private string _name = default!;
private string _description = default!;
private string _physicalDescription = default!;
private Color _substanceColor;
private string _spritePath = default!;
private List<IMetabolizable> _metabolism = default!;
private List<ITileReaction> _tileReactions = default!;
private List<IPlantMetabolizable> _plantMetabolism = default!;
private float _customPlantMetabolism;
private bool _toxin;
private int _boozePower;
[DataField("tileReactions", serverOnly: true)]
private readonly List<ITileReaction> _tileReactions = new(0);
public string ID => _id;
public string Name => _name;
public string Description => _description;
public string PhysicalDescription => _physicalDescription;
public Color SubstanceColor => _substanceColor;
[DataField("plantMetabolism", serverOnly: true)]
private readonly List<IPlantMetabolizable> _plantMetabolism = new(0);
public bool Toxin => _toxin;
public int BoozePower => _boozePower;
[DataField("customPlantMetabolism")]
private readonly float _customPlantMetabolism = 1f;
[ViewVariables]
[field: DataField("id", required: true)]
public string ID { get; } = default!;
[ViewVariables]
[field: DataField("parent")]
public string? Parent { get; }
[field: DataField("name")]
public string Name { get; } = string.Empty;
[field: DataField("desc")]
public string Description { get; } = string.Empty;
[field: DataField("physicalDesc")]
public string PhysicalDescription { get; } = string.Empty;
[field: DataField("color")]
public Color SubstanceColor { get; } = Color.White;
[field: DataField("toxin")]
public bool Toxin { get; }
[field: DataField("boozePower")]
public int BoozePower { get; }
[field: DataField("boilingPoint")]
public float? BoilingPoint { get; }
[field: DataField("meltingPoint")]
public float? MeltingPoint { get; }
[field: DataField("spritePath")]
public string SpriteReplacementPath { get; } = string.Empty;
//List of metabolism effects this reagent has, should really only be used server-side.
public IReadOnlyList<IMetabolizable> Metabolism => _metabolism;
public IReadOnlyList<ITileReaction> TileReactions => _tileReactions;
public IReadOnlyList<IPlantMetabolizable> PlantMetabolism => _plantMetabolism;
public string SpriteReplacementPath => _spritePath;
public ReagentPrototype()
{
IoCManager.InjectDependencies(this);
}
public void LoadFrom(YamlMappingNode mapping)
{
var serializer = YamlObjectSerializer.NewReader(mapping);
serializer.DataField(ref _id, "id", string.Empty);
serializer.DataField(ref _name, "name", string.Empty);
serializer.DataField(ref _description, "desc", string.Empty);
serializer.DataField(ref _physicalDescription, "physicalDesc", string.Empty);
serializer.DataField(ref _substanceColor, "color", Color.White);
serializer.DataField(ref _spritePath, "spritePath", string.Empty);
serializer.DataField(ref _customPlantMetabolism, "customPlantMetabolism", 1f);
serializer.DataField(ref _toxin, "toxin", false);
serializer.DataField(ref _boozePower, "boozePower", 0);
if (_moduleManager.IsServerModule)
{
//Implementations of the needed interfaces are currently server-only, so they cannot be read on client
serializer.DataField(ref _metabolism, "metabolism", new List<IMetabolizable> { new DefaultMetabolizable() });
serializer.DataField(ref _tileReactions, "tileReactions", new List<ITileReaction> { });
serializer.DataField(ref _plantMetabolism, "plantMetabolism", new List<IPlantMetabolizable> { });
}
else
{
//ensure the following fields cannot null since they can only be serialized on server right now
_metabolism = new List<IMetabolizable> { new DefaultMetabolizable() };
_tileReactions = new();
_plantMetabolism = new();
}
}
/// <summary>
/// If the substance color is too dark we user a lighter version to make the text color readable when the user examines a solution.
@@ -100,7 +86,7 @@ namespace Content.Shared.Chemistry
return SubstanceColor;
}
public ReagentUnit ReactionEntity(IEntity entity, ReactionMethod method, ReagentUnit reactVolume)
public ReagentUnit ReactionEntity(IEntity? entity, ReactionMethod method, ReagentUnit reactVolume)
{
var removed = ReagentUnit.Zero;
@@ -153,7 +139,7 @@ namespace Content.Shared.Chemistry
return removed;
}
public void ReactionPlant(IEntity plantHolder)
public void ReactionPlant(IEntity? plantHolder)
{
if (plantHolder == null || plantHolder.Deleted)
return;

View File

@@ -10,6 +10,7 @@ using Robust.Shared.IoC;
using Robust.Shared.Maths;
using Robust.Shared.Prototypes;
using Robust.Shared.Serialization;
using Robust.Shared.Serialization.Manager.Attributes;
using Robust.Shared.Utility;
using Robust.Shared.ViewVariables;
@@ -19,10 +20,12 @@ namespace Content.Shared.Chemistry
/// A solution of reagents.
/// </summary>
[Serializable, NetSerializable]
public class Solution : IExposeData, IEnumerable<Solution.ReagentQuantity>
[DataDefinition]
public class Solution : IEnumerable<Solution.ReagentQuantity>, ISerializationHooks
{
// Most objects on the station hold only 1 or 2 reagents
[ViewVariables]
[DataField("reagents")]
private List<ReagentQuantity> _contents = new(2);
public IReadOnlyList<ReagentQuantity> Contents => _contents;
@@ -50,19 +53,10 @@ namespace Content.Shared.Chemistry
AddReagent(reagentId, quantity);
}
/// <inheritdoc />
void IExposeData.ExposeData(ObjectSerializer serializer)
void ISerializationHooks.AfterDeserialization()
{
serializer.DataReadWriteFunction(
"reagents",
new List<ReagentQuantity>(),
quantities =>
{
_contents = quantities;
TotalVolume = ReagentUnit.New(0);
quantities.ForEach(reagent => TotalVolume += reagent.Quantity);
},
() => _contents);
TotalVolume = ReagentUnit.Zero;
_contents.ForEach(reagent => TotalVolume += reagent.Quantity);
}
public bool ContainsReagent(string reagentId)
@@ -333,9 +327,12 @@ namespace Content.Shared.Chemistry
}
[Serializable, NetSerializable]
[DataDefinition]
public readonly struct ReagentQuantity: IComparable<ReagentQuantity>
{
[DataField("ReagentId")]
public readonly string ReagentId;
[DataField("Quantity")]
public readonly ReagentUnit Quantity;
public ReagentQuantity(string reagentId, ReagentUnit quantity)