Water Overlay Effects - Redux

[kugamo]

About the pull request

Sequel to : #1593

This PR adds an efffect on mobs when they enter water which displays an overlay on them, the result being they look like they've entered the water. This is better I think than just walking and standing atop waters' surface. Applies to Humans, Xenos, Yautja, you name it.

This effect is further accentuated by moving affected mobs "down" into the water by dynamically changing the mob's pixel_y values, as well as also having some splash sprites that animate with the mob's movement.

Waters now will have depths, starting from 2 and 4 for the coasts, down to 8 for the shallow full water tiles (like LV 624's river), then down to 12 for underwater slopes leading further down to 18 for the deepest water turfs

Water overlays will display on resting humans, but not resting xenos (would require custom culling masks be made for each xeno type twice... and then also maintained). Very deep water will completely cover resting mobs and if the mob is alive they'll have a stream of bubbles (seemed out of scope to add making them drown, but the potential is there)

Camouflaged mobs will make their splashes invisible, but still give off sound (technical limitation, I tried making their splashes visible. Problem with how humans' sprites are constructed IG)

I also added some sounds for when moving through water, and giving them off can be avoided by walking when moving through water.

Under the hood:

Open turfs when created will check their depth (new variable) and if they have any will start registering signals for when something enters them. This signal will create a water overlay effect on the mob, which if it already exists just inherits data from the turf trying to place it on the mob. this effect once it exists starts registering signals for when its mob moves, and if the mob moves to a tile with no depth the effect gets removed.

Having a water overlay for every water turf in the game is a monumental task, not to mention some turfs use the same icon and are coded to behave differently... Instead of spriting each manually for each mob type and turf type, and creating a huge maintenance overhead I opted to create a subsystem that generates these overlays before the game begins. Creating about 1300 icons in a big list. (this could be further tuned down by only generating overlays for mapped in water turfs, but we'd have to include nightmare water turfs too, and pasted in map sections wouldnt get overlays idk.) It generates an icon for each mob texture size for each water turf type, as well as some special icons (like humans resting), and if the turf is deep enough a full water overlay.

At roundstart this subsystem also changes the layer of some turfs near water, this is to prevent mobs in water from visually clipping below this turfs if standing south of them while in water, since we actually DO want turfs south of mobs in water to clip over them, to achieve the mobs looking visually below the edge of those turfs. (I briefly considered having the effect change the layerings of nearby turfs, but that seemed extremely expensive)

I had to add in a ton of fiddly stuff to get the effects to update upon their mob resting, or buckled, or hauled etc

Explain why it's good for the game

It adds deeper immersion to maps and the setting by more accurately simulating water. It does away with the visually ugly and inexplicable bars of water that water turfs used to have but have since been broken for like 5 years.

This is a huge PR, with almost 60 changed files... and I am back from a rather long hiatus from coding for CM so my style is probably out of date, and or many little stupid mistakes. This is all to say I appreciate deeply anyone willing to lend their time for a review of this monster.

Some things to note: this doesnt affect obj at all, so things like roller beds and vehicles still move atop water which can kinda look silly. I plan to make follow up PR to this one for those things if this one goes through.

Humans

Xenos

Also recorded some videos, so you all can hear the sounds

Humans in waters
https://youtu.be/iz4-UHSBAdE

Demoing no splash sounds when walking
https://youtu.be/LdYO1WTsPS8

Xeno in water
https://youtu.be/2mIfjGF-Gcw?si=zVQuuvgjt8GVc0m2

Demoing overlay changing upon Trijent water changing
https://youtu.be/GR_JWQkwHWk

Changelog

🆑
add: Added water overlay effect
code: Water overlay effect code, and subsystem
imageadd: Added splash sprites for mobs in water
imagedel: Removed depreciated and broken water overlays
soundadd: Splashes and such for moving through water
/:cl:

[Drulikar]

Not a full review but I was interested in seeing what was causing the failures.

[kugamo]

Maybe I ought to add the effect on_enter even if buckled or tossed, and just make it invisible. Then have the effect catch COMSIG_MOVABLE_UNBUCKLE and check for if its being tossed every COMSIG_MOVABLE_MOVED. This instead of the flakey TURF_ENTERED signal sends im currently using for those scenarios.

But that still leaves nothing to use in the tossed scenario, since the throwing var isnt unset until after that signal is sent

[boskoramen]

Why is this a proc? Would save us from the proc overhead if the var was just directly accessed since there is no other behavior going on here.

[kugamo]

mob's lying_angle is a protected value, and theres no other reliable way to tell which way a mob is resting without this. this is critical to know since we're adding an overlay which changes its appearance dependent on this

[fira]

looks like a typo here in the arguments

[kugamo]

I dont see it, sorry. can you tell me where exactly? :O

[fira]

I think you want qdel(src) here, don't call Destroy!

[kugamo]

alright, but thought it was best practice to let the inherit the destroy of its parents

[fira]

Ideally you should just hook this on the nightmare finished signal

[kugamo]

"the nightmare finished signal" I couldnt find one.. I found COMSIG_NIGHTMARE_APPLYING_NODE but that from a glance seemed to be called everytime an individual nightmare was finished? idk nightmare code is an enigma to me