Class ExamineSystem

Inheritance
System.Object
ExamineSystemShared
ExamineSystem
Implements
EntitySystem
Namespace: Content.Client.Examine
Assembly: Content.Client.dll
Syntax
public sealed class ExamineSystem : ExamineSystemShared, EntitySystem

Fields

| Improve this Doc View Source

StyleClassEntityTooltip

Declaration
public const string StyleClassEntityTooltip = null
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

CanExamine(EntityUid, MapCoordinates, SharedInteractionSystem.Ignored, Nullable<EntityUid>, ExaminerComponent)

Declaration
public override bool CanExamine(EntityUid examiner, MapCoordinates target, SharedInteractionSystem.Ignored predicate = null, EntityUid? examined = null, ExaminerComponent examinerComp = null)
Parameters
Type Name Description
EntityUid examiner
Robust.Shared.Map.MapCoordinates target
SharedInteractionSystem.Ignored predicate
System.Nullable<EntityUid> examined
ExaminerComponent examinerComp
Returns
Type Description
System.Boolean
| Improve this Doc View Source

DoExamine(EntityUid, Boolean, Nullable<EntityUid>)

Declaration
public void DoExamine(EntityUid entity, bool centeredOnCursor = true, EntityUid? userOverride = null)
Parameters
Type Name Description
EntityUid entity
System.Boolean centeredOnCursor
System.Nullable<EntityUid> userOverride
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
Overrides
| Improve this Doc View Source

OpenTooltip(EntityUid, EntityUid, Boolean, Boolean, Boolean)

Opens the tooltip window and sets spriteview/name/etc, but does not fill it with information. This is done when the server sends examine info/verbs, or immediately if it's entirely clientside.

Declaration
public void OpenTooltip(EntityUid player, EntityUid target, bool centeredOnCursor = true, bool openAtOldTooltip = true, bool knowTarget = true)
Parameters
Type Name Description
EntityUid player
EntityUid target
System.Boolean centeredOnCursor
System.Boolean openAtOldTooltip
System.Boolean knowTarget
| Improve this Doc View Source

SendExamineTooltip(EntityUid, EntityUid, FormattedMessage, Boolean, Boolean)

Declaration
public override void SendExamineTooltip(EntityUid player, EntityUid target, FormattedMessage message, bool getVerbs, bool centerAtCursor)
Parameters
Type Name Description
EntityUid player
EntityUid target
Robust.Shared.Utility.FormattedMessage message
System.Boolean getVerbs
System.Boolean centerAtCursor
| Improve this Doc View Source

Shutdown()

Declaration
public override void Shutdown()
| Improve this Doc View Source

Update(Single)

Declaration
public override void Update(float frameTime)
Parameters
Type Name Description
System.Single frameTime
| Improve this Doc View Source

UpdateTooltipInfo(EntityUid, EntityUid, FormattedMessage, Nullable<List<Verb>>)

Fills the examine tooltip with a message and buttons if applicable.

Declaration
public void UpdateTooltipInfo(EntityUid player, EntityUid target, FormattedMessage message, List<Verb>? verbs = null)
Parameters
Type Name Description
EntityUid player
EntityUid target
Robust.Shared.Utility.FormattedMessage message
System.Nullable<List<Verb>> verbs
| Improve this Doc View Source

VerbButtonPressed(BaseButton.ButtonEventArgs)

Declaration
public void VerbButtonPressed(BaseButton.ButtonEventArgs obj)
Parameters
Type Name Description
Robust.Client.UserInterface.Controls.BaseButton.ButtonEventArgs obj

Implements

EntitySystem