Files
tbd-station-14/Content.Server/NPC/Components/NPCSteeringComponent.cs
2023-07-14 00:48:04 +10:00

129 lines
3.6 KiB
C#

using System.Numerics;
using System.Threading;
using Content.Server.NPC.Pathfinding;
using Content.Shared.DoAfter;
using Content.Shared.NPC;
using Robust.Shared.Map;
using Robust.Shared.Serialization.TypeSerializers.Implementations.Custom;
namespace Content.Server.NPC.Components;
/// <summary>
/// Added to NPCs that are moving.
/// </summary>
[RegisterComponent]
public sealed class NPCSteeringComponent : Component
{
#region Context Steering
/// <summary>
/// Used to override seeking behavior for context steering.
/// </summary>
[ViewVariables]
public bool CanSeek = true;
/// <summary>
/// Radius for collision avoidance.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
public float Radius = 0.35f;
[ViewVariables]
public readonly float[] Interest = new float[SharedNPCSteeringSystem.InterestDirections];
[ViewVariables]
public readonly float[] Danger = new float[SharedNPCSteeringSystem.InterestDirections];
// TODO: Update radius, also danger points debug only
public readonly List<Vector2> DangerPoints = new();
#endregion
/// <summary>
/// Next time we can change our steering direction.
/// </summary>
[DataField("nextSteer", customTypeSerializer:typeof(TimeOffsetSerializer))]
public TimeSpan NextSteer = TimeSpan.Zero;
[DataField("lastSteerIndex")]
public int LastSteerIndex = -1;
[DataField("lastSteerDirection")]
public Vector2 LastSteerDirection = Vector2.Zero;
public const int SteeringFrequency = 5;
/// <summary>
/// Last position we considered for being stuck.
/// </summary>
[DataField("lastStuckCoordinates")]
public EntityCoordinates LastStuckCoordinates;
[DataField("lastStuckTime", customTypeSerializer:typeof(TimeOffsetSerializer))]
public TimeSpan LastStuckTime;
public const float StuckDistance = 1f;
/// <summary>
/// Have we currently requested a path.
/// </summary>
[ViewVariables]
public bool Pathfind => PathfindToken != null;
[ViewVariables] public CancellationTokenSource? PathfindToken = null;
/// <summary>
/// Current path we're following to our coordinates.
/// </summary>
[ViewVariables] public Queue<PathPoly> CurrentPath = new();
/// <summary>
/// End target that we're trying to move to.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)] public EntityCoordinates Coordinates;
/// <summary>
/// How close are we trying to get to the coordinates before being considered in range.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)] public float Range = 0.2f;
/// <summary>
/// How far does the last node in the path need to be before considering re-pathfinding.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)] public float RepathRange = 1.5f;
public const int FailedPathLimit = 3;
/// <summary>
/// How many times we've failed to pathfind. Once this hits the limit we'll stop steering.
/// </summary>
[ViewVariables] public int FailedPathCount;
[ViewVariables] public SteeringStatus Status = SteeringStatus.Moving;
[ViewVariables(VVAccess.ReadWrite)] public PathFlags Flags = PathFlags.None;
/// <summary>
/// If the NPC is using a do_after to clear an obstacle.
/// </summary>
[DataField("doAfterId")]
public DoAfterId? DoAfterId = null;
}
public enum SteeringStatus : byte
{
/// <summary>
/// If we can't reach the target (e.g. different map).
/// </summary>
NoPath,
/// <summary>
/// Are we moving towards our target
/// </summary>
Moving,
/// <summary>
/// Are we currently in range of our target.
/// </summary>
InRange,
}