using Robust.Shared.GameStates;

namespace Content.Shared.Trigger.Components.Triggers;

/// <summary>
/// Triggers when this entity is swung as a melee weapon, regardless of whether it hits something.
/// </summary>
[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
public sealed partial class TriggerOnMeleeSwingComponent : BaseTriggerOnXComponent
{
    /// <summary>
    /// If true, the "user" of the trigger is the entity hit by the melee. User is null if nothing is hit.
    /// If false, user is the entity which attacked with the melee weapon.
    /// </summary>
    /// <remarks>If true and multiple targets are hit, the user is randomly chosen from hit entities.</remarks>
    [DataField, AutoNetworkedField]
    public bool TargetIsUser;
}