Add egg laying + chicken/duck improvements (#9518)

Content.Server/Animals/Components/EggLayerComponent.cs

@@ -0,0 +1,55 @@
+using Content.Shared.Actions;
+using Content.Shared.Actions.ActionTypes;
+using Content.Shared.Sound;
+using Content.Shared.Storage;
+using Robust.Shared.Serialization;
+using Robust.Shared.Serialization.TypeSerializers.Implementations.Custom.Prototype;
+
+namespace Content.Server.Animals.Components;
+
+/// <summary>
+///     This component handles animals which lay eggs (or some other item) on a timer, using up hunger to do so.
+///     It also grants an action to players who are controlling these entities, allowing them to do it manually.
+/// </summary>
+[RegisterComponent]
+public sealed class EggLayerComponent : Component
+{
+    [DataField("eggLayAction", customTypeSerializer: typeof(PrototypeIdSerializer<InstantActionPrototype>))]
+    public string EggLayAction = "AnimalLayEgg";
+
+    [ViewVariables(VVAccess.ReadWrite)]
+    [DataField("hungerUsage")]
+    public float HungerUsage = 60f;
+
+    /// <summary>
+    ///     Minimum cooldown used for the automatic egg laying.
+    /// </summary>
+    [ViewVariables(VVAccess.ReadWrite)]
+    [DataField("eggLayCooldownMin")]
+    public float EggLayCooldownMin = 60f;
+
+    /// <summary>
+    ///     Maximum cooldown used for the automatic egg laying.
+    /// </summary>
+    [ViewVariables(VVAccess.ReadWrite)]
+    [DataField("eggLayCooldownMax")]
+    public float EggLayCooldownMax = 120f;
+
+    /// <summary>
+    ///     Set during component init.
+    /// </summary>
+    [ViewVariables(VVAccess.ReadWrite)]
+    public float CurrentEggLayCooldown;
+
+    [ViewVariables(VVAccess.ReadWrite)]
+    [DataField("eggSpawn", required: true)]
+    public List<EntitySpawnEntry> EggSpawn = default!;
+
+    [DataField("eggLaySound")]
+    public SoundSpecifier EggLaySound = new SoundPathSpecifier("/Audio/Effects/pop.ogg");
+
+    [DataField("accumulatedFrametime")]
+    public float AccumulatedFrametime;
+}
+
+public sealed class EggLayInstantActionEvent : InstantActionEvent {}

Content.Server/Animals/Systems/EggLayerSystem.cs

@@ -0,0 +1,95 @@
+using Content.Server.Actions;
+using Content.Server.Animals.Components;
+using Content.Server.Nutrition.Components;
+using Content.Server.Popups;
+using Content.Shared.Actions.ActionTypes;
+using Content.Shared.Storage;
+using Robust.Server.GameObjects;
+using Robust.Shared.Audio;
+using Robust.Shared.Player;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Random;
+
+namespace Content.Server.Animals.Systems;
+
+public sealed class EggLayerSystem : EntitySystem
+{
+    [Dependency] private readonly IRobustRandom _random = default!;
+    [Dependency] private readonly IPrototypeManager _prototype = default!;
+    [Dependency] private readonly ActionsSystem _actions = default!;
+    [Dependency] private readonly PopupSystem _popup = default!;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<EggLayerComponent, ComponentInit>(OnComponentInit);
+        SubscribeLocalEvent<EggLayerComponent, EggLayInstantActionEvent>(OnEggLayAction);
+    }
+
+    public override void Update(float frameTime)
+    {
+        base.Update(frameTime);
+
+        foreach (var eggLayer in EntityQuery<EggLayerComponent>())
+        {
+            // Players should be using the action.
+            if (HasComp<ActorComponent>(eggLayer.Owner))
+                return;
+
+            eggLayer.AccumulatedFrametime += frameTime;
+
+            if (eggLayer.AccumulatedFrametime < eggLayer.CurrentEggLayCooldown)
+                continue;
+
+            eggLayer.AccumulatedFrametime -= eggLayer.CurrentEggLayCooldown;
+            eggLayer.CurrentEggLayCooldown = _random.NextFloat(eggLayer.EggLayCooldownMin, eggLayer.EggLayCooldownMax);
+
+            TryLayEgg(eggLayer.Owner, eggLayer);
+        }
+    }
+
+    private void OnComponentInit(EntityUid uid, EggLayerComponent component, ComponentInit args)
+    {
+        if (!_prototype.TryIndex<InstantActionPrototype>(component.EggLayAction, out var action))
+            return;
+
+        _actions.AddAction(uid, new InstantAction(action), uid);
+        component.CurrentEggLayCooldown = _random.NextFloat(component.EggLayCooldownMin, component.EggLayCooldownMax);
+    }
+
+    private void OnEggLayAction(EntityUid uid, EggLayerComponent component, EggLayInstantActionEvent args)
+    {
+        args.Handled = TryLayEgg(uid, component);
+    }
+
+    public bool TryLayEgg(EntityUid uid, EggLayerComponent? component)
+    {
+        if (!Resolve(uid, ref component))
+            return false;
+
+        // Allow infinitely laying eggs if they can't get hungry
+        if (TryComp<HungerComponent>(uid, out var hunger))
+        {
+            if (hunger.CurrentHunger < component.HungerUsage)
+            {
+                _popup.PopupEntity(Loc.GetString("action-popup-lay-egg-too-hungry"), uid, Filter.Entities(uid));
+                return false;
+            }
+
+            hunger.CurrentHunger -= component.HungerUsage;
+        }
+
+        foreach (var ent in EntitySpawnCollection.GetSpawns(component.EggSpawn, _random))
+        {
+            Spawn(ent, Transform(uid).Coordinates);
+        }
+
+        // Sound + popups
+        SoundSystem.Play(component.EggLaySound.GetSound(), Filter.Pvs(uid), uid, component.EggLaySound.Params);
+        _popup.PopupEntity(Loc.GetString("action-popup-lay-egg-user"), uid, Filter.Entities(uid));
+        _popup.PopupEntity(Loc.GetString("action-popup-lay-egg-others", ("entity", uid)), uid, Filter.PvsExcept(uid));
+
+        return true;
+    }
+}