pocketmine\event\world\WorldParticleEvent Class Reference

Inheritance diagram for pocketmine\event\world\WorldParticleEvent:

Collaboration diagram for pocketmine\event\world\WorldParticleEvent:

Public Member Functions
	__construct (World $world, private Particle $particle, private Vector3 $position, private array $recipients)
	call ()
	getEventName ()
	getParticle ()
	getPosition ()
	getRecipients ()
	getWorld ()
	isCancelled ()
	setParticle (Particle $particle)
	setRecipients (array $recipients)

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Detailed Description

Definition at line 33 of file WorldParticleEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\world\WorldParticleEvent::__construct	(	World	$world,
		private Particle	$particle,
		private Vector3	$position,
		private array	$recipients
	)

Parameters

Player[]

$recipients

Definition at line 39 of file WorldParticleEvent.php.

Member Function Documentation

call()

pocketmine\event\Event::call ( )

inherited

Calls event handlers registered for this event.

Exceptions

RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getParticle()

pocketmine\event\world\WorldParticleEvent::getParticle

(

)

Definition at line 48 of file WorldParticleEvent.php.

getPosition()

pocketmine\event\world\WorldParticleEvent::getPosition

(

)

Definition at line 56 of file WorldParticleEvent.php.

getRecipients()

pocketmine\event\world\WorldParticleEvent::getRecipients

(

)

Returns

Player[]

Definition at line 63 of file WorldParticleEvent.php.

getWorld()

pocketmine\event\world\WorldEvent::getWorld ( )

inherited

Definition at line 35 of file WorldEvent.php.

hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

staticinherited

Returns whether the current class context has any registered global handlers. This can be used in hot code paths to avoid unnecessary event object creation.

Usage: SomeEventClass::hasHandlers()

Definition at line 77 of file Event.php.

isCancelled()

pocketmine\event\Cancellable::isCancelled ( )

inherited

Returns whether this instance of the event is currently cancelled.

If it is cancelled, only downstream handlers that declare @handleCancelled will be called with this event.

setParticle()

pocketmine\event\world\WorldParticleEvent::setParticle

(

Particle

$particle

)

Definition at line 52 of file WorldParticleEvent.php.

setRecipients()

pocketmine\event\world\WorldParticleEvent::setRecipients

(

array

$recipients

)

Parameters

Player[]

$recipients

Definition at line 70 of file WorldParticleEvent.php.

Member Data Documentation

$eventName

string pocketmine\event\Event::$eventName = null

protectedinherited

Definition at line 38 of file Event.php.

---

The documentation for this class was generated from the following file:

• WorldParticleEvent.php