Explosion: add documentation for explodeA() and explodeB()

these functions really ought to be renamed, or possibly redesigned entirely. However, that's no task for a patch version.

[ci skip]
This commit is contained in:
Dylan T 2019-10-07 09:44:17 +01:00 committed by GitHub
parent ee60a7bc36
commit 247875e3d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -89,6 +89,9 @@ class Explosion{
}
/**
* Calculates which blocks will be destroyed by this explosion. If explodeB() is called without calling this, no blocks
* will be destroyed.
*
* @return bool
*/
public function explodeA() : bool{
@ -148,6 +151,12 @@ class Explosion{
return true;
}
/**
* Executes the explosion's effects on the world. This includes destroying blocks (if any), harming and knocking back entities,
* and creating sounds and particles.
*
* @return bool
*/
public function explodeB() : bool{
$send = [];
$updateBlocks = [];