Fix harpy singing

[luringens]

About the PR

Some changes to when my new favourite morphotype is allowed to sing:

• Muzzled: Stops singing, prevents singing
• Zombified: Stops singing, prevents singing
• Stunned: Stops singing
• Knocked down: Stops singing
• Sleeping: Stops singing, prevents singing
• Crit/Dead: Stops singing, prevents singing
• Glimmer mute event: Stops singing, prevents singing
• Enough damage to interrupt speech: Stops singing.
• Any time you can't speak, including mime's vow or mute characters: Prevents singing.

This should fix some of the bugs listed in #180.

Why / Balance

N/A

Technical details

HarpySingerSystem now does two sets of things to enforce these rules. First it subscribes to a lot of events to close the Instrument UI when a muzzle is equipped, they're knocked down, etc. Second, it subscribes to OpenUiActionEvent and explicitly goes before ActivatableUISystem in order to intercepts the MIDI UI opening action. This allows it to run a bunch of checks to see if the harpy should be allowed to sing, and if not, stop it from opening. It also warns the player when this happens.

Media

• I have added screenshots/videos to this PR showcasing its changes ingame, or this PR does not require an ingame showcase

Breaking changes

N/A

Changelog
🆑

• fix: Harpies can now sing while cuffed, but not while muzzled, mute, zombified, or otherwise incapable of talking.
• add: You can now make a harpy stop singing by slipping, stunning, or hurting them.

[DebugOk]

Very cool

Just want to confirm something before this is merged

[luringens]

Tested the little refactor and it looks good still, but I should probably give it another round of testing tomorrow when it's not midnight and I'm liable to miss something..

[VMSolidus]

Yea, we'll want to verify that this doesn't reintroduce any new old bugs.
The following conditions need to STOP a singing harpy

• Stun
• Gagged
• Critted
• Dead
• Knocked down

The following conditions need to prevent a harpy from starting a new song

• Stunned
• Gagged
• Critted
• Dead
• Knocked Down

[luringens]

@evilexecutive Thank you for the list! I suspect this PR breaks the "Knocked down" part of it, but it should be easy to add another condition to the system now that the framework for interrupting the UI call is there. I will have a look tomorrow.

[VMSolidus]

@luringens It's more important that Knocked Down stops them from singing, rather than preventing them from starting a new song. It's intended that an annoyed player should be able to shove a harpy to get them to stop.

[luringens]

Alright, putting a checklist of things I need to add checks for and test. Let me know if anything should be added or removed from the list.
Conditions that should interrupt and/or prevent singing:

• Gagged/muzzled
• Incapacitated (crit or dead)
• Zombified
• Knocked down
• Asleep
• Muted trait
• Psionic glimmer event mute

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[VMSolidus]

The players apparently want to be able to play spooky zombie music and/or Thriller as zombie birds. I'm inclined to suggest having zombification change their instrument options to something cursed. Thats not a requirement, just a funny suggestion. Personally I lean towards zombie birds not being able to sing

[luringens]

@evilexecutive on a similar note, currently if you're typing in text chat and then you take damage from a set of categories and above a set amount, the game immediately appends something like -OOF! to the message and sends it automatically. I could reuse some of that code to stop singing when punched or otherwise taking a solid chunk of brute damage. This could be funny along with a sound effect, though for that we'd need an appropriate bird screech. Or just reuse a scream. Thoughts?

[DebugOk]

The players apparently want to be able to play spooky zombie music and/or Thriller as zombie birds. I'm inclined to suggest having zombification change their instrument options to something cursed. Thats not a requirement, just a funny suggestion. Personally I lean towards zombie birds not being able to sing

Zombie harpies shouldn't have the ability to sing anymore

[luringens]

Current implementation:

• Muzzled: Stops singing, prevents singing
• Zombified: Stops singing, prevents singing
• Stunned: Stops singing
  • Lasts so short it'll take longer to reopen the window and pick a file than the effect lasts anyways. And for consistency, stun doesn't prevent talking or cause stutter either.
• Knocked down: Stops singing
  • As above. Also means that harpies that have lost their wheelchair can sing even if they can't stand up.
• Sleeping: Stops singing, prevents singing (through !CanSpeak)
• Crit/Dead: Stops singing, prevents singing (through !CanSpeak)
• !CanSpeak: Prevents singing.

Turns out CanSpeak is a thing. Anytime you can't speak in chat, you now can't sing. This covers crit, dead, asleep, or being mute, simplying the code quite a bit. This should mean you can't sing while glimmer muted, and that mimes can't sing without breaking their wov of silence. Whether or not the latter makes sense I guess depends on how that vow is interpreted.

[VMSolidus]

The latter example of Mime harpies not being able to sing is absolutely correct. Mimes should not he making ANY noise at all, as its part of their act. Being able to sing or imitate sounds would ruin the act, so I will say this counts for intended behavior.

My last question regarding implementation, does the !CanSpeak also stop a song in the case of the mute glimmer event? If it does, I wholeheartedly approve of these changes, you are doing amazingly good work!

[VMSolidus]

Also as an aside, since !CanSpeak applies to Mute characters, yes that is also an intended feature that Mute harpies cannot sing. Which its good that we're covering that base too.

[luringens]

I've added a handler that should stop singing when a "Muted" status effect is applied. PsionicCatGotYourTongueRule should trigger this, but I could not figure out how to force a station event to test it.

Do you want harpies to stop singing when taking 10+ brute/burn damage, the same way DamageForceSaySystem does it?

[VMSolidus]

Yea, I will also agree that taking a chunk of damage like that should interrupt them. If it interrupts speech, it should also interrupt singing. Im all for having more options for players to get birds to shut up. This would also add some interesting emergent gameplay options. Such as a harpy salvager singing so that their team knows they're okay, and if something stops them, their team would know they're in trouble.

Design wise, this is their main mechanical positive. They have no other mechanical benefits to weigh against their downsides, so adding mechanical complexity to this feature helps distinguish them more.

[luringens]

Alright! Singing is now interrupted by the same criteria that speech is interrupted. I have updated the changelog and PR description, I think this is ready for review again now.

[DebugOk]

I've added a handler that should stop singing when a "Muted" status effect is applied. PsionicCatGotYourTongueRule should trigger this, but I could not figure out how to force a station event to test it.

Do you want harpies to stop singing when taking 10+ brute/burn damage, the same way DamageForceSaySystem does it?

addgamerule PsionicCatGotYourTongue, but it's broken anyways

[luringens]

Rewrote (force-pushed) those two commits to fix the committer metadata, no change to prior history. Sorry about that.

[luringens]

🎉