add some documentation for visiting entity (#38475)

* add some documentation for visiting entity

to prevent someone from spending 5 minutes diving into the codebase

* reviews

Co-authored-by: LaCumbiaDelCoronavirus <90893484+LaCumbiaDelCoronavirus@users.noreply.github.com>

---------

Co-authored-by: LaCumbiaDelCoronavirus <90893484+LaCumbiaDelCoronavirus@users.noreply.github.com>
This commit is contained in:
Just-a-Unity-Dev
2025-06-21 17:19:57 +08:00
committed by GitHub
parent 3b6f4c5b3e
commit 27a4c1955c

View File

@@ -55,6 +55,9 @@ public sealed partial class MindComponent : Component
[ViewVariables]
public bool IsVisitingEntity => VisitingEntity != null;
/// <summary>
/// The entity that this mind may be currently visiting. Used, for example, to allow admin ghosting to not make the owner's body catatonic, as opposed to when normally ghosting.
/// </summary>
[DataField, AutoNetworkedField, Access(typeof(SharedMindSystem))]
public EntityUid? VisitingEntity { get; set; }