PocketMine-MP 5.15.1 git-08c6e63aac45a450fe3b437616ee8aa2500e04e2
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()

◆ 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

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