Class SharedPinpointerSystem

Inheritance

System.Object

SharedPinpointerSystem

Namespace: Content.Shared.Pinpointer

Assembly: Content.Shared.dll

Syntax

public abstract class SharedPinpointerSystem : EntitySystem

Methods

| Improve this Doc View Source

Initialize()

Declaration

public override void Initialize()

| Improve this Doc View Source

SetActive(EntityUid, Boolean, PinpointerComponent)

Activate/deactivate pinpointer screen. If it has target it will start tracking it.

Declaration

public void SetActive(EntityUid uid, bool isActive, PinpointerComponent pinpointer = null)

Parameters

Type	Name	Description
EntityUid	uid
System.Boolean	isActive
PinpointerComponent	pinpointer

| Improve this Doc View Source

SetDistance(EntityUid, Distance, PinpointerComponent)

Manually set distance from pinpointer to target

Declaration

public void SetDistance(EntityUid uid, Distance distance, PinpointerComponent pinpointer = null)

Parameters

Type	Name	Description
EntityUid	uid
Distance	distance
PinpointerComponent	pinpointer

| Improve this Doc View Source

SetTarget(EntityUid, Nullable<EntityUid>, PinpointerComponent)

Set pinpointers target to track

Declaration

public void SetTarget(EntityUid uid, EntityUid? target, PinpointerComponent pinpointer = null)

Parameters

Type	Name	Description
EntityUid	uid
System.Nullable<EntityUid>	target
PinpointerComponent	pinpointer

| Improve this Doc View Source

TogglePinpointer(EntityUid, PinpointerComponent)

Toggle Pinpointer screen. If it has target it will start tracking it.

Declaration

public bool TogglePinpointer(EntityUid uid, PinpointerComponent pinpointer = null)

Parameters

Type	Name	Description
EntityUid	uid
PinpointerComponent	pinpointer

Returns

Type	Description
System.Boolean	True if pinpointer was activated, false otherwise

| Improve this Doc View Source

TrySetArrowAngle(EntityUid, Angle, PinpointerComponent)

Try to manually set pinpointer arrow direction. If difference between current angle and new angle is smaller than pinpointer precision, new value will be ignored and it will return false.

Declaration

public bool TrySetArrowAngle(EntityUid uid, Angle arrowAngle, PinpointerComponent pinpointer = null)

Parameters

Type	Name	Description
EntityUid	uid
Angle	arrowAngle
PinpointerComponent	pinpointer

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

UpdateDirectionToTarget(EntityUid, PinpointerComponent)

Update direction from pinpointer to selected target (if it was set)

Declaration

protected virtual void UpdateDirectionToTarget(EntityUid uid, PinpointerComponent pinpointer = null)

Parameters

Type	Name	Description
EntityUid	uid
PinpointerComponent	pinpointer