suprcheese / squeak-through Goto Github PK

Hi,

I've had to give up my leisure time to tweak one of my mods to undo unwanted changes created by your mod. The entity in question was a 2x2 lamp which already had an extremely generous collision box which was perfectly possible to walk around. Your mod reduced the collision box so much that the lamps could be placed in a way that made them overlap. This was completely unintended and unwanted behaviour and it was me that had to field the complaints and undo the damage. I shouldn't have to add conditional code to my mods to safeguard them against unwanted interference by third parties. Nor should I have to maintain an exception list for every mod I make and pressure you to include it in your code.

Squeak Through should stop messing with entities from other mods, period. Confine it to vanilla entities where the properties are well known. Other modders are perfectly capable of designing their own collision boxes how they want them.

I will be marking ST as "incompatible" in any future mod I publish until this issue is resolved.

disregard- solved

The steel-vaporiser is conflicting with squeak through

ive already fixed this issue it just needs to merged

#16

Title says it all :)

Other than that, everything was squeakthroughable in my vanilla+ playthrough so far.

I have encountered an unpleasant problem. For example, when I cut down a tree,
it seems that the map is updated for this chunk. Afterwards the forest looks much thinner than before, probably the map also uses the hitboxes to calculate its representation. This unfortunately leads to very unsightly artifacts everywhere on the map where I was active.

Actually not a big problem, but it's a thorn in my eye, since I deliberately play on a densely forested map for visual reasons.

Fortunately the effect can be reversed and I can fix the optics in the places where it really bothers me.

At this point a thank you for your super mod!

Before:

After:

Squeak Through should look for a property named "squeak_behaviour" (or some other name) on modded entities. The property will allow mod authors to stop ST from causing problems with their entities.
The property is a boolean where true tells ST to enable squeaking for this entity, and false tells it to ignore the entity.
If the property does not exist, then the user will decide what to do with it, by changing a setting. Possible values for this setting:

• Opt-in: entities that do not specify squeak_behaviour will not be affected
• Opt-out: entities that do not specify squeak_behaviour will be affected
• Force: all entities will be affected, regardless of squeak_behaviour. The user should be warned not to report bugs when using this, as it effectively disables this whole system. I'm proposing this option for users who do not experience problems from the current state of ST, so that they won't have to change their muscle-memory.

I recommend that the default value for the user setting should be Opt-out, as it does not change the status quo for mods that don't utilize this.

I'm willing to implement this, but I'll have to find the time to do so, and I can't tell when I can get started. I have implemented this feature, see PR below.

Crashes game on load if both are enabled.