Class ExamineSystemShared

Inheritance

System.Object

ExamineSystemShared

ExamineSystem

ExamineSystem

Implements

EntitySystem

Namespace: Content.Shared.Examine

Assembly: Content.Shared.dll

Syntax

public abstract class ExamineSystemShared : EntitySystem, EntitySystem

Fields

CritExamineRange

Examine range to use when the examiner is in critical condition.

Declaration

public const float CritExamineRange = null

Field Value

Type	Description
System.Single

Remarks

Detailed examinations are disabled while incapactiated. Ideally this should just be set equal to the radius of the crit overlay that blackens most of the screen. The actual radius of that is defined in a shader sooo... eh.

DeadExamineRange

Examine range to use when the examiner is dead. See CritExamineRange.

Declaration

public const float DeadExamineRange = null

Field Value

Type	Description
System.Single

DefaultIconTexture

Declaration

public const string DefaultIconTexture = null

Field Value

Type	Description
System.String

ExamineDetailsRange

Declaration

protected const float ExamineDetailsRange = null

Field Value

Type	Description
System.Single

ExamineRange

Declaration

public const float ExamineRange = null

Field Value

Type	Description
System.Single

MaxRaycastRange

Declaration

public const float MaxRaycastRange = null

Field Value

Type	Description
System.Single

MobStateSystem

Declaration

protected readonly MobStateSystem MobStateSystem

Field Value

Type	Description
MobStateSystem

Methods

AddDetailedExamineVerb(GetVerbsEvent<ExamineVerb>, Component, ExamineEntry, String, String, String)

Either adds a details examine verb, or sends the details to a GroupExamineComponent if it finds one.

Declaration

public void AddDetailedExamineVerb(GetVerbsEvent<ExamineVerb> verbsEvent, Component component, ExamineEntry entry, string verbText, string iconTexture = null, string hoverMessage = "")

Parameters

Type	Name	Description
GetVerbsEvent<ExamineVerb>	verbsEvent
Component	component
ExamineEntry	entry
System.String	verbText
System.String	iconTexture
System.String	hoverMessage

AddDetailedExamineVerb(GetVerbsEvent<ExamineVerb>, Component, List<ExamineEntry>, String, String, String)

Either sends the details to a GroupExamineComponent if it finds one, or adds a details examine verb itself.

Declaration

public void AddDetailedExamineVerb(GetVerbsEvent<ExamineVerb> verbsEvent, Component component, List<ExamineEntry> entries, string verbText, string iconTexture = null, string hoverMessage = "")

Parameters

Type	Name	Description
GetVerbsEvent<ExamineVerb>	verbsEvent
Component	component
List<ExamineEntry>	entries
System.String	verbText
System.String	iconTexture
System.String	hoverMessage

AddDetailedExamineVerb(GetVerbsEvent<ExamineVerb>, Component, FormattedMessage, String, String, String)

Either adds a details examine verb, or sends the details to a GroupExamineComponent if it finds one.

Declaration

public void AddDetailedExamineVerb(GetVerbsEvent<ExamineVerb> verbsEvent, Component component, FormattedMessage message, string verbText, string iconTexture = null, string hoverMessage = "")

Parameters

Type	Name	Description
GetVerbsEvent<ExamineVerb>	verbsEvent
Component	component
Robust.Shared.Utility.FormattedMessage	message
System.String	verbText
System.String	iconTexture
System.String	hoverMessage

CanExamine(EntityUid, EntityUid)

Declaration

public bool CanExamine(EntityUid examiner, EntityUid examined)

Parameters

Type	Name	Description
EntityUid	examiner
EntityUid	examined

Returns

Type	Description
System.Boolean

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

Declaration

public virtual 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

EntityHasComponent(EntityUid, List<String>)

Checks if the entity uid has any of the listed components.

Declaration

public bool EntityHasComponent(EntityUid uid, List<string> components)

Parameters

Type	Name	Description
EntityUid	uid
List<System.String>	components

Returns

Type	Description
System.Boolean

GetExaminerRange(EntityUid, MobStateComponent)

Check if a given examiner is incapacitated. If yes, return a reduced examine range. Otherwise, return the deault range.

Declaration

public float GetExaminerRange(EntityUid examiner, MobStateComponent mobState = null)

Parameters

Type	Name	Description
EntityUid	examiner
MobStateComponent	mobState

Returns

Type	Description
System.Single

GetExamineText(EntityUid, Nullable<EntityUid>)

Declaration

public FormattedMessage GetExamineText(EntityUid entity, EntityUid? examiner)

Parameters

Type	Name	Description
EntityUid	entity
System.Nullable<EntityUid>	examiner

Returns

Type	Description
Robust.Shared.Utility.FormattedMessage

GetFormattedMessageFromExamineEntries(List<ExamineEntry>)

Declaration

public static FormattedMessage GetFormattedMessageFromExamineEntries(List<ExamineEntry> entries)

Parameters

Type	Name	Description
List<ExamineEntry>	entries

Returns

Type	Description
Robust.Shared.Utility.FormattedMessage	A FormattedMessage based on all entries, sorted.

Initialize()

Declaration

public override void Initialize()

InRangeUnOccluded(EntityUid, EntityUid, Single, SharedInteractionSystem.Ignored, Boolean)

Declaration

public static bool InRangeUnOccluded(EntityUid origin, EntityUid other, float range, SharedInteractionSystem.Ignored predicate, bool ignoreInsideBlocker = true)

Parameters

Type	Name	Description
EntityUid	origin
EntityUid	other
System.Single	range
SharedInteractionSystem.Ignored	predicate
System.Boolean	ignoreInsideBlocker

Returns

Type	Description
System.Boolean

InRangeUnOccluded(EntityUid, IComponent, Single, SharedInteractionSystem.Ignored, Boolean)

Declaration

public static bool InRangeUnOccluded(EntityUid origin, IComponent other, float range, SharedInteractionSystem.Ignored predicate, bool ignoreInsideBlocker = true)

Parameters

Type	Name	Description
EntityUid	origin
IComponent	other
System.Single	range
SharedInteractionSystem.Ignored	predicate
System.Boolean	ignoreInsideBlocker

Returns

Type	Description
System.Boolean

InRangeUnOccluded(EntityUid, EntityCoordinates, Single, SharedInteractionSystem.Ignored, Boolean)

Declaration

public static bool InRangeUnOccluded(EntityUid origin, EntityCoordinates other, float range, SharedInteractionSystem.Ignored predicate, bool ignoreInsideBlocker = true)

Parameters

Type	Name	Description
EntityUid	origin
Robust.Shared.Map.EntityCoordinates	other
System.Single	range
SharedInteractionSystem.Ignored	predicate
System.Boolean	ignoreInsideBlocker

Returns

Type	Description
System.Boolean

InRangeUnOccluded(EntityUid, MapCoordinates, Single, SharedInteractionSystem.Ignored, Boolean)

Declaration

public static bool InRangeUnOccluded(EntityUid origin, MapCoordinates other, float range, SharedInteractionSystem.Ignored predicate, bool ignoreInsideBlocker = true)

Parameters

Type	Name	Description
EntityUid	origin
Robust.Shared.Map.MapCoordinates	other
System.Single	range
SharedInteractionSystem.Ignored	predicate
System.Boolean	ignoreInsideBlocker

Returns

Type	Description
System.Boolean

InRangeUnOccluded(MapCoordinates, MapCoordinates, Single, SharedInteractionSystem.Ignored, Boolean, Nullable<IEntityManager>)

Declaration

public static bool InRangeUnOccluded(MapCoordinates origin, MapCoordinates other, float range, SharedInteractionSystem.Ignored predicate, bool ignoreInsideBlocker = true, IEntityManager? entMan = null)

Parameters

Type	Name	Description
Robust.Shared.Map.MapCoordinates	origin
Robust.Shared.Map.MapCoordinates	other
System.Single	range
SharedInteractionSystem.Ignored	predicate
System.Boolean	ignoreInsideBlocker
System.Nullable<IEntityManager>	entMan

Returns

Type	Description
System.Boolean

InRangeUnOccluded<TState>(MapCoordinates, MapCoordinates, Single, TState, Func<EntityUid, TState, Boolean>, Boolean, Nullable<IEntityManager>)

Declaration

public static bool InRangeUnOccluded<TState>(MapCoordinates origin, MapCoordinates other, float range, TState state, Func<EntityUid, TState, bool> predicate, bool ignoreInsideBlocker = true, IEntityManager? entMan = null)

Parameters

Type	Name	Description
Robust.Shared.Map.MapCoordinates	origin
Robust.Shared.Map.MapCoordinates	other
System.Single	range
TState	state
Func<EntityUid, TState, System.Boolean>	predicate
System.Boolean	ignoreInsideBlocker
System.Nullable<IEntityManager>	entMan

Returns

Type	Description
System.Boolean

Type Parameters

Name	Description
TState

IsInDetailsRange(EntityUid, EntityUid)

Declaration

public bool IsInDetailsRange(EntityUid examiner, EntityUid entity)

Parameters

Type	Name	Description
EntityUid	examiner
EntityUid	entity

Returns

Type	Description
System.Boolean

IsOccluded(EntityUid)

True if occluders are drawn for this entity, otherwise false.

Declaration

public bool IsOccluded(EntityUid uid)

Parameters

Type	Name	Description
EntityUid	uid

Returns

Type	Description
System.Boolean

SendExamineGroup(EntityUid, EntityUid, ExamineGroup)

Sends an ExamineTooltip based on the contents of group

Declaration

public void SendExamineGroup(EntityUid user, EntityUid target, ExamineGroup group)

Parameters

Type	Name	Description
EntityUid	user
EntityUid	target
ExamineGroup	group

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

Creates a new examine tooltip with arbitrary info.

Declaration

public abstract 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

Implements

EntitySystem