Inheritance diagram for pocketmine\entity\effect\Effect:

Collaboration diagram for pocketmine\entity\effect\Effect:

Public Member Functions
	__construct (protected Translatable\|string $name, protected Color $color, protected bool $bad=false, private int $defaultDuration=600, protected bool $hasBubbles=true)

	add (Living $entity, EffectInstance $instance)

	applyEffect (Living $entity, EffectInstance $instance, float $potency=1.0, ?Entity $source=null)

	canTick (EffectInstance $instance)

	getApplyInterval (EffectInstance $instance)

	getColor ()

	getDefaultDuration ()

	getName ()

	hasBubbles ()

	isBad ()

	remove (Living $entity, EffectInstance $instance)

Detailed Description

Definition at line 33 of file Effect.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\entity\effect\Effect::__construct	(	protected Translatable\|string	$name,
		protected Color	$color,
		protected bool	$bad = false,
		private int	$defaultDuration = 600,
		protected bool	$hasBubbles = true )

Parameters

Translatable \| string	$name	Translation key used for effect name
Color	$color	Color of bubbles given by this effect
bool	$bad	Whether the effect is harmful
bool	$hasBubbles	Whether the effect has potion bubbles. Some do not (e.g. Instant Damage has its own particles instead of bubbles)

Definition at line 43 of file Effect.php.

Member Function Documentation

◆ add()

pocketmine\entity\effect\Effect::add	(	Living	$entity,
		EffectInstance	$instance )

Applies effects to the entity when the effect is first added.

Reimplemented in pocketmine\entity\effect\AbsorptionEffect, pocketmine\entity\effect\HealthBoostEffect, pocketmine\entity\effect\InvisibilityEffect, pocketmine\entity\effect\LevitationEffect, pocketmine\entity\effect\SlownessEffect, and pocketmine\entity\effect\SpeedEffect.

Definition at line 115 of file Effect.php.

◆ applyEffect()

pocketmine\entity\effect\Effect::applyEffect	(	Living	$entity,
		EffectInstance	$instance,
		float	$potency = 1.0,
		?Entity	$source = null )

Applies effect results to an entity. This will not be called unless canTick() returns true.

Reimplemented in pocketmine\entity\effect\HungerEffect, pocketmine\entity\effect\InstantDamageEffect, pocketmine\entity\effect\InstantHealthEffect, pocketmine\entity\effect\LevitationEffect, pocketmine\entity\effect\PoisonEffect, pocketmine\entity\effect\RegenerationEffect, pocketmine\entity\effect\SaturationEffect, and pocketmine\entity\effect\WitherEffect.

Definition at line 108 of file Effect.php.

◆ canTick()

pocketmine\entity\effect\Effect::canTick ( EffectInstance $instance )

Returns whether the effect will do something on the current tick.

Deprecated: Implement getApplyInterval() instead

Definition at line 91 of file Effect.php.

◆ getApplyInterval()

pocketmine\entity\effect\Effect::getApplyInterval ( EffectInstance $instance )

Returns after how many ticks applyEffect() will be called. If this returns 0, the effect will not be ticked. If it returns 1, it will be ticked every tick.

Reimplemented in pocketmine\entity\effect\HungerEffect, pocketmine\entity\effect\InstantEffect, pocketmine\entity\effect\LevitationEffect, pocketmine\entity\effect\PoisonEffect, pocketmine\entity\effect\RegenerationEffect, and pocketmine\entity\effect\WitherEffect.

Definition at line 101 of file Effect.php.

◆ getColor()

pocketmine\entity\effect\Effect::getColor ( )

Returns a Color object representing this effect's particle colour.

Definition at line 61 of file Effect.php.

Referenced by pocketmine\entity\effect\EffectInstance\__construct().

Here is the caller graph for this function:

◆ getDefaultDuration()

pocketmine\entity\effect\Effect::getDefaultDuration ( )

Returns the default duration (in ticks) this effect will apply for if a duration is not specified.

Definition at line 76 of file Effect.php.

Referenced by pocketmine\entity\effect\EffectInstance\__construct().

Here is the caller graph for this function:

◆ getName()

pocketmine\entity\effect\Effect::getName ( )

Returns the translation key used to translate this effect's name.

Definition at line 54 of file Effect.php.

◆ hasBubbles()

pocketmine\entity\effect\Effect::hasBubbles ( )

Returns whether this effect will give the subject potion bubbles.

Definition at line 83 of file Effect.php.

◆ isBad()

pocketmine\entity\effect\Effect::isBad ( )

Returns whether this effect is harmful. TODO: implement inverse effect results for undead mobs

Definition at line 69 of file Effect.php.

◆ remove()

pocketmine\entity\effect\Effect::remove	(	Living	$entity,
		EffectInstance	$instance )

Removes the effect from the entity, resetting any changed values back to their original defaults.