Files
wwdpublic/Content.Shared/Instruments/SharedInstrumentComponent.cs
VMSolidus ef7dc0b986 Lyre Birb Trait (#1747)
# Description

A long time ago someone told me "NO IT'S TOO OP, DON'T GIVE HARPIES A
DAW". So now I'm letting Harpies blow 10 trait points on having a DAW.
You're welcome. Yes I have actually tested this ingame, and it works.

<details><summary><h1>Media</h1></summary>
<p>

![image](https://github.com/user-attachments/assets/562a1241-8140-4627-8065-6c6d4aa17a54)

</p>
</details>

# Changelog

🆑
- add: Added "Lyre Bird" as a new trait exclusively available to
Harpies. It massively expands their ability to play Midis.

(cherry picked from commit cc91eebe70f28834f1cd3c2ce611561030a15648)
2025-02-15 00:18:05 +03:00

140 lines
3.4 KiB
C#

using System.Collections;
using Robust.Shared.Audio.Midi;
using Robust.Shared.GameStates;
using Robust.Shared.Serialization;
namespace Content.Shared.Instruments;
[NetworkedComponent]
public abstract partial class SharedInstrumentComponent : Component
{
[ViewVariables]
public bool Playing { get; set; }
[DataField("program"), ViewVariables(VVAccess.ReadWrite)]
public byte InstrumentProgram { get; set; }
[DataField("bank"), ViewVariables(VVAccess.ReadWrite)]
public byte InstrumentBank { get; set; }
[DataField("allowPercussion"), ViewVariables(VVAccess.ReadWrite)]
public bool AllowPercussion { get; set; }
[DataField("allowProgramChange"), ViewVariables(VVAccess.ReadWrite)]
public bool AllowProgramChange { get ; set; }
[DataField("respectMidiLimits"), ViewVariables(VVAccess.ReadWrite)]
public bool RespectMidiLimits { get; set; } = true;
[ViewVariables(VVAccess.ReadWrite)]
public EntityUid? Master { get; set; } = null;
[ViewVariables]
public BitArray FilteredChannels { get; set; } = new(RobustMidiEvent.MaxChannels, true);
}
[Serializable, NetSerializable]
public sealed class InstrumentComponentState : ComponentState
{
public bool Playing;
public byte InstrumentProgram;
public byte InstrumentBank;
public bool AllowPercussion;
public bool AllowProgramChange;
public bool RespectMidiLimits;
public NetEntity? Master;
public BitArray FilteredChannels = default!;
}
/// <summary>
/// This message is sent to the client to completely stop midi input and midi playback.
/// </summary>
[Serializable, NetSerializable]
public sealed class InstrumentStopMidiEvent : EntityEventArgs
{
public NetEntity Uid { get; }
public InstrumentStopMidiEvent(NetEntity uid)
{
Uid = uid;
}
}
/// <summary>
/// Send from the client to the server to set a master instrument.
/// </summary>
[Serializable, NetSerializable]
public sealed class InstrumentSetMasterEvent : EntityEventArgs
{
public NetEntity Uid { get; }
public NetEntity? Master { get; }
public InstrumentSetMasterEvent(NetEntity uid, NetEntity? master)
{
Uid = uid;
Master = master;
}
}
/// <summary>
/// Send from the client to the server to set a master instrument channel.
/// </summary>
[Serializable, NetSerializable]
public sealed class InstrumentSetFilteredChannelEvent : EntityEventArgs
{
public NetEntity Uid { get; }
public int Channel { get; }
public bool Value { get; }
public InstrumentSetFilteredChannelEvent(NetEntity uid, int channel, bool value)
{
Uid = uid;
Channel = channel;
Value = value;
}
}
/// <summary>
/// This message is sent to the client to start the synth.
/// </summary>
[Serializable, NetSerializable]
public sealed class InstrumentStartMidiEvent : EntityEventArgs
{
public NetEntity Uid { get; }
public InstrumentStartMidiEvent(NetEntity uid)
{
Uid = uid;
}
}
/// <summary>
/// This message carries a MidiEvent to be played on clients.
/// </summary>
[Serializable, NetSerializable]
public sealed class InstrumentMidiEventEvent : EntityEventArgs
{
public NetEntity Uid { get; }
public RobustMidiEvent[] MidiEvent { get; }
public InstrumentMidiEventEvent(NetEntity uid, RobustMidiEvent[] midiEvent)
{
Uid = uid;
MidiEvent = midiEvent;
}
}
[NetSerializable, Serializable]
public enum InstrumentUiKey
{
Key,
}