d75e743dd7
* Creates Content.Shared.Chemistry.Solutions Copies Solution class to new namespace Obsoletes old Solution class * Switches over to the Solutions.Solution Solution * Creates Content.Shared.Chemistry.Containers Copies relevant components/systems to the new namespace Obsoletes old versions * Switches over to the Containers.XYZ namespace * Creates SolutionSystem and obsoletes old SolutionContainerSystem methods * Start using SolutionSystem for Solution manipulation * EnumerateSolutions * Move TryGetMixableSolution * Move EnsureSolution to Server * Create Solution Entities * Stop using obsolete solution system methods * Fix prototype component tests * Add using ..Audio.Systems; back * Wrap solution container slots in ContainerSlots * Actually add the slot to the solution container map * Dirty SolutionContainerComponent when ensuring solutions * Revert namespace changes * Remerge SolutionSystem and SolutionContainerSystem * SolutionContainerManagerComponent refactor * Avoid wrapping necessary code in DebugTools.Assert as it is removed when compiling for release * Readd examine reagent sorting * Fix errors * Poke tests * Fix solution names not being applied * Fix WoolyComponent including statement * Fix merge skew * Fix compile errors * Make reactions use solntities * Reindent solution class namespace * Field attribute changes * AutoGenerateComponentState for SolutionContainerComponent * SolutionContainerComponent -> ContainedSolutionComponent * ref ReactionAttemptEvent * Denetwork preinit solutions * Misc 1 * Nullable TryGetSolution out vars * Cache associated solutions * Fix merge skew * Use explicit regions in SharedSolutionContainerSystem.Capabilities * Add debug assert * Use explicit regions in SharedSolutionContainerSystem.Relay + ref SolutionContainerChangedEvent * ContainedSolutionComponent.Name -> ContainedSolutionComponent.ContainerName * SolutionComponent doc comments * Implicit DataField names and property purge * ReagentEffect DataField names * Local variables for readability * Sort using statements + Entity<T> event handlers * Fix compile erros * Fix compile errors --------- Co-authored-by: ElectroJr <leonsfriedrich@gmail.com>
85 lines
3.2 KiB
C#
85 lines
3.2 KiB
C#
using Content.Shared.Chemistry.Components;
|
|
using Content.Shared.Tag;
|
|
using Robust.Shared.Audio;
|
|
|
|
namespace Content.Shared.Fluids.Components;
|
|
|
|
/// <summary>
|
|
/// A Drain allows an entity to absorb liquid in a disposal goal. Drains can be filled manually (with the Empty verb)
|
|
/// or they can absorb puddles of liquid around them when AutoDrain is set to true.
|
|
/// When the entity also has a SolutionContainerManager attached with a solution named drainBuffer, this solution
|
|
/// gets filled until the drain is full.
|
|
/// When the drain is full, it can be unclogged using a plunger (i.e. an entity with a Plunger tag attached).
|
|
/// Later this can be refactored into a proper Plunger component if needed.
|
|
/// </summary>
|
|
[RegisterComponent, Access(typeof(SharedDrainSystem))]
|
|
public sealed partial class DrainComponent : Component
|
|
{
|
|
public const string SolutionName = "drainBuffer";
|
|
|
|
[ValidatePrototypeId<TagPrototype>]
|
|
public const string PlungerTag = "Plunger";
|
|
|
|
[DataField]
|
|
public Entity<SolutionComponent>? Solution = null;
|
|
|
|
[DataField("accumulator")]
|
|
public float Accumulator = 0f;
|
|
|
|
/// <summary>
|
|
/// Does this drain automatically absorb surrouding puddles? Or is it a drain designed to empty
|
|
/// solutions in it manually?
|
|
/// </summary>
|
|
[DataField("autoDrain"), ViewVariables(VVAccess.ReadOnly)]
|
|
public bool AutoDrain = true;
|
|
|
|
/// <summary>
|
|
/// How many units per second the drain can absorb from the surrounding puddles.
|
|
/// Divided by puddles, so if there are 5 puddles this will take 1/5 from each puddle.
|
|
/// This will stay fixed to 1 second no matter what DrainFrequency is.
|
|
/// </summary>
|
|
[DataField("unitsPerSecond")]
|
|
public float UnitsPerSecond = 6f;
|
|
|
|
/// <summary>
|
|
/// How many units are ejected from the buffer per second.
|
|
/// </summary>
|
|
[DataField("unitsDestroyedPerSecond")]
|
|
public float UnitsDestroyedPerSecond = 3f;
|
|
|
|
/// <summary>
|
|
/// How many (unobstructed) tiles away the drain will
|
|
/// drain puddles from.
|
|
/// </summary>
|
|
[DataField("range"), ViewVariables(VVAccess.ReadWrite)]
|
|
public float Range = 2f;
|
|
|
|
/// <summary>
|
|
/// How often in seconds the drain checks for puddles around it.
|
|
/// If the EntityQuery seems a bit unperformant this can be increased.
|
|
/// </summary>
|
|
[DataField("drainFrequency")]
|
|
public float DrainFrequency = 1f;
|
|
|
|
/// <summary>
|
|
/// How much time it takes to unclog it with a plunger
|
|
/// </summary>
|
|
[DataField("unclogDuration"), ViewVariables(VVAccess.ReadWrite)]
|
|
public float UnclogDuration = 1f;
|
|
|
|
/// <summary>
|
|
/// What's the probability of uncloging on each try
|
|
/// </summary>
|
|
[DataField("unclogProbability"), ViewVariables(VVAccess.ReadWrite)]
|
|
public float UnclogProbability = 0.75f;
|
|
|
|
[DataField("manualDrainSound"), ViewVariables(VVAccess.ReadOnly)]
|
|
public SoundSpecifier ManualDrainSound = new SoundPathSpecifier("/Audio/Effects/Fluids/slosh.ogg");
|
|
|
|
[DataField("plungerSound"), ViewVariables(VVAccess.ReadOnly)]
|
|
public SoundSpecifier PlungerSound = new SoundPathSpecifier("/Audio/Items/Janitor/plunger.ogg");
|
|
|
|
[DataField("unclogSound"), ViewVariables(VVAccess.ReadOnly)]
|
|
public SoundSpecifier UnclogSound = new SoundPathSpecifier("/Audio/Effects/Fluids/glug.ogg");
|
|
}
|