Files
RobustToolbox/Robust.Shared/Player/ActorComponent.cs
slarticodefast 4747e5a05a Add and update a lot of documentation (#6337)
* Serialization docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* ECS docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* scattered docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* Fixes

---------

Co-authored-by: Moony <moonheart08@users.noreply.github.com>
Co-authored-by: PJB3005 <pieterjan.briers+git@gmail.com>
2025-12-15 20:26:17 +01:00

19 lines
781 B
C#

using Robust.Shared.GameObjects;
using Robust.Shared.ViewVariables;
namespace Robust.Shared.Player;
/// <summary>
/// This component is added to entities that are currently controlled by a player and is removed when the player is detached.
/// </summary>
/// <seealso cref="M:Robust.Shared.Player.ISharedPlayerManager.SetAttachedEntity(Robust.Shared.Player.ICommonSession,System.Nullable{Robust.Shared.GameObjects.EntityUid},Robust.Shared.Player.ICommonSession@,System.Boolean)"/>
[RegisterComponent, UnsavedComponent]
public sealed partial class ActorComponent : Component
{
/// <summary>
/// The player session currently attached to the entity.
/// </summary>
[ViewVariables]
public ICommonSession PlayerSession { get; internal set; } = default!;
}