mirror of
https://github.com/space-wizards/RobustToolbox.git
synced 2026-02-15 03:30:53 +01:00
eba58cb893
* Cut down RobustTree * Better LoD * Add PvsPriority flag * Undo cvar name change * reorganize grafana metrics * Fix tests * Fix replays * Don't try process empty chunks * Fix move benchmark * Fix benchmark * Remove obsolete audio methods * Moar benchmarks * Rename EntityData * A * B
46 lines
1.9 KiB
C#
46 lines
1.9 KiB
C#
using System;
|
|
using Robust.Shared.Player;
|
|
|
|
namespace Robust.Shared.GameObjects;
|
|
|
|
/// <summary>
|
|
/// A type that represents an entity, and allows you to get a string containing human-readable information about it.
|
|
/// This type converts implicitly to string, for convenience purposes.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This can be used to pretty-print information about entities and also to log various information regarding an
|
|
/// entity, if you're using string interpolation handlers.
|
|
/// </remarks>
|
|
/// <param name="Uid">The unique identifier of the entity.</param>
|
|
/// <param name="Deleted">Whether the entity has been deleted or not. Also true if the entity does not exist.</param>
|
|
/// <param name="Name">The name of the entity.</param>
|
|
/// <param name="Prototype">The prototype identifier of the entity, if any.</param>
|
|
/// <param name="Session">The session attached to the entity, if any.</param>
|
|
public readonly record struct EntityStringRepresentation
|
|
(EntityUid Uid, NetEntity Nuid, bool Deleted, string? Name = null, string? Prototype = null, ICommonSession? Session = null) : IFormattable
|
|
{
|
|
public EntityStringRepresentation(Entity<MetaDataComponent> entity) : this(entity.Owner, entity.Comp)
|
|
{
|
|
}
|
|
|
|
public EntityStringRepresentation(EntityUid uid, MetaDataComponent meta, ActorComponent? actor = null)
|
|
: this(uid, meta.NetEntity, meta.EntityDeleted, meta.EntityName, meta.EntityPrototype?.ID, actor?.PlayerSession)
|
|
{
|
|
}
|
|
|
|
public override string ToString()
|
|
{
|
|
if (Deleted && Name == null)
|
|
return $"{Uid}/n{Nuid}D";
|
|
|
|
return $"{Name} ({Uid}/n{Nuid}{(Prototype != null ? $", {Prototype}" : "")}{(Session != null ? $", {Session.Name}" : "")}){(Deleted ? "D" : "")}";
|
|
}
|
|
|
|
public string ToString(string? format, IFormatProvider? formatProvider)
|
|
{
|
|
return ToString();
|
|
}
|
|
|
|
public static implicit operator string(EntityStringRepresentation rep) => rep.ToString();
|
|
}
|