on_deactivate: distinguish removal and unloading

[appgurueu]

• Goal of the PR: What it says on the tin.
• How does the PR work? Just propagates a boolean parameter.

Sometimes you need to be able to do removal-related cleanup, such as removing files from disk, or entries from a database. staticdata obviously isn't suitable for large data. The data shouldn't be removed if the entity is unloaded, only if it is removed.

Ready for Review.

How to test

Execute /spawnentity testentities:callback, then:

• Kill the entity.
• Execute /clearobjects.
• Go away and wait for the entity to be unloaded.

[Andrey2470T]

I wonder why on_deactivate is called also on removal at all. There's already on_death callback that is called when an object gets removed. So shouldn't it be called only on deactivation based on its name?

[appgurueu]

I wonder why on_deactivate is called also on removal at all. There's already on_death callback that is called when an object gets removed. So shouldn't it be called only on deactivation based on its name?

The docs say something different and the docs are correct (I tested this). Removal != death; death is only one specific case of removal that occurs when the HP is set to 0. clear_objects or a direct call to object:remove() may also remove an object without calling on_death, but calling on_deactivate. on_deactivate must still be called in these cases for backwards compatibility, even if calling on_remove instead might seem cleaner. So I opted for the boolean param.

[Wuzzy2]

👍 I support this. This PR is required for me to fix a bug in Repixture because I need a way to properly clean up state, and no amount Lua hackery can work around the fact my mods currently doesn't know whether the entity is removed.

[sfan5]

Looks all correct.

[SmallJoker]

LGTM