PocketMine-MP 5.15.1 git-08c6e63aac45a450fe3b437616ee8aa2500e04e2
pocketmine\event\Cancellable Interface Reference

Inherited by pocketmine\event\block\BaseBlockChangeEvent, pocketmine\event\block\BlockBreakEvent, pocketmine\event\block\BlockBurnEvent, pocketmine\event\block\BlockItemPickupEvent, pocketmine\event\block\BlockPlaceEvent, pocketmine\event\block\BlockTeleportEvent, pocketmine\event\block\BlockUpdateEvent, pocketmine\event\block\BrewItemEvent, pocketmine\event\block\BrewingFuelUseEvent, pocketmine\event\block\ChestPairEvent, pocketmine\event\block\FarmlandHydrationChangeEvent, pocketmine\event\block\LeavesDecayEvent, pocketmine\event\block\SignChangeEvent, pocketmine\event\block\StructureGrowEvent, pocketmine\event\entity\EntityBlockChangeEvent, pocketmine\event\entity\EntityCombustEvent, pocketmine\event\entity\EntityDamageEvent, pocketmine\event\entity\EntityEffectEvent, pocketmine\event\entity\EntityExplodeEvent, pocketmine\event\entity\EntityItemPickupEvent, pocketmine\event\entity\EntityMotionEvent, pocketmine\event\entity\EntityPreExplodeEvent, pocketmine\event\entity\EntityRegainHealthEvent, pocketmine\event\entity\EntityShootBowEvent, pocketmine\event\entity\EntityTeleportEvent, pocketmine\event\entity\EntityTrampleFarmlandEvent, pocketmine\event\entity\ItemDespawnEvent, pocketmine\event\entity\ItemMergeEvent, pocketmine\event\entity\ProjectileLaunchEvent, pocketmine\event\inventory\CraftItemEvent, pocketmine\event\inventory\FurnaceBurnEvent, pocketmine\event\inventory\FurnaceSmeltEvent, pocketmine\event\inventory\InventoryOpenEvent, pocketmine\event\inventory\InventoryTransactionEvent, pocketmine\event\player\PlayerBedEnterEvent, pocketmine\event\player\PlayerBlockPickEvent, pocketmine\event\player\PlayerBucketEvent, pocketmine\event\player\PlayerChangeSkinEvent, pocketmine\event\player\PlayerChatEvent, pocketmine\event\player\PlayerDataSaveEvent, pocketmine\event\player\PlayerDropItemEvent, pocketmine\event\player\PlayerDuplicateLoginEvent, pocketmine\event\player\PlayerEditBookEvent, pocketmine\event\player\PlayerEmoteEvent, pocketmine\event\player\PlayerEnchantingOptionsRequestEvent, pocketmine\event\player\PlayerEntityInteractEvent, pocketmine\event\player\PlayerExhaustEvent, pocketmine\event\player\PlayerExperienceChangeEvent, pocketmine\event\player\PlayerGameModeChangeEvent, pocketmine\event\player\PlayerInteractEvent, pocketmine\event\player\PlayerItemConsumeEvent, pocketmine\event\player\PlayerItemEnchantEvent, pocketmine\event\player\PlayerItemHeldEvent, pocketmine\event\player\PlayerItemUseEvent, pocketmine\event\player\PlayerKickEvent, pocketmine\event\player\PlayerLoginEvent, pocketmine\event\player\PlayerMissSwingEvent, pocketmine\event\player\PlayerMoveEvent, pocketmine\event\player\PlayerToggleFlightEvent, pocketmine\event\player\PlayerToggleGlideEvent, pocketmine\event\player\PlayerToggleSneakEvent, pocketmine\event\player\PlayerToggleSprintEvent, pocketmine\event\player\PlayerToggleSwimEvent, pocketmine\event\player\PlayerTransferEvent, pocketmine\event\server\CommandEvent, pocketmine\event\server\DataPacketDecodeEvent, pocketmine\event\server\DataPacketReceiveEvent, pocketmine\event\server\DataPacketSendEvent, pocketmine\event\server\NetworkInterfaceRegisterEvent, pocketmine\event\world\ChunkUnloadEvent, pocketmine\event\world\WorldParticleEvent, pocketmine\event\world\WorldSoundEvent, and pocketmine\event\world\WorldUnloadEvent.

+ Collaboration diagram for pocketmine\event\Cancellable:

Public Member Functions

 isCancelled ()
 

Detailed Description

This interface is implemented by an Event subclass if and only if it can be cancelled.

The cancellation of an event directly affects whether downstream event handlers without @handleCancelled will be called with this event. Implementations may provide a direct setter for cancellation (typically by using CancellableTrait) or implement an alternative logic (such as a function on another data field) for isCancelled().

Definition at line 34 of file Cancellable.php.

Member Function Documentation

◆ isCancelled()

pocketmine\event\Cancellable::isCancelled ( )

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.


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