EffectCollection

class · pocketmine\entity\effect\EffectCollection · source

Properties

$bubbleColor protected

protected \pocketmine\color\Color $bubbleColor

$effectAddHooks protected

protected \pocketmine\utils\ObjectSet $effectAddHooks

$effectFilterForBubbles protected

protected \Closure $effectFilterForBubbles

Validates whether an effect will be used for bubbles color calculation.

$effectRemoveHooks protected

protected \pocketmine\utils\ObjectSet $effectRemoveHooks

$effects protected

protected array $effects

$onlyAmbientEffects protected

protected bool $onlyAmbientEffects

Methods

__construct()

public function __construct()

add()

public function add(\pocketmine\entity\effect\EffectInstance $effect) : bool

Adds an effect to the collection. Existing effects of the same type will be replaced if self::canAdd() returns true.

all()

public function all() : array

Returns all the effects in the collection, indexed by spl_object_id of the effect type.

canAdd()

public function canAdd(\pocketmine\entity\effect\EffectInstance $effect) : bool

In the following cases it will return true:

• if the effect type is not already applied
• if an existing effect of the same type can be replaced (due to shorter duration or lower level)

clear()

public function clear() : void

Removes all effects.

get()

public function get(\pocketmine\entity\effect\Effect $effect) : ?\pocketmine\entity\effect\EffectInstance

Returns the effect instance active with the specified ID, or null if does not have the effect.

getBubbleColor()

public function getBubbleColor() : \pocketmine\color\Color

getEffectAddHooks()

public function getEffectAddHooks() : \pocketmine\utils\ObjectSet

getEffectRemoveHooks()

public function getEffectRemoveHooks() : \pocketmine\utils\ObjectSet

has()

public function has(\pocketmine\entity\effect\Effect $effect) : bool

Returns whether the specified effect is active.

hasOnlyAmbientEffects()

public function hasOnlyAmbientEffects() : bool

recalculateEffectColor() protected

protected function recalculateEffectColor() : void

Recalculates the potion bubbles colour based on the active effects.

remove()

public function remove(\pocketmine\entity\effect\Effect $effectType) : void

Removes the effect with the specified ID.

setEffectFilterForBubbles()

public function setEffectFilterForBubbles(\Closure $filter) : void

Sets the filter that determines which effects will be displayed in the bubbles.