using Content.Server.Fluids.Components;
using Content.Server.Spreader;
using Content.Shared.Chemistry;
using Content.Shared.Chemistry.Components;
using Content.Shared.Chemistry.Components.SolutionManager;
using Content.Shared.Chemistry.EntitySystems;
using Content.Shared.Chemistry.Reaction;
using Content.Shared.Database;
using Content.Shared.Effects;
using Content.Shared.FixedPoint;
using Content.Shared.Fluids;
using Content.Shared.Fluids.Components;
using Content.Shared.IdentityManagement;
using Content.Shared.Maps;
using Content.Shared.Popups;
using Content.Shared.Slippery;
using Robust.Shared.Collections;
using Robust.Shared.Map;
using Robust.Shared.Map.Components;
using Robust.Shared.Player;
using Robust.Shared.Prototypes;
using Robust.Shared.Random;
namespace Content.Server.Fluids.EntitySystems;
///
/// Handles solutions on floors. Also handles the spreader logic for where the solution overflows a specified volume.
///
public sealed partial class PuddleSystem : SharedPuddleSystem
{
[Dependency] private readonly SharedMapSystem _map = default!;
[Dependency] private readonly IPrototypeManager _prototypeManager = default!;
[Dependency] private readonly IRobustRandom _random = default!;
[Dependency] private readonly EntityLookupSystem _lookup = default!;
[Dependency] private readonly SharedColorFlashEffectSystem _color = default!;
[Dependency] private readonly SharedSolutionContainerSystem _solutionContainerSystem = default!;
[Dependency] private readonly SharedTransformSystem _transform = default!;
[Dependency] private readonly TurfSystem _turf = default!;
private EntityQuery _puddleQuery;
/*
* TODO: Need some sort of way to do blood slash / vomit solution spill on its own
* This would then evaporate into the puddle tile below
*/
///
public override void Initialize()
{
base.Initialize();
_puddleQuery = GetEntityQuery();
SubscribeLocalEvent(OnPuddleSpread);
SubscribeLocalEvent(OnPuddleSlip);
}
// TODO: This can be predicted once https://github.com/space-wizards/RobustToolbox/pull/5849 is merged
private void OnPuddleSpread(Entity entity, ref SpreadNeighborsEvent args)
{
// Overflow is the source of the overflowing liquid. This contains the excess fluid above overflow limit (20u)
var overflow = GetOverflowSolution(entity.Owner, entity.Comp);
if (overflow.Volume == FixedPoint2.Zero)
{
RemCompDeferred(entity);
return;
}
// For overflows, we never go to a fully evaporative tile just to avoid continuously having to mop it.
// First we go to free tiles.
// Need to go even if we have a little remainder to avoid solution sploshing around internally
// for ages.
if (args.NeighborFreeTiles.Count > 0 && args.Updates > 0)
{
_random.Shuffle(args.NeighborFreeTiles);
var spillAmount = overflow.Volume / args.NeighborFreeTiles.Count;
foreach (var neighbor in args.NeighborFreeTiles)
{
var split = overflow.SplitSolution(spillAmount);
TrySpillAt(_map.GridTileToLocal(neighbor.Tile.GridUid, neighbor.Grid, neighbor.Tile.GridIndices), split, out _, false);
args.Updates--;
if (args.Updates <= 0)
break;
}
RemCompDeferred(entity);
return;
}
// Then we overflow to neighbors with overflow capacity
if (args.Neighbors.Count > 0)
{
var resolvedNeighbourSolutions = new ValueList<(Solution neighborSolution, PuddleComponent puddle, EntityUid neighbor)>();
// Resolve all our neighbours first, so we can use their properties to decide who to operate on first.
foreach (var neighbor in args.Neighbors)
{
if (!_puddleQuery.TryGetComponent(neighbor, out var puddle) ||
!_solutionContainerSystem.ResolveSolution(neighbor, puddle.SolutionName, ref puddle.Solution,
out var neighborSolution) ||
CanFullyEvaporate(neighborSolution))
{
continue;
}
resolvedNeighbourSolutions.Add(
(neighborSolution, puddle, neighbor)
);
}
// We want to deal with our neighbours by lowest current volume to highest, as this allows us to fill up our low points quickly.
resolvedNeighbourSolutions.Sort(
(x, y) =>
x.neighborSolution.Volume.CompareTo(y.neighborSolution.Volume));
// Overflow to neighbors with remaining space.
foreach (var (neighborSolution, puddle, neighbor) in resolvedNeighbourSolutions)
{
// Water doesn't flow uphill
if (neighborSolution.Volume >= (overflow.Volume + puddle.OverflowVolume))
{
continue;
}
// Work out how much we could send into this neighbour without overflowing it, and send up to that much
var remaining = puddle.OverflowVolume - neighborSolution.Volume;
// If we can't send anything, then skip this neighbour
if (remaining <= FixedPoint2.Zero)
continue;
// We don't want to spill over to make high points either.
if (neighborSolution.Volume + remaining >= (overflow.Volume + puddle.OverflowVolume))
{
continue;
}
var split = overflow.SplitSolution(remaining);
if (puddle.Solution != null && !_solutionContainerSystem.TryAddSolution(puddle.Solution.Value, split))
continue;
args.Updates--;
EnsureComp(neighbor);
if (args.Updates <= 0)
break;
}
// If there is nothing left to overflow from our tile, then we'll stop this tile being a active spreader
if (overflow.Volume == FixedPoint2.Zero)
{
RemCompDeferred(entity);
return;
}
}
// Then we go to anything else.
if (overflow.Volume > FixedPoint2.Zero && args.Neighbors.Count > 0 && args.Updates > 0)
{
var resolvedNeighbourSolutions =
new ValueList<(Solution neighborSolution, PuddleComponent puddle, EntityUid neighbor)>();
// Keep track of the total volume in the area
FixedPoint2 totalVolume = 0;
// Resolve all our neighbours so that we can use their properties to decide who to act on first
foreach (var neighbor in args.Neighbors)
{
if (!_puddleQuery.TryGetComponent(neighbor, out var puddle) ||
!_solutionContainerSystem.ResolveSolution(neighbor, puddle.SolutionName, ref puddle.Solution,
out var neighborSolution) ||
CanFullyEvaporate(neighborSolution))
{
continue;
}
resolvedNeighbourSolutions.Add((neighborSolution, puddle, neighbor));
totalVolume += neighborSolution.Volume;
}
// We should act on neighbours by their total volume.
resolvedNeighbourSolutions.Sort(
(x, y) =>
x.neighborSolution.Volume.CompareTo(y.neighborSolution.Volume)
);
// Overflow to neighbors with remaining total allowed space (1000u) above the overflow volume (20u).
foreach (var (neighborSolution, puddle, neighbor) in resolvedNeighbourSolutions)
{
// What the source tiles current volume is.
var sourceCurrentVolume = overflow.Volume + puddle.OverflowVolume;
// Water doesn't flow uphill
if (neighborSolution.Volume >= sourceCurrentVolume)
{
continue;
}
// We're in the low point in this area, let the neighbour tiles have a chance to spread to us first.
var idealAverageVolume =
(totalVolume + overflow.Volume + puddle.OverflowVolume) / (args.Neighbors.Count + 1);
if (idealAverageVolume > sourceCurrentVolume)
{
continue;
}
// Work our how far off the ideal average this neighbour is.
var spillThisNeighbor = idealAverageVolume - neighborSolution.Volume;
// Skip if we want to spill negative amounts of fluid to this neighbour
if (spillThisNeighbor < FixedPoint2.Zero)
{
continue;
}
// Try to send them as much towards the average ideal as we can
var split = overflow.SplitSolution(spillThisNeighbor);
// If we can't do it, move on.
if (puddle.Solution != null && !_solutionContainerSystem.TryAddSolution(puddle.Solution.Value, split))
continue;
// If we succeed, then ensure that this neighbour is also able to spread it's overflow onwards
EnsureComp(neighbor);
args.Updates--;
if (args.Updates <= 0)
break;
}
}
// Add the remainder back
if (_solutionContainerSystem.ResolveSolution(entity.Owner, entity.Comp.SolutionName, ref entity.Comp.Solution))
{
_solutionContainerSystem.TryAddSolution(entity.Comp.Solution.Value, overflow);
}
}
// TODO: This can be predicted once https://github.com/space-wizards/RobustToolbox/pull/5849 is merged
private void OnPuddleSlip(Entity entity, ref SlipEvent args)
{
// Reactive entities have a chance to get a touch reaction from slipping on a puddle
// (i.e. it is implied they fell face first onto it or something)
if (!HasComp(args.Slipped) || HasComp(args.Slipped))
return;
// Eventually probably have some system of 'body coverage' to tweak the probability but for now just 0.5
// (implying that spacemen have a 50% chance to either land on their ass or their face)
if (!_random.Prob(0.5f))
return;
if (!_solutionContainerSystem.ResolveSolution(entity.Owner, entity.Comp.SolutionName, ref entity.Comp.Solution,
out var solution))
return;
Popups.PopupEntity(Loc.GetString("puddle-component-slipped-touch-reaction", ("puddle", entity.Owner)),
args.Slipped, args.Slipped, PopupType.SmallCaution);
// Take 15% of the puddle solution
var splitSol = _solutionContainerSystem.SplitSolution(entity.Comp.Solution.Value, solution.Volume * 0.15f);
Reactive.DoEntityReaction(args.Slipped, splitSol, ReactionMethod.Touch);
}
///
/// Gets the current volume of the given puddle, which may not necessarily be PuddleVolume.
///
public FixedPoint2 CurrentVolume(EntityUid uid, PuddleComponent? puddleComponent = null)
{
if (!Resolve(uid, ref puddleComponent))
return FixedPoint2.Zero;
return _solutionContainerSystem.ResolveSolution(uid, puddleComponent.SolutionName, ref puddleComponent.Solution,
out var solution)
? solution.Volume
: FixedPoint2.Zero;
}
///
/// Try to add solution to .
///
/// Puddle to which we add
/// Solution that is added to puddleComponent
/// Play sound on overflow
/// Overflow on encountered values
/// Optional resolved PuddleComponent
///
public bool TryAddSolution(EntityUid puddleUid,
Solution addedSolution,
bool sound = true,
bool checkForOverflow = true,
PuddleComponent? puddleComponent = null,
SolutionContainerManagerComponent? sol = null)
{
if (!Resolve(puddleUid, ref puddleComponent, ref sol))
return false;
_solutionContainerSystem.EnsureAllSolutions((puddleUid, sol));
if (addedSolution.Volume == 0 ||
!_solutionContainerSystem.ResolveSolution(puddleUid, puddleComponent.SolutionName,
ref puddleComponent.Solution))
{
return false;
}
_solutionContainerSystem.AddSolution(puddleComponent.Solution.Value, addedSolution);
if (checkForOverflow && IsOverflowing(puddleUid, puddleComponent))
{
EnsureComp(puddleUid);
}
if (!sound)
{
return true;
}
Audio.PlayPvs(puddleComponent.SpillSound, puddleUid);
return true;
}
///
/// Whether adding this solution to this puddle would overflow.
///
public bool WouldOverflow(EntityUid uid, Solution solution, PuddleComponent? puddle = null)
{
if (!Resolve(uid, ref puddle))
return false;
return CurrentVolume(uid, puddle) + solution.Volume > puddle.OverflowVolume;
}
///
/// Whether adding this solution to this puddle would overflow.
///
private bool IsOverflowing(EntityUid uid, PuddleComponent? puddle = null)
{
if (!Resolve(uid, ref puddle))
return false;
return CurrentVolume(uid, puddle) > puddle.OverflowVolume;
}
///
/// Gets the solution amount above the overflow threshold for the puddle.
///
public Solution GetOverflowSolution(EntityUid uid, PuddleComponent? puddle = null)
{
if (!Resolve(uid, ref puddle) ||
!_solutionContainerSystem.ResolveSolution(uid, puddle.SolutionName, ref puddle.Solution))
{
return new Solution(0);
}
// TODO: This is going to fail with struct solutions.
var remaining = puddle.OverflowVolume;
var split = _solutionContainerSystem.SplitSolution(puddle.Solution.Value,
CurrentVolume(uid, puddle) - remaining);
return split;
}
#region Spill
// TODO: This can be predicted once https://github.com/space-wizards/RobustToolbox/pull/5849 is merged
///
public override bool TrySplashSpillAt(EntityUid uid,
EntityCoordinates coordinates,
Solution solution,
out EntityUid puddleUid,
bool sound = true,
EntityUid? user = null)
{
puddleUid = EntityUid.Invalid;
if (solution.Volume == 0)
return false;
var targets = new List();
var reactive = new HashSet>();
_lookup.GetEntitiesInRange(coordinates, 1.0f, reactive);
// Get reactive entities nearby--if there are some, it'll spill a bit on them instead.
foreach (var ent in reactive)
{
// sorry! no overload for returning uid, so .owner must be used
var owner = ent.Owner;
// between 5 and 30%
var splitAmount = solution.Volume * _random.NextFloat(0.05f, 0.30f);
var splitSolution = solution.SplitSolution(splitAmount);
if (user != null)
{
AdminLogger.Add(LogType.Landed,
$"{ToPrettyString(user.Value):user} threw {ToPrettyString(uid):entity} which splashed a solution {SharedSolutionContainerSystem.ToPrettyString(solution):solution} onto {ToPrettyString(owner):target}");
}
targets.Add(owner);
Reactive.DoEntityReaction(owner, splitSolution, ReactionMethod.Touch);
Popups.PopupEntity(
Loc.GetString("spill-land-spilled-on-other", ("spillable", uid),
("target", Identity.Entity(owner, EntityManager))), owner, PopupType.SmallCaution);
}
_color.RaiseEffect(solution.GetColor(_prototypeManager), targets,
Filter.Pvs(uid, entityManager: EntityManager));
return TrySpillAt(coordinates, solution, out puddleUid, sound);
}
///
public override bool TrySpillAt(EntityCoordinates coordinates, Solution solution, out EntityUid puddleUid, bool sound = true)
{
if (solution.Volume == 0)
{
puddleUid = EntityUid.Invalid;
return false;
}
var gridUid = _transform.GetGrid(coordinates);
if (!TryComp(gridUid, out var mapGrid))
{
puddleUid = EntityUid.Invalid;
return false;
}
return TrySpillAt(_map.GetTileRef(gridUid.Value, mapGrid, coordinates), solution, out puddleUid, sound);
}
///
public override bool TrySpillAt(EntityUid uid, Solution solution, out EntityUid puddleUid, bool sound = true,
TransformComponent? transformComponent = null)
{
if (!Resolve(uid, ref transformComponent, false))
{
puddleUid = EntityUid.Invalid;
return false;
}
return TrySpillAt(transformComponent.Coordinates, solution, out puddleUid, sound: sound);
}
///
public override bool TrySpillAt(TileRef tileRef, Solution solution, out EntityUid puddleUid, bool sound = true,
bool tileReact = true)
{
if (solution.Volume <= 0)
{
puddleUid = EntityUid.Invalid;
return false;
}
// If space return early, let that spill go out into the void
if (tileRef.Tile.IsEmpty || _turf.IsSpace(tileRef))
{
puddleUid = EntityUid.Invalid;
return false;
}
// Let's not spill to invalid grids.
var gridId = tileRef.GridUid;
if (!TryComp(gridId, out var mapGrid))
{
puddleUid = EntityUid.Invalid;
return false;
}
if (tileReact)
{
// First, do all tile reactions
DoTileReactions(tileRef, solution);
}
// Tile reactions used up everything.
if (solution.Volume == FixedPoint2.Zero)
{
puddleUid = EntityUid.Invalid;
return false;
}
// Get normalized co-ordinate for spill location and spill it in the centre
// TODO: Does SnapGrid or something else already do this?
var anchored = _map.GetAnchoredEntitiesEnumerator(gridId, mapGrid, tileRef.GridIndices);
var puddleQuery = GetEntityQuery();
var sparklesQuery = GetEntityQuery();
while (anchored.MoveNext(out var ent))
{
// If there's existing sparkles then delete it
if (sparklesQuery.TryGetComponent(ent, out var sparkles))
{
QueueDel(ent.Value);
continue;
}
if (!puddleQuery.TryGetComponent(ent, out var puddle))
continue;
if (TryAddSolution(ent.Value, solution, sound, puddleComponent: puddle))
{
EnsureComp(ent.Value);
}
puddleUid = ent.Value;
return true;
}
var coords = _map.GridTileToLocal(gridId, mapGrid, tileRef.GridIndices);
puddleUid = Spawn("Puddle", coords);
EnsureComp(puddleUid);
if (TryAddSolution(puddleUid, solution, sound))
{
EnsureComp(puddleUid);
}
return true;
}
#endregion
///
/// Tries to get the relevant puddle entity for a tile.
///
public bool TryGetPuddle(TileRef tile, out EntityUid puddleUid)
{
puddleUid = EntityUid.Invalid;
if (!TryComp(tile.GridUid, out var grid))
return false;
var anc = _map.GetAnchoredEntitiesEnumerator(tile.GridUid, grid, tile.GridIndices);
var puddleQuery = GetEntityQuery();
while (anc.MoveNext(out var ent))
{
if (!puddleQuery.HasComponent(ent.Value))
continue;
puddleUid = ent.Value;
return true;
}
return false;
}
}