Class ExaminedEvent

Raised when an entity is examined.

Inheritance
System.Object
ExaminedEvent
Namespace: Content.Shared.Examine
Assembly: Content.Shared.dll
Syntax
public sealed class ExaminedEvent : EntityEventArgs

Constructors

| Improve this Doc View Source

ExaminedEvent(FormattedMessage, EntityUid, EntityUid, Boolean, Boolean)

Declaration
public ExaminedEvent(FormattedMessage message, EntityUid examined, EntityUid examiner, bool isInDetailsRange, bool doNewLine)
Parameters
Type Name Description
Robust.Shared.Utility.FormattedMessage message
EntityUid examined
EntityUid examiner
System.Boolean isInDetailsRange
System.Boolean doNewLine

Properties

| Improve this Doc View Source

Examined

Entity being examined, for broadcast event purposes.

Declaration
public EntityUid Examined { get; }
Property Value
Type Description
EntityUid
| Improve this Doc View Source

Examiner

The entity performing the examining.

Declaration
public EntityUid Examiner { get; }
Property Value
Type Description
EntityUid
| Improve this Doc View Source

IsInDetailsRange

Whether the examiner is in range of the entity to get some extra details.

Declaration
public bool IsInDetailsRange { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Message

The message that will be displayed as the examine text. For most use cases, you probably want to use PushMarkup(String) and similar instead to modify this, since it handles newlines and such correctly.

Declaration
public FormattedMessage Message { get; }
Property Value
Type Description
Robust.Shared.Utility.FormattedMessage
See Also

Methods

| Improve this Doc View Source

PushMarkup(String)

Push another message parsed from markup into this examine result, on its own line.

Declaration
public void PushMarkup(string markup)
Parameters
Type Name Description
System.String markup
See Also
| Improve this Doc View Source

PushMessage(FormattedMessage)

Push another message into this examine result, on its own line.

Declaration
public void PushMessage(FormattedMessage message)
Parameters
Type Name Description
Robust.Shared.Utility.FormattedMessage message
See Also
| Improve this Doc View Source

PushText(String)

Push another message containing raw text into this examine result, on its own line.

Declaration
public void PushText(string text)
Parameters
Type Name Description
System.String text
See Also