64 lines
2.7 KiB
C#
64 lines
2.7 KiB
C#
using Content.Server.Fluids.EntitySystems;
|
|
using Content.Shared.FixedPoint;
|
|
using Content.Shared.Sound;
|
|
|
|
namespace Content.Server.Fluids.Components
|
|
{
|
|
/// <summary>
|
|
/// Puddle on a floor
|
|
/// </summary>
|
|
[RegisterComponent]
|
|
[Friend(typeof(PuddleSystem))]
|
|
public sealed class PuddleComponent : Component
|
|
{
|
|
public const string DefaultSolutionName = "puddle";
|
|
private static readonly FixedPoint2 DefaultSlipThreshold = FixedPoint2.New(-1);
|
|
public static readonly FixedPoint2 DefaultOverflowVolume = FixedPoint2.New(20);
|
|
|
|
// Current design: Something calls the SpillHelper.Spill, that will either
|
|
// A) Add to an existing puddle at the location (normalised to tile-center) or
|
|
// B) add a new one
|
|
// From this every time a puddle is spilt on it will try and overflow to its neighbours if possible,
|
|
// and also update its appearance based on volume level (opacity) and chemistry color
|
|
// Small puddles will evaporate after a set delay
|
|
|
|
// TODO: 'leaves fluidtracks', probably in a separate component for stuff like gibb chunks?;
|
|
|
|
// based on behaviour (e.g. someone being punched vs slashed with a sword would have different blood sprite)
|
|
// to check for low volumes for evaporation or whatever
|
|
|
|
/// <summary>
|
|
/// Puddles with volume above this threshold can slip players.
|
|
/// </summary>
|
|
[DataField("slipThreshold")]
|
|
public FixedPoint2 SlipThreshold = DefaultSlipThreshold;
|
|
|
|
/// <summary>
|
|
/// Puddles with volume below this threshold will have their sprite changed to a wet floor effect,
|
|
/// provided they can evaporate down to zero.
|
|
/// </summary>
|
|
[DataField("wetFloorEffectThreshold")]
|
|
public FixedPoint2 WetFloorEffectThreshold = FixedPoint2.New(5);
|
|
|
|
[DataField("spillSound")]
|
|
public SoundSpecifier SpillSound = new SoundPathSpecifier("/Audio/Effects/Fluids/splat.ogg");
|
|
|
|
[ViewVariables(VVAccess.ReadOnly)]
|
|
public FixedPoint2 CurrentVolume => EntitySystem.Get<PuddleSystem>().CurrentVolume(Owner);
|
|
|
|
[ViewVariables] [DataField("overflowVolume")]
|
|
public FixedPoint2 OverflowVolume = DefaultOverflowVolume;
|
|
|
|
/// <summary>
|
|
/// How much should this puddle's opacity be multiplied by?
|
|
/// Useful for puddles that have a high overflow volume but still want to be mostly opaque.
|
|
/// </summary>
|
|
[DataField("opacityModifier")]
|
|
public float OpacityModifier = 1.0f;
|
|
|
|
public FixedPoint2 OverflowLeft => CurrentVolume - OverflowVolume;
|
|
|
|
[DataField("solution")] public string SolutionName { get; set; } = DefaultSolutionName;
|
|
}
|
|
}
|