Show / Hide Table of Contents

Class TriggerOnProximityComponent

Raises a TriggerEvent whenever an entity collides with a fixture attached to the owner of this component.

Inheritance
System.Object
SharedTriggerOnProximityComponent
TriggerOnProximityComponent
Namespace: Content.Server.Explosion.Components
Assembly: Content.Server.dll
Syntax
public sealed class TriggerOnProximityComponent : SharedTriggerOnProximityComponent

Fields

| Improve this Doc View Source

AnimationDuration

How long the the proximity trigger animation plays for.

Declaration
public TimeSpan AnimationDuration
Field Value
Type Description
TimeSpan
| Improve this Doc View Source

Colliding

Declaration
public readonly Dictionary<EntityUid, PhysicsComponent> Colliding
Field Value
Type Description
Dictionary<EntityUid, Robust.Shared.Physics.Components.PhysicsComponent>
| Improve this Doc View Source

Cooldown

The minimum delay between repeating triggers.

Declaration
public TimeSpan Cooldown
Field Value
Type Description
TimeSpan
| Improve this Doc View Source

Enabled

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

FixtureID

Declaration
public const string FixtureID = null
Field Value
Type Description
System.String
| Improve this Doc View Source

Layer

What layer is the trigger fixture on?

Declaration
public int Layer
Field Value
Type Description
System.Int32
| Improve this Doc View Source

NextTrigger

When can the trigger run again?

Declaration
public TimeSpan NextTrigger
Field Value
Type Description
TimeSpan
| Improve this Doc View Source

NextVisualUpdate

When will the visual state be updated again after activation?

Declaration
public TimeSpan NextVisualUpdate
Field Value
Type Description
TimeSpan
| Improve this Doc View Source

Repeating

If this proximity is triggered should we continually repeat it?

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

RequiresAnchored

Whether the entity needs to be anchored for the proximity to work.

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

Shape

What is the shape of the proximity fixture?

Declaration
public IPhysShape Shape
Field Value
Type Description
Robust.Shared.Physics.Collision.Shapes.IPhysShape
| Improve this Doc View Source

TriggerSpeed

What speed should the other object be moving at to trigger the proximity fixture?

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