v1.0.20.1 (summer patch)

Barotrauma/BarotraumaShared/SharedSource/Enums.cs

@@ -12,21 +12,112 @@ namespace Barotrauma
         Exponential
     }
 
+    /// <summary>
+    /// ActionTypes define when a <see cref="StatusEffect"/> is executed.
+    /// </summary>
     public enum ActionType
     {
-        Always = 0, OnPicked = 1, OnUse = 2, OnSecondaryUse = 3,
-        OnWearing = 4, OnContaining = 5, OnContained = 6, OnNotContained = 7,
-        OnActive = 8, OnFailure = 9, OnBroken = 10,
-        OnFire = 11, InWater = 12, NotInWater = 13,
+        /// <summary>
+        /// Executes every frame regardless of the state of the entity.
+        /// </summary>
+        Always = 0,
+        /// <summary>
+        /// Executes when the item is picked up. Only valid for items.
+        /// </summary>
+        OnPicked = 1,
+        /// <summary>
+        /// Executes when the item is used. The meaning of "using" an item depends on the item, but generally it means the action that happens when holding the item and clicking LMB. Only valid for items.
+        /// </summary>
+        OnUse = 2,
+        /// <summary>
+        /// Executes when an item is held and the aim key is held. Only valid for items.
+        /// </summary>
+        OnSecondaryUse = 3,
+        /// <summary>
+        /// Executes continuously while the item is being worn. Only valid for wearable items.
+        /// </summary>
+        OnWearing = 4,
+        /// <summary>
+        /// Executes continuously when a specific Containable is inside an ItemContainer. Only valid for Containables defined in an ItemContainer component.
+        /// </summary>
+        OnContaining = 5,
+        /// <summary>
+        /// Executes continuously when the item is contained in some inventory. Only valid for items.
+        /// </summary>
+        OnContained = 6,
+        /// <summary>
+        /// Executes continuously when the item is NOT contained in an inventory. Only valid for items.
+        /// </summary>
+        OnNotContained = 7,
+        /// <summary>
+        /// Executes continuously when the item is active. The meaning of "active" depends on the item, but generally means the item is on, powered, and doing the thing it's intended for. Only valid for items.
+        /// </summary>
+        OnActive = 8,
+        /// <summary>
+        /// Executes when using the item fails due to a failed skill check. Only valid for items.
+        /// </summary>
+        OnFailure = 9,
+        /// <summary>
+        /// Executes when using the item's condition drops to 0. Only valid for items.
+        /// </summary>
+        OnBroken = 10,
+        /// <summary>
+        /// Executes continuously when the entity is within the damage range of fire. Valid for items and characters.
+        /// </summary>
+        OnFire = 11,
+        /// <summary>
+        /// Executes continuously when the entity is submerged. Valid for items and characters.
+        /// </summary>
+        InWater = 12,
+        /// <summary>
+        /// Executes continuously when the entity is NOT submerged. Valid for items and characters.
+        /// </summary>
+        NotInWater = 13,
+        /// <summary>
+        /// Executes when the entity hits something hard enough. For items, the threshold is determined by <see cref="ItemPrefab.ImpactTolerance"/>,
+        /// for characters by <see cref="Ragdoll.ImpactTolerance"/>. Valid for items and characters.
+        /// </summary>
         OnImpact = 14,
+        /// <summary>
+        /// Executes continuously when the character is eating another character. Only valid for characters.
+        /// </summary>
         OnEating = 15,
+        /// <summary>
+        /// Executes when the entity receives damage from an external source (i.e. an affliction that increases in severity, or an item degrading by itself don't count).
+        /// Valid for items and characters.
+        /// </summary>
         OnDamaged = 16,
+        /// <summary>
+        /// Executes when the limb gets severed. Only valid for limbs.
+        /// </summary>
         OnSevered = 17,
+        /// <summary>
+        /// Executes when a <see cref="Items.Components.Growable"/> produces an item (e.g. when a plant grows a fruit). Only valid for Growable items.
+        /// </summary>
         OnProduceSpawned = 18,
-        OnOpen = 19, OnClose = 20,
+        /// <summary>
+        /// Executes when a <see cref="Items.Components.Door"/> is opened. Only valid for doors.
+        /// </summary>
+        OnOpen = 19,
+        /// <summary>
+        /// Executes when a <see cref="Items.Components.Door"/> is closed. Only valid for doors.
+        /// </summary>
+        OnClose = 20,
+        /// <summary>
+        /// Executes when the entity spawns. Valid for items and characters.
+        /// </summary>
         OnSpawn = 21,
+        /// <summary>
+        /// Executes when using the item succeeds based on a skill check. Only valid for items.
+        /// </summary>
         OnSuccess = 22,
+        /// <summary>
+        /// Executes when an Ability (an effect from a talent) triggers the status effect. Only valid in Abilities, the target can be either a character or an item depending on the type of Ability.
+        /// </summary>
         OnAbility = 23,
+        /// <summary>
+        /// Executes when the character dies. Only valid for characters.
+        /// </summary>
         OnDeath = OnBroken
     }