EffectAddBeforeEvent

Interface in @minecraft/server

Extends CancellableEvent

An effect about to start on a player, from a potion, command or plugin.

import type { EffectAddBeforeEvent } from '@minecraft/server';

Subscribe to it with world.beforeEvents.effectAdd.

Example

TypeScript JavaScript

import { world, type EffectAddBeforeEvent } from '@minecraft/server';

world.beforeEvents.effectAdd.subscribe((event: EffectAddBeforeEvent) => {
    console.log('effectAdd', event.entity.typeId, event.effectType, event.duration);

    // Uncomment to stop it from happening.
    // event.cancel = true;
});

import { world } from '@minecraft/server';

world.beforeEvents.effectAdd.subscribe((event) => {
    console.log('effectAdd', event.entity.typeId, event.effectType, event.duration);

    // Uncomment to stop it from happening.
    // event.cancel = true;
});

Properties

entity

read-only

readonly entity: Entity;

Types

Entity

effectType

read-only

readonly effectType: string;

As minecraft:speed.

duration

duration: number;

Ticks it lasts, which handlers may change.

Used by

WorldBeforeEvents.effectAdd, EffectAddBeforeEventSignal.subscribe, EffectAddBeforeEventSignal.unsubscribe

Inherited

From CancellableEvent: cancel