Class TargetOutlineSystem

System used to indicate whether an entity is a valid target based on some criteria.

Inheritance
System.Object
TargetOutlineSystem
Namespace: Content.Client.Outline
Assembly: Content.Client.dll
Syntax
public sealed class TargetOutlineSystem : EntitySystem

Fields

| Improve this Doc View Source

CheckObstruction

Whether to check if the player is unobstructed to the target;

Declaration
public bool CheckObstruction
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

LookupSize

The size of the box around the mouse to use when looking for valid targets.

Declaration
public float LookupSize
Field Value
Type Description
System.Single
| Improve this Doc View Source

Predicate

Predicate the target must satisfy.

Declaration
public Func<EntityUid, bool>? Predicate
Field Value
Type Description
System.Nullable<Func<EntityUid, System.Boolean>>
| Improve this Doc View Source

Range

Minimum range for a target to be valid.

Declaration
public float Range
Field Value
Type Description
System.Single
Remarks

If a target is further than this distance, they will still be highlighted in a different color.

| Improve this Doc View Source

ValidationEvent

Event to raise as targets to check whether they are valid.

Declaration
public CancellableEntityEventArgs? ValidationEvent
Field Value
Type Description
System.Nullable<CancellableEntityEventArgs>
Remarks

This event will be uncanceled and re-used.

| Improve this Doc View Source

Whitelist

Whitelist that the target must satisfy.

Declaration
public EntityWhitelist Whitelist
Field Value
Type Description
EntityWhitelist

Methods

| Improve this Doc View Source

Disable()

Declaration
public void Disable()
| Improve this Doc View Source

Enable(Single, Boolean, Nullable<Func<EntityUid, Boolean>>, EntityWhitelist, Nullable<CancellableEntityEventArgs>)

Declaration
public void Enable(float range, bool checkObstructions, Func<EntityUid, bool>? predicate, EntityWhitelist whitelist, CancellableEntityEventArgs? validationEvent)
Parameters
Type Name Description
System.Single range
System.Boolean checkObstructions
System.Nullable<Func<EntityUid, System.Boolean>> predicate
EntityWhitelist whitelist
System.Nullable<CancellableEntityEventArgs> validationEvent
| Improve this Doc View Source

Initialize()

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

Update(Single)

Declaration
public override void Update(float frameTime)
Parameters
Type Name Description
System.Single frameTime