From: ShadowCommander <10494922+ShadowCommander@users.noreply.github.com>
Date: Sat, 13 Jul 2024 04:04:53 +0000 (-0700)
Subject: Add doc comments to target action components (#29982)
X-Git-Url: https://git.smokeofanarchy.ru/gitweb.cgi?a=commitdiff_plain;h=b94b52396e52e7627d80495f019a89a51751c6a8;p=space-station-14.git

Add doc comments to target action components (#29982)
---

diff --git a/Content.Shared/Actions/EntityTargetActionComponent.cs b/Content.Shared/Actions/EntityTargetActionComponent.cs
index 9024f42e0e..7217794b23 100644
--- a/Content.Shared/Actions/EntityTargetActionComponent.cs
+++ b/Content.Shared/Actions/EntityTargetActionComponent.cs
@@ -4,6 +4,9 @@ using Robust.Shared.Serialization;
 
 namespace Content.Shared.Actions;
 
+/// <summary>
+/// Used on action entities to define an action that triggers when targeting an entity.
+/// </summary>
 [RegisterComponent, NetworkedComponent]
 public sealed partial class EntityTargetActionComponent : BaseTargetActionComponent
 {
@@ -16,8 +19,15 @@ public sealed partial class EntityTargetActionComponent : BaseTargetActionCompon
     [NonSerialized]
     public EntityTargetActionEvent? Event;
 
+    /// <summary>
+    /// Determines which entities are valid targets for this action.
+    /// </summary>
+    /// <remarks>No whitelist check when null.</remarks>
     [DataField("whitelist")] public EntityWhitelist? Whitelist;
 
+    /// <summary>
+    /// Whether this action considers the user as a valid target entity when using this action.
+    /// </summary>
     [DataField("canTargetSelf")] public bool CanTargetSelf = true;
 }
 
diff --git a/Content.Shared/Actions/WorldTargetActionComponent.cs b/Content.Shared/Actions/WorldTargetActionComponent.cs
index 4974b4478d..8066a64034 100644
--- a/Content.Shared/Actions/WorldTargetActionComponent.cs
+++ b/Content.Shared/Actions/WorldTargetActionComponent.cs
@@ -3,6 +3,9 @@ using Robust.Shared.Serialization;
 
 namespace Content.Shared.Actions;
 
+/// <summary>
+/// Used on action entities to define an action that triggers when targeting an entity coordinate.
+/// </summary>
 [RegisterComponent, NetworkedComponent]
 public sealed partial class WorldTargetActionComponent : BaseTargetActionComponent
 {