Inheritance diagram for pocketmine\event\entity\EntityExtinguishEvent:

Collaboration diagram for pocketmine\event\entity\EntityExtinguishEvent:

Public Member Functions
	__construct (Entity $entity, private int $cause)

	call ()

	getCause ()

	getEntity ()

	getEventName ()

Static Public Member Functions
static	hasHandlers ()

Public Attributes
const	CAUSE_CUSTOM = 0

const	CAUSE_FIRE_PROOF = 4

const	CAUSE_POWDER_SNOW = 7

const	CAUSE_RAIN = 6

const	CAUSE_RESPAWN = 3

const	CAUSE_TICKING = 5

const	CAUSE_WATER = 1

const	CAUSE_WATER_CAULDRON = 2

Protected Attributes
Entity	$entity

string	$eventName = null

Detailed Description

Called when an entity on fire gets extinguished.

@phpstan-extends EntityEvent<Entity>

Definition at line 33 of file EntityExtinguishEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\entity\EntityExtinguishEvent::__construct	(	Entity	$entity,
		private int	$cause )

Definition at line 43 of file EntityExtinguishEvent.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.

◆ getCause()

pocketmine\event\entity\EntityExtinguishEvent::getCause ( )

Definition at line 50 of file EntityExtinguishEvent.php.

◆ getEntity()

pocketmine\event\entity\EntityEvent::getEntity ( )

inherited

Returns: Entity @phpstan-return TEntity

Reimplemented in pocketmine\event\entity\AreaEffectCloudApplyEvent, pocketmine\event\entity\EntityDeathEvent, pocketmine\event\entity\EntityShootBowEvent, pocketmine\event\entity\ItemDespawnEvent, pocketmine\event\entity\ItemSpawnEvent, pocketmine\event\entity\ProjectileHitEvent, pocketmine\event\entity\ProjectileLaunchEvent, and pocketmine\event\player\PlayerDeathEvent.

Definition at line 43 of file EntityEvent.php.

References pocketmine\event\entity\EntityEvent\$entity.

◆ getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.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.

Member Data Documentation

◆ $entity

Entity pocketmine\event\entity\EntityEvent::$entity

protectedinherited

@phpstan-var TEntity

Definition at line 37 of file EntityEvent.php.

◆ $eventName

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

protectedinherited

Definition at line 38 of file Event.php.

◆ CAUSE_CUSTOM

const pocketmine\event\entity\EntityExtinguishEvent::CAUSE_CUSTOM = 0

Definition at line 34 of file EntityExtinguishEvent.php.

◆ CAUSE_FIRE_PROOF

const pocketmine\event\entity\EntityExtinguishEvent::CAUSE_FIRE_PROOF = 4

Definition at line 38 of file EntityExtinguishEvent.php.

◆ CAUSE_POWDER_SNOW

const pocketmine\event\entity\EntityExtinguishEvent::CAUSE_POWDER_SNOW = 7

Definition at line 41 of file EntityExtinguishEvent.php.

◆ CAUSE_RAIN

const pocketmine\event\entity\EntityExtinguishEvent::CAUSE_RAIN = 6

Definition at line 40 of file EntityExtinguishEvent.php.

◆ CAUSE_RESPAWN

const pocketmine\event\entity\EntityExtinguishEvent::CAUSE_RESPAWN = 3

Definition at line 37 of file EntityExtinguishEvent.php.

◆ CAUSE_TICKING

const pocketmine\event\entity\EntityExtinguishEvent::CAUSE_TICKING = 5

Definition at line 39 of file EntityExtinguishEvent.php.

◆ CAUSE_WATER

const pocketmine\event\entity\EntityExtinguishEvent::CAUSE_WATER = 1

Definition at line 35 of file EntityExtinguishEvent.php.

◆ CAUSE_WATER_CAULDRON

const pocketmine\event\entity\EntityExtinguishEvent::CAUSE_WATER_CAULDRON = 2

Definition at line 36 of file EntityExtinguishEvent.php.

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

EntityExtinguishEvent.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes