Show / Hide Table of Contents

Class BeforeRangedInteractEvent

Raised directed on the used object when clicking on another object before an interaction is handled.

Inheritance
System.Object
BeforeRangedInteractEvent
Namespace: Content.Shared.Interaction
Assembly: Content.Shared.dll
Syntax
public sealed class BeforeRangedInteractEvent : HandledEntityEventArgs

Constructors

| Improve this Doc View Source

BeforeRangedInteractEvent(EntityUid, EntityUid, Nullable<EntityUid>, EntityCoordinates, Boolean)

Declaration
public BeforeRangedInteractEvent(EntityUid user, EntityUid used, EntityUid? target, EntityCoordinates clickLocation, bool canReach)
Parameters
Type Name Description
EntityUid user
EntityUid used
System.Nullable<EntityUid> target
Robust.Shared.Map.EntityCoordinates clickLocation
System.Boolean canReach

Properties

| Improve this Doc View Source

CanReach

Is the click location in range and unobstructed?

Declaration
public bool CanReach { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ClickLocation

Location that the user clicked outside of their interaction range.

Declaration
public EntityCoordinates ClickLocation { get; }
Property Value
Type Description
Robust.Shared.Map.EntityCoordinates
| Improve this Doc View Source

Target

Entity that was interacted on. This can be null if the attack did not click on an entity.

Declaration
public EntityUid? Target { get; }
Property Value
Type Description
System.Nullable<EntityUid>
| Improve this Doc View Source

Used

Entity that the user used to interact.

Declaration
public EntityUid Used { get; }
Property Value
Type Description
EntityUid
| Improve this Doc View Source

User

Entity that triggered the interaction.

Declaration
public EntityUid User { get; }
Property Value
Type Description
EntityUid
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾