Overlay fixes

[Semuca]

Purpose

This PR fixes bugs that I noticed while looking at plasma fires, like player overlays, tile overlays, and Unity throwing modified collection errors in TileList.cs.

Explanation:

Overlays are now stored under the sprite gameobject in players, so they rotate whenever the player body rotates. This fixes #6429.

Tile overlays like windows smashing were added too many times because the system was not checking if an overlay was already added correctly. I overwrote the .Equals() function so they can compare in a more functional way.

Tile overlays now have a const which determines the maximum overlays allowed per tile, and some weird code has been cleaned up. Previously, the z position of overlays was increased in this order: 1, 2, 4, 7, 11. Now, they'll increase in a normal ascending order (1, 2, 3, etc).

Changelog:

CL: Fixed fire and electrocution overlay not matching the player's rotation
CL: Fixed tiles having too many overlays

[ThatDan123]

"some weird code" who would do such a thing, thanks for fixing it.

[corp-0]

so they rotate whenever the player body rotates

shouldn't flames always be upright?

[corp-0]

this loop seems to be used a lot and only slightly different each time. Can you extract it into another method to avoid duping code?

[Semuca]

Not really, because each loop does something different depending on the function it's in

[corp-0]

yes, just slightly different and as you could experience yourself now when you had to make some changes, you had to do the same changes in all loops. Try extracting the part that is identical in all instances, return what the different methods need and operate with that returned value, that way if we need to change the loop we only change it in one place.

[NoooneyDude]

I would suggest a Func delegate (take to PlayerList getInternal() and its callers for an example) however I suspect it creates garbage.

[NoooneyDude]

Actually should be fine if you only create the delegate objects once.

[Semuca]

so they rotate whenever the player body rotates

shouldn't flames always be upright?

But otherwise when the player drops the outline of the player on fire will just be left standing. If you mean wanting to have the fire rise up no matter what rotation the player is at, that's quite a big task which to me isn't all that noticeable. For now I think just rotating the overlay with the player is fine.

[NoooneyDude]

so they rotate whenever the player body rotates

shouldn't flames always be upright?

But otherwise when the player drops the outline of the player on fire will just be left standing. If you mean wanting to have the fire rise up no matter what rotation the player is at, that's quite a big task which to me isn't all that noticeable. For now I think just rotating the overlay with the player is fine.

Yeah some sort of dynamic flame sprite generation based on the current object sprite would be nice. Could be split into individual, small flame sprites determined by fire stacks and object sprite existence in that area. Could get pretty complicated.

[corp-0]

@Semuca do you think you can make the requested changes? Let us know if you find any trouble when trying.

[Semuca]

Sorry about all that, I was up to my neck in schoolwork. I need to learn about delegate functions, but that shouldn't be too much. I'll see if I can do that change on Friday.

[NoooneyDude]

Sorry about all that, I was up to my neck in schoolwork. I need to learn about delegate functions, but that shouldn't be too much. I'll see if I can do that change on Friday.

I've decided to merge this now - probably shouldn't keep player prefab in limbo. A followup PR with the refactor would be greatly appreciated, still.