Openable refactor (#19750)

Content.Server/Nutrition/Components/OpenableComponent.cs

@@ -0,0 +1,46 @@
+using Content.Server.Nutrition.EntitySystems;
+using Robust.Shared.Audio;
+
+namespace Content.Server.Nutrition.Components;
+
+/// <summary>
+/// A drink or food that can be opened.
+/// Starts closed, open it with Z or E.
+/// </summary>
+[RegisterComponent, Access(typeof(OpenableSystem))]
+public sealed partial class OpenableComponent : Component
+{
+    /// <summary>
+    /// Whether this drink or food is opened or not.
+    /// Drinks can only be drunk or poured from/into when open, and food can only be eaten when open.
+    /// </summary>
+    [DataField, ViewVariables(VVAccess.ReadWrite)]
+    public bool Opened;
+
+    /// <summary>
+    /// If this is false you cant press Z to open it.
+    /// Requires an OpenBehavior damage threshold or other logic to open.
+    /// </summary>
+    [DataField, ViewVariables(VVAccess.ReadWrite)]
+    public bool OpenableByHand = true;
+
+    /// <summary>
+    /// Text shown when examining and its open.
+    /// </summary>
+    [DataField, ViewVariables(VVAccess.ReadWrite)]
+    public string ExamineText = "drink-component-on-examine-is-opened";
+
+    /// <summary>
+    /// The locale id for the popup shown when IsClosed is called and closed. Needs a "owner" entity argument passed to it.
+    /// Defaults to the popup drink uses since its "correct".
+    /// It's still generic enough that you should change it if you make openable non-drinks, i.e. unwrap it first, peel it first.
+    /// </summary>
+    [DataField, ViewVariables(VVAccess.ReadWrite)]
+    public string ClosedPopup = "drink-component-try-use-drink-not-open";
+
+    /// <summary>
+    /// Sound played when opening.
+    /// </summary>
+    [DataField]
+    public SoundSpecifier Sound = new SoundCollectionSpecifier("canOpenSounds");
+}