Files
tbd-station-14/Content.Shared/Trigger/Components/Triggers/TriggerOnProximityComponent.cs
2025-08-03 21:20:37 +02:00

92 lines
3.1 KiB
C#

using Content.Shared.Physics;
using Robust.Shared.GameStates;
using Robust.Shared.Physics.Collision.Shapes;
using Robust.Shared.Physics.Components;
using Robust.Shared.Physics.Dynamics;
using Robust.Shared.Serialization.TypeSerializers.Implementations.Custom;
namespace Content.Shared.Trigger.Components.Triggers;
/// <summary>
/// Triggers whenever an entity collides with a fixture attached to the owner of this component.
/// The user is the entity that collided with the fixture.
/// </summary>
[RegisterComponent, NetworkedComponent]
[AutoGenerateComponentState, AutoGenerateComponentPause]
public sealed partial class TriggerOnProximityComponent : BaseTriggerOnXComponent
{
/// <summary>
/// The ID if the fixture that is observed for collisions.
/// </summary>
public const string FixtureID = "trigger-on-proximity-fixture";
/// <summary>
/// Currently colliding entities.
/// </summary>
[ViewVariables]
public readonly Dictionary<EntityUid, PhysicsComponent> Colliding = new();
/// <summary>
/// What is the shape of the proximity fixture?
/// </summary>
[ViewVariables]
[DataField]
public IPhysShape Shape = new PhysShapeCircle(2f);
/// <summary>
/// How long the the proximity trigger animation plays for.
/// </summary>
[DataField, AutoNetworkedField]
public TimeSpan AnimationDuration = TimeSpan.FromSeconds(0.6f);
/// <summary>
/// Whether the entity needs to be anchored for the proximity to work.
/// </summary>
[DataField, AutoNetworkedField]
public bool RequiresAnchored = true;
/// <summary>
/// Whether the proximity trigger is currently enabled.
/// </summary>
[DataField, AutoNetworkedField]
public bool Enabled = true;
/// <summary>
/// The minimum delay between repeating triggers.
/// </summary>
[DataField, AutoNetworkedField]
public TimeSpan Cooldown = TimeSpan.FromSeconds(5);
/// <summary>
/// When can the trigger run again?
/// </summary>
[DataField(customTypeSerializer: typeof(TimeOffsetSerializer))]
[AutoNetworkedField, AutoPausedField]
public TimeSpan NextTrigger = TimeSpan.Zero;
/// <summary>
/// When will the visual state be updated again after activation?
/// </summary>
[DataField(customTypeSerializer: typeof(TimeOffsetSerializer))]
[AutoNetworkedField, AutoPausedField]
public TimeSpan NextVisualUpdate = TimeSpan.Zero;
/// <summary>
/// What speed should the other object be moving at to trigger the proximity fixture?
/// </summary>
[DataField, AutoNetworkedField]
public float TriggerSpeed = 3.5f;
/// <summary>
/// If this proximity is triggered should we continually repeat it?
/// </summary>
[DataField, AutoNetworkedField]
public bool Repeating = true;
/// <summary>
/// What layer is the trigger fixture on?
/// </summary>
[DataField(customTypeSerializer: typeof(FlagSerializer<CollisionLayer>))]
public int Layer = (int)(CollisionGroup.MidImpassable | CollisionGroup.LowImpassable | CollisionGroup.HighImpassable);
}