CatStation/Content.Shared/Flash/Components/FlashComponent.cs
Stanislav b22d38f9c0
Yaml audio params are often ignored (#36259)
* Replace WithVolume() with AddVolume(),
Remove AudioHelpers.WithVariation(),
Use specifier options for audio params

* Undo switching to AudioParams.AddVariation()

* Replace AudioHelpers.WithVariation with AudioParams.AddVariation()

* Test AudioParams.AddVariation() and change input parameters to sound like previous AudioHelpers.WithVariation()

* Fix build error

* Fix build error v2

* Remove DoAfter

* fixes

---------

Co-authored-by: AJCM-git <ajcm_mail@disroot.org>
2026-07-25 16:16:23 +00:00

85 lines
2.6 KiB
C#

using Robust.Shared.Audio;
using Robust.Shared.GameStates;
namespace Content.Shared.Flash.Components;
/// <summary>
/// Allows this entity to flash someone by using it or melee attacking with it.
/// </summary>
[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
[Access(typeof(SharedFlashSystem))]
public sealed partial class FlashComponent : Component
{
/// <summary>
/// Flash the area around the entity when used in hand?
/// </summary>
[DataField, AutoNetworkedField]
public bool FlashOnUse = true;
/// <summary>
/// Flash the area around the entity when the flash is used with ranged interaction?
/// </summary>
[DataField, AutoNetworkedField]
public bool FlashOnRangedInteract = false;
/// <summary>
/// Flash the target when melee attacking them?
/// </summary>
[DataField, AutoNetworkedField]
public bool FlashOnMelee = true;
/// <summary>
/// Time the Flash will be visually flashing after use.
/// For the actual interaction delay use UseDelayComponent.
/// These two times should be the same.
/// </summary>
[DataField, AutoNetworkedField]
public TimeSpan FlashingTime = TimeSpan.FromSeconds(4);
/// <summary>
/// For how long the target will lose vision when melee attacked with the flash.
/// </summary>
[DataField, AutoNetworkedField]
public TimeSpan MeleeDuration = TimeSpan.FromSeconds(5);
/// <summary>
/// For how long the target will lose vision when used in hand.
/// </summary>
[DataField, AutoNetworkedField]
public TimeSpan AoeFlashDuration = TimeSpan.FromSeconds(2);
/// <summary>
/// How long a target is stunned when a melee flash is used.
/// If null, melee flashes will not stun at all.
/// </summary>
[DataField, AutoNetworkedField]
public TimeSpan? MeleeStunDuration = TimeSpan.FromSeconds(1.5);
/// <summary>
/// Range of the flash when using it.
/// </summary>
[DataField, AutoNetworkedField]
public float Range = 7f;
/// <summary>
/// Movement speed multiplier for slowing down the target while they are flashed.
/// </summary>
[DataField, AutoNetworkedField]
public float SlowTo = 0.5f;
/// <summary>
/// The sound to play when flashing.
/// </summary>
[DataField, AutoNetworkedField]
public SoundSpecifier Sound = new SoundPathSpecifier("/Audio/Weapons/flash.ogg")
{
Params = AudioParams.Default.AddVolume(1f).WithMaxDistance(3f)
};
/// <summary>
/// The probability of sucessfully flashing someone.
/// </summary>
[DataField, AutoNetworkedField]
public float Probability = 1f;
}