Show / Hide Table of Contents

Class BaseTargetActionComponent

Inheritance
System.Object
BaseActionComponent
BaseTargetActionComponent
EntityTargetActionComponent
WorldTargetActionComponent
Namespace: Content.Shared.Actions
Assembly: Content.Shared.dll
Syntax
public abstract class BaseTargetActionComponent : BaseActionComponent

Fields

| Improve this Doc View Source

CheckCanAccess

Whether the action system should block this action if the user cannot actually access the target (unobstructed, in inventory, in backpack, etc). Some spells or abilities may want to disable this and implement their own checks.

Declaration
public bool CheckCanAccess
Field Value
Type Description
System.Boolean
Remarks

Even if this is false, the Range will still be checked.

| Improve this Doc View Source

DeselectOnMiss

For entity- or map-targeting action, determines whether the action is deselected if the user doesn't click a valid target.

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

InteractOnMiss

If the target is invalid, this bool determines whether the left-click will default to performing a standard-interaction

Declaration
public bool InteractOnMiss
Field Value
Type Description
System.Boolean
Remarks

Interactions will still be blocked if the target-validation generates a pop-up

| Improve this Doc View Source

Range

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

Repeat

For entity- or map-targeting actions, if this is true the action will remain selected after it is used, so it can be continuously re-used. If this is false, the action will be deselected after one use.

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

TargetingIndicator

If true, and if is enabled, then this action's icon will be drawn by that over lay in place of the currently held item "held item".

Declaration
public bool TargetingIndicator
Field Value
Type Description
System.Boolean
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾