Files
crystall-punk-14/Content.Server/VoiceMask/VoiceMaskComponent.cs

41 lines
1.3 KiB
C#
Raw Permalink Normal View History

using Content.Shared.Speech;
using Robust.Shared.Prototypes;
2022-09-28 19:22:27 -07:00
namespace Content.Server.VoiceMask;
/// <summary>
/// This component is for voice mask items! Adding this component to clothing will give the the voice mask UI
/// and allow the wearer to change their voice and verb at will.
/// </summary>
/// <remarks>
/// DO NOT use this if you do not want the interface.
/// The VoiceOverrideSystem is probably what your looking for (Or you might have to make something similar)!
/// </remarks>
2022-09-28 19:22:27 -07:00
[RegisterComponent]
public sealed partial class VoiceMaskComponent : Component
2022-09-28 19:22:27 -07:00
{
/// <summary>
/// The name that will override an entities default name. If null, it will use the default override.
/// </summary>
[DataField]
public string? VoiceMaskName = null;
/// <summary>
/// The speech verb that will override an entities default one. If null, it will use the entities default verb.
/// </summary>
[DataField]
public ProtoId<SpeechVerbPrototype>? VoiceMaskSpeechVerb;
/// <summary>
/// The action that gets displayed when the voice mask is equipped.
/// </summary>
[DataField]
public EntProtoId Action = "ActionChangeVoiceMask";
2022-09-28 19:22:27 -07:00
/// <summary>
/// Reference to the action.
/// </summary>
[DataField]
public EntityUid? ActionEntity;
2022-09-28 19:22:27 -07:00
}