tommy/tbd-station-14
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

De-hardcode chemical metabolism of StomachComponent (#437)

Browse Source 
* Move chemical reaction effects into Chemistry/ReactionEffects/ subfolder

* Replace hardcoded StomachComponent metabolism with IMetabolizable

The benefits of this approach are that reagent metabolism effects are not hardcoded into StomachComponent, and metabolism effects can be more easily chained together in yaml prototypes, and reagents can have different metabolism rates. One problem with this approach is that getting metabolism rates slower than 1u / second is impossible. Implementing #377 should resolve that problem.

* Fix DefaultFood and DefaultDrink so they remove reagent regardless of Hunger/ThirstComponent presence

Previously if neither of those were present the reagents wouldn't be removed from the stomach. This fixes that.

* Additional comment on function

* Make metabolizer interface implementations explicit

Also removed some unused using statements

* Make StomachComponent._reagentDeltas readonly

* Fix misleading variable names and docs for metabolizables

Changes one of the arguments for `IMetabolizable.Metabolize()` to be called `tickTime` instead of `frameTime` to more accurately reflect it's purpose. It's not really the frametime, but the time since the last metabolism tick. Also updated and expanded the docs to reflect this and to be more clear.
This commit is contained in:
moneyl
2019-11-21 17:24:19 -05:00
committed by Pieter-Jan Briers
parent 1f177a044d
commit 3ab8036363
11 changed files with 213 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
Content.Server/GameObjects/Components/Nutrition/StomachComponent.cs
View File

@@ -1,7 +1,11 @@
using System.Collections.Generic;
using Content.Server.GameObjects.Components.Chemistry;
using Content.Server.GameObjects.EntitySystems;
using Content.Shared.Chemistry;
using Content.Shared.GameObjects.Components.Nutrition;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.Prototypes;
using Robust.Shared.Serialization;
using Robust.Shared.ViewVariables;
@@ -10,43 +14,35 @@ namespace Content.Server.GameObjects.Components.Nutrition
[RegisterComponent]
public class StomachComponent : SharedStomachComponent
{
// Essentially every time it ticks it'll pull out the MetabolisationAmount of reagents and process them.
// Generic food goes under "nutriment" like SS13
// There's also separate hunger and thirst components which means you can have a stomach
// but not require food / water.
public static readonly int NutrimentFactor = 30;
public static readonly int HydrationFactor = 30;
public static readonly int MetabolisationAmount = 5;
#pragma warning disable 649
[Dependency] private readonly IPrototypeManager _prototypeManager;
#pragma warning restore 649
[ViewVariables(VVAccess.ReadOnly)]
private SolutionComponent _stomachContents;
public float MetaboliseDelay => _metaboliseDelay;
[ViewVariables]
private float _metaboliseDelay; // How long between metabolisation for 5 units
public int MaxVolume
{
get => _stomachContents.MaxVolume;
set => _stomachContents.MaxVolume = value;
}
private float _metabolisationCounter = 0.0f;
private int _initialMaxVolume;
//Used to track changes to reagent amounts during metabolism
private readonly Dictionary<string, int> _reagentDeltas = new Dictionary<string, int>();
public override void ExposeData(ObjectSerializer serializer)
{
base.ExposeData(serializer);
serializer.DataField(ref _metaboliseDelay, "metabolise_delay", 6.0f);
serializer.DataField(ref _initialMaxVolume, "max_volume", 20);
}
public override void Initialize()
{
base.Initialize();
// Shouldn't add to Owner to avoid cross-contamination (e.g. with blood or whatever they made hold other solutions)
//Doesn't use Owner.AddComponent<>() to avoid cross-contamination (e.g. with blood or whatever they holds other solutions)
_stomachContents = new SolutionComponent();
_stomachContents.InitializeFromPrototype();
_stomachContents.MaxVolume = _initialMaxVolume;
_stomachContents.Owner = Owner; //Manually set owner to avoid crash when VV'ing this
}
public bool TryTransferSolution(Solution solution)
@@ -61,69 +57,42 @@ namespace Content.Server.GameObjects.Components.Nutrition
}
/// <summary>
/// This is where the magic happens. Make people throw up, increase nutrition, whatever
/// Loops through each reagent in _stomachContents, and calls the IMetabolizable for each of them./>
/// </summary>
/// <param name="solution"></param>
public void React(Solution solution)
/// <param name="tickTime">The time since the last metabolism tick in seconds.</param>
public void Metabolize(float tickTime)
{
// TODO: Implement metabolism post from here
// https://github.com/space-wizards/space-station-14/issues/170#issuecomment-481835623 as raised by moneyl
var hungerUpdate = 0;
var thirstUpdate = 0;
foreach (var reagent in solution.Contents)
if (_stomachContents.CurrentVolume == 0)
return;
//Run metabolism for each reagent, track quantity changes
_reagentDeltas.Clear();
foreach (var reagent in _stomachContents.ReagentList)
{
switch (reagent.ReagentId)
if(!_prototypeManager.TryIndex(reagent.ReagentId, out ReagentPrototype proto))
continue;
foreach (var metabolizable in proto.Metabolism)
{
case "chem.Nutriment":
hungerUpdate++;
break;
case "chem.H2O":
thirstUpdate++;
break;
case "chem.Alcohol":
thirstUpdate++;
break;
default:
continue;
_reagentDeltas[reagent.ReagentId] = metabolizable.Metabolize(Owner, reagent.ReagentId, tickTime);
}
}
// Quantity x restore amount per unit
if (hungerUpdate > 0 && Owner.TryGetComponent(out HungerComponent hungerComponent))
//Apply changes to quantity afterwards. Can't change the reagent quantities while the iterating the
//list of reagents, because that would invalidate the iterator and throw an exception.
foreach (var reagentDelta in _reagentDeltas)
{
hungerComponent.UpdateFood(hungerUpdate * NutrimentFactor);
_stomachContents.TryRemoveReagent(reagentDelta.Key, reagentDelta.Value);
}
if (thirstUpdate > 0 && Owner.TryGetComponent(out ThirstComponent thirstComponent))
{
thirstComponent.UpdateThirst(thirstUpdate * HydrationFactor);
}
// TODO: Dispose solution?
}
public void Metabolise()
/// <summary>
/// Triggers metabolism of the reagents inside _stomachContents. Called by <see cref="StomachSystem"/>
/// </summary>
/// <param name="tickTime">The time since the last metabolism tick in seconds.</param>
public void OnUpdate(float tickTime)
{
if (_stomachContents.CurrentVolume == 0)
{
return;
}
var metabolisation = _stomachContents.SplitSolution(MetabolisationAmount);
React(metabolisation);
}
public void OnUpdate(float frameTime)
{
_metabolisationCounter += frameTime;
if (_metabolisationCounter >= MetaboliseDelay)
{
// Going to be rounding issues with frametime but no easy way to avoid it with int reagents.
// It is a long-term mechanic so shouldn't be a big deal.
Metabolise();
_metabolisationCounter -= MetaboliseDelay;
}
Metabolize(tickTime);
}
}
}