civ14/Content.Server/Physics/Components/RandomWalkComponent.cs

using System.Numerics;
using Content.Server.Physics.Controllers;

namespace Content.Server.Physics.Components;

/// <summary>
/// A component which makes its entity move around at random.
/// </summary>
[RegisterComponent]
public sealed partial class RandomWalkComponent : Component
{
    /// <summary>
    /// The minimum speed at which this entity will move.
    /// </summary>
    [DataField("minSpeed")]
    [ViewVariables(VVAccess.ReadWrite)]
    public float MinSpeed = 7.5f;

    /// <summary>
    /// The maximum speed at which this entity will move.
    /// </summary>
    [DataField("maxSpeed")]
    [ViewVariables(VVAccess.ReadWrite)]
    public float MaxSpeed = 10f;

    /// <summary>
    /// The amount of speed carried over when the speed updates.
    /// </summary>
    [DataField("accumulatorRatio")]
    [ViewVariables(VVAccess.ReadWrite)]
    public float AccumulatorRatio = 0.0f;

    /// <summary>
    /// The vector by which the random walk direction is biased.
    /// </summary>
    [DataField, ViewVariables(VVAccess.ReadWrite)]
    public Vector2 BiasVector = new Vector2(0f, 0f);

    /// <summary>
    /// Whether to set BiasVector to (0, 0) every random walk update.
    /// </summary>
    [DataField, ViewVariables(VVAccess.ReadWrite)]
    public bool ResetBiasOnWalk = true;

    /// <summary>
    /// Whether this random walker should take a step immediately when it starts up.
    /// </summary>
    [DataField("stepOnStartup")]
    [ViewVariables(VVAccess.ReadOnly)]
    public bool StepOnStartup = false;

    #region Update Timing

    /// <summary>
    /// The minimum amount of time between speed updates.
    /// </summary>
    [DataField("minStepCooldown")]
    [ViewVariables(VVAccess.ReadWrite)]
    public TimeSpan MinStepCooldown { get; internal set; } = TimeSpan.FromSeconds(2.0);

    /// <summary>
    /// The maximum amount of time between speed updates.
    /// </summary>
    [DataField("maxStepCooldown")]
    [ViewVariables(VVAccess.ReadWrite)]
    public TimeSpan MaxStepCooldown { get; internal set; } = TimeSpan.FromSeconds(5.0);

    /// <summary>
    /// The next time this should update its speed.
    /// </summary>
    [ViewVariables(VVAccess.ReadWrite)]
    [Access(typeof(RandomWalkController))]
    public TimeSpan NextStepTime { get; internal set; } = default!;

    #endregion Update Timing
}