Add API for explosions to damage the explosion cause

[EsotericEnderman]

This PR is to add an API feature which expands the functionality of World#createExplosion by adding the option to deal damage to the source entity (this is not the default behaviour). This deals with this issue (not technically a bug, but still something that I think should be addressed).

The API is expanded by overloading existing World#createExplosion methods with a new boolean shouldDamageSource parameter. When true, the entity specified as the source will be damaged by the explosion. Existing behaviour is not changed.

[lynxplay]

Sorry for the long delay on the initial review, this PR seems to have fallen completely under my radar.

In general, when expanding a heavily overloaded API like this, we'd only want to add one more method.

In this case public boolean createExplosion(@Nullable Entity source, @NotNull Location loc, float power, boolean setFire, boolean breakBlocks, boolean damageSource);.
Callers of as niche of an API as the damageSource flag will be, can be expected to fully define all other parameters. The amount of methods added by this patch is way too many.

Beyond that, generally LGTM, but yea, please reduce this to a single added method on World, preferably just the method signature mentioned above. Your changes will also end up in the Expand-Explosions-API patch, so if you want to merge your changes into that patch directly, that would be great. Our contribution doc has a tutorial explaining how to edit patches.

[EsotericEnderman]

Thanks for reviewing. I'll make sure to change what you requested ASAP.

I'm currently on holidays, but I'll get to it as soon as I'm back.

[EsotericEnderman]

Sorry, didn't realise that would close the PR.

So far, I've reduced the PR to add a single method, as well as merge the changes into the Expand-Explosions-API patch, as requested.

However, the build is currently failing at the javadoc task, not sure why.

[EsotericEnderman]

I believe I have fixed the issue just now.

[EsotericEnderman]

I just tested this with the test plugin, and it does damage the source entity as intended, but there's an issue with the explosion sounds and particles, which I'll look into tomorrow.

[EsotericEnderman]

Just fixed the issue with particles and sound.

[EsotericEnderman]

Just tested this using the test plugin and everything works perfectly.

[lynxplay]

The more I look at the diff the less happy I am with it.
The explosion invocation code is already ugly in vanilla with the large amounts of overload.
Having to add a boolean param to that many method seems annoying.

Not that we can really get around overloading internal methods here, but maybe a Consumer would be more suited to avoid further diff if we expand the API even more?

E.g. something like these two
https://pastebin.com/4c1ZhtL0
https://pastebin.com/J6QwPZ4Q

[EsotericEnderman]

The more I look at the diff the less happy I am with it. The explosion invocation code is already ugly in vanilla with the large amounts of overload. Having to add a boolean param to that many method seems annoying.

Not that we can really get around overloading internal methods here, but maybe a Consumer would be more suited to avoid further diff if we expand the API even more?

E.g. something like these two https://pastebin.com/4c1ZhtL0 https://pastebin.com/J6QwPZ4Q

I implemented these changes and everything seems to work.