pocketmine\event\entity\EntityCombustEvent Class Reference

Inheritance diagram for pocketmine\event\entity\EntityCombustEvent:

Collaboration diagram for pocketmine\event\entity\EntityCombustEvent:

Public Member Functions
	__construct (Entity $combustee, int $duration)
	call ()
	getDuration ()
	getEntity ()
	getEventName ()
	isCancelled ()
	setDuration (int $duration)

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
int	$duration
Entity	$entity
string	$eventName = null

Detailed Description

@phpstan-extends EntityEvent<Entity>

Definition at line 33 of file EntityCombustEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\entity\EntityCombustEvent::__construct	(	Entity	$combustee,
		int	$duration )

Definition at line 38 of file EntityCombustEvent.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.

getDuration()

pocketmine\event\entity\EntityCombustEvent::getDuration

(

)

Returns the duration in seconds the entity will burn for.

Definition at line 46 of file EntityCombustEvent.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.

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.

setDuration()

pocketmine\event\entity\EntityCombustEvent::setDuration

(

int

$duration

)

Definition at line 50 of file EntityCombustEvent.php.

Member Data Documentation

$duration

int pocketmine\event\entity\EntityCombustEvent::$duration

protected

Definition at line 36 of file EntityCombustEvent.php.

$entity

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

protectedinherited

@phpstan-var TEntity

Definition at line 37 of file EntityEvent.php.

Referenced by pocketmine\event\entity\AreaEffectCloudApplyEvent\__construct(), pocketmine\event\entity\EntityDamageByBlockEvent\__construct(), pocketmine\event\entity\EntityDamageByChildEntityEvent\__construct(), pocketmine\event\entity\EntityDamageByEntityEvent\__construct(), pocketmine\event\entity\EntityDamageEvent\__construct(), pocketmine\event\entity\EntityDeathEvent\__construct(), pocketmine\event\entity\EntityExplodeEvent\__construct(), pocketmine\event\player\PlayerDeathEvent\__construct(), pocketmine\event\entity\AreaEffectCloudApplyEvent\getEntity(), pocketmine\event\entity\EntityDeathEvent\getEntity(), pocketmine\event\entity\EntityEvent\getEntity(), pocketmine\event\entity\EntityShootBowEvent\getEntity(), pocketmine\event\entity\ItemDespawnEvent\getEntity(), pocketmine\event\entity\ItemSpawnEvent\getEntity(), pocketmine\event\entity\ProjectileHitEvent\getEntity(), and pocketmine\event\entity\ProjectileLaunchEvent\getEntity().

$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:

• EntityCombustEvent.php