SerenityJS
    Preparing search index...

    Interface PluginOptions

    interface PluginOptions {
        afterChunkReady?: (event: ChunkReadySignal) => void;
        afterEntityAttributeUpdate?: (event: EntityAttributeUpdateSignal) => void;
        afterEntityDespawned?: (event: EntityDespawnedSignal) => void;
        afterEntityDied?: (event: EntityDiedSignal) => void;
        afterEntityDimensionChange?: (event: EntityDimensionChangeSignal) => void;
        afterEntityDropItem?: (event: EntityDropItemSignal) => void;
        afterEntityEffectAdd?: (event: EffectAddSignal) => void;
        afterEntityEffectRemove?: (event: EffectRemoveSignal) => void;
        afterEntityFlagUpdate?: (event: EntityFlagUpdateSignal) => void;
        afterEntityHealthChange?: (event: EntityHealthChangedSignal) => void;
        afterEntityHit?: (event: EntityHitSignal) => void;
        afterEntityHurt?: (event: EntityHurtSignal) => void;
        afterEntityMetadataUpdate?: (event: EntityMetadataUpdateSignal) => void;
        afterEntitySpawned?: (event: EntitySpawnedSignal) => void;
        afterPlayerAbilityUpdate?: (event: PlayerAbilityUpdateSignal) => void;
        afterPlayerBreakBlock?: (event: PlayerBreakBlockSignal) => void;
        afterPlayerChat?: (event: PlayerChatSignal) => void;
        afterPlayerClosedContainer?: (event: PlayerClosedContainerSignal) => void;
        afterPlayerContainerInteraction?: (
            event: PlayerContainerInteractionSignal,
        ) => void;
        afterPlayerGamemodeChange?: (event: PlayerGamemodeChangeSignal) => void;
        afterPlayerInteractWithBlock?: (
            event: PlayerInteractWithBlockSignal,
        ) => void;
        afterPlayerInteractWithEntity?: (
            event: PlayerInteractWithEntitySignal,
        ) => void;
        afterPlayerJoin?: (event: PlayerJoinSignal) => void;
        afterPlayerLeave?: (event: PlayerLeaveSignal) => void;
        afterPlayerOpenedContainer?: (event: PlayerOpenedContainerSignal) => void;
        afterPlayerPlaceBlock?: (event: PlayerPlaceBlockSignal) => void;
        afterPlayerStartEmoting?: (event: PlayerStartEmotingSignal) => void;
        afterPlayerStartUsingItem?: (event: PlayerStartUsingItemSignal) => void;
        afterPlayerStopEmoting?: (event: PlayerStopEmotingSignal) => void;
        afterPlayerStopUsingItem?: (event: PlayerStopUsingItemSignal) => void;
        afterWorldInitialize?: (event: WorldInitializeSignal) => void;
        afterWorldTick?: (event: WorldTickSignal) => void;
        beforeChunkReady?: (event: ChunkReadySignal) => boolean;
        beforeEntityAttributeUpdate?: (
            event: EntityAttributeUpdateSignal,
        ) => boolean;
        beforeEntityDespawned?: (event: EntityDespawnedSignal) => boolean;
        beforeEntityDied?: (event: EntityDiedSignal) => boolean;
        beforeEntityDimensionChange?: (
            event: EntityDimensionChangeSignal,
        ) => boolean;
        beforeEntityDropItem?: (event: EntityDropItemSignal) => boolean;
        beforeEntityEffectAdd?: (event: EffectAddSignal) => boolean;
        beforeEntityEffectRemove?: (event: EffectRemoveSignal) => boolean;
        beforeEntityFlagUpdate?: (event: EntityFlagUpdateSignal) => boolean;
        beforeEntityHealthChange?: (event: EntityHealthChangedSignal) => boolean;
        beforeEntityHit?: (event: EntityHitSignal) => boolean;
        beforeEntityHurt?: (event: EntityHurtSignal) => boolean;
        beforeEntityMetadataUpdate?: (event: EntityMetadataUpdateSignal) => boolean;
        beforeEntitySpawned?: (event: EntitySpawnedSignal) => boolean;
        beforePlayerAbilityUpdate?: (event: PlayerAbilityUpdateSignal) => boolean;
        beforePlayerBreakBlock?: (event: PlayerBreakBlockSignal) => boolean;
        beforePlayerChat?: (event: PlayerChatSignal) => boolean;
        beforePlayerClosedContainer?: (
            event: PlayerClosedContainerSignal,
        ) => boolean;
        beforePlayerContainerInteraction?: (
            event: PlayerContainerInteractionSignal,
        ) => boolean;
        beforePlayerGamemodeChange?: (event: PlayerGamemodeChangeSignal) => boolean;
        beforePlayerInteractWithBlock?: (
            event: PlayerInteractWithBlockSignal,
        ) => boolean;
        beforePlayerInteractWithEntity?: (
            event: PlayerInteractWithEntitySignal,
        ) => boolean;
        beforePlayerJoin?: (event: PlayerJoinSignal) => boolean;
        beforePlayerLeave?: (event: PlayerLeaveSignal) => boolean;
        beforePlayerOpenedContainer?: (
            event: PlayerOpenedContainerSignal,
        ) => boolean;
        beforePlayerPlaceBlock?: (event: PlayerPlaceBlockSignal) => boolean;
        beforePlayerStartEmoting?: (event: PlayerStartEmotingSignal) => boolean;
        beforePlayerStartUsingItem?: (event: PlayerStartUsingItemSignal) => boolean;
        beforePlayerStopEmoting?: (event: PlayerStopEmotingSignal) => boolean;
        beforePlayerStopUsingItem?: (event: PlayerStopUsingItemSignal) => boolean;
        beforeWorldInitialize?: (event: WorldInitializeSignal) => boolean;
        beforeWorldTick?: (event: WorldTickSignal) => boolean;
        logger: Logger;
        maxListeners: number;
        onChunkReady?: (event: ChunkReadySignal) => void;
        onEntityAttributeUpdate?: (event: EntityAttributeUpdateSignal) => void;
        onEntityDespawned?: (event: EntityDespawnedSignal) => void;
        onEntityDied?: (event: EntityDiedSignal) => void;
        onEntityDimensionChange?: (event: EntityDimensionChangeSignal) => void;
        onEntityDropItem?: (event: EntityDropItemSignal) => void;
        onEntityEffectAdd?: (event: EffectAddSignal) => void;
        onEntityEffectRemove?: (event: EffectRemoveSignal) => void;
        onEntityFlagUpdate?: (event: EntityFlagUpdateSignal) => void;
        onEntityHealthChange?: (event: EntityHealthChangedSignal) => void;
        onEntityHit?: (event: EntityHitSignal) => void;
        onEntityHurt?: (event: EntityHurtSignal) => void;
        onEntityMetadataUpdate?: (event: EntityMetadataUpdateSignal) => void;
        onEntitySpawned?: (event: EntitySpawnedSignal) => void;
        onInitialize?: (plugin: Plugin) => void;
        onPlayerAbilityUpdate?: (event: PlayerAbilityUpdateSignal) => void;
        onPlayerBreakBlock?: (event: PlayerBreakBlockSignal) => void;
        onPlayerChat?: (event: PlayerChatSignal) => void;
        onPlayerClosedContainer?: (event: PlayerClosedContainerSignal) => void;
        onPlayerContainerInteraction?: (
            event: PlayerContainerInteractionSignal,
        ) => void;
        onPlayerGamemodeChange?: (event: PlayerGamemodeChangeSignal) => void;
        onPlayerInteractWithBlock?: (event: PlayerInteractWithBlockSignal) => void;
        onPlayerInteractWithEntity?: (
            event: PlayerInteractWithEntitySignal,
        ) => void;
        onPlayerJoin?: (event: PlayerJoinSignal) => void;
        onPlayerLeave?: (event: PlayerLeaveSignal) => void;
        onPlayerOpenedContainer?: (event: PlayerOpenedContainerSignal) => void;
        onPlayerPlaceBlock?: (event: PlayerPlaceBlockSignal) => void;
        onPlayerStartEmoting?: (event: PlayerStartEmotingSignal) => void;
        onPlayerStartUsingItem?: (event: PlayerStartUsingItemSignal) => void;
        onPlayerStopEmoting?: (event: PlayerStopEmotingSignal) => void;
        onPlayerStopUsingItem?: (event: PlayerStopUsingItemSignal) => void;
        onShutDown?: (plugin: Plugin) => void;
        onStartUp?: (plugin: Plugin) => void;
        onWorldInitialize?: (event: WorldInitializeSignal) => void;
        onWorldTick?: (event: WorldTickSignal) => void;
        priority: PluginPriority;
        type: PluginType;
    }

    Hierarchy

    Implemented by

    Index

    Properties

    afterChunkReady? afterEntityAttributeUpdate? afterEntityDespawned? afterEntityDied? afterEntityDimensionChange? afterEntityDropItem? afterEntityEffectAdd? afterEntityEffectRemove? afterEntityFlagUpdate? afterEntityHealthChange? afterEntityHit? afterEntityHurt? afterEntityMetadataUpdate? afterEntitySpawned? afterPlayerAbilityUpdate? afterPlayerBreakBlock? afterPlayerChat? afterPlayerClosedContainer? afterPlayerContainerInteraction? afterPlayerGamemodeChange? afterPlayerInteractWithBlock? afterPlayerInteractWithEntity? afterPlayerJoin? afterPlayerLeave? afterPlayerOpenedContainer? afterPlayerPlaceBlock? afterPlayerStartEmoting? afterPlayerStartUsingItem? afterPlayerStopEmoting? afterPlayerStopUsingItem? afterWorldInitialize? afterWorldTick? beforeChunkReady? beforeEntityAttributeUpdate? beforeEntityDespawned? beforeEntityDied? beforeEntityDimensionChange? beforeEntityDropItem? beforeEntityEffectAdd? beforeEntityEffectRemove? beforeEntityFlagUpdate? beforeEntityHealthChange? beforeEntityHit? beforeEntityHurt? beforeEntityMetadataUpdate? beforeEntitySpawned? beforePlayerAbilityUpdate? beforePlayerBreakBlock? beforePlayerChat? beforePlayerClosedContainer? beforePlayerContainerInteraction? beforePlayerGamemodeChange? beforePlayerInteractWithBlock? beforePlayerInteractWithEntity? beforePlayerJoin? beforePlayerLeave? beforePlayerOpenedContainer? beforePlayerPlaceBlock? beforePlayerStartEmoting? beforePlayerStartUsingItem? beforePlayerStopEmoting? beforePlayerStopUsingItem? beforeWorldInitialize? beforeWorldTick? logger maxListeners onChunkReady? onEntityAttributeUpdate? onEntityDespawned? onEntityDied? onEntityDimensionChange? onEntityDropItem? onEntityEffectAdd? onEntityEffectRemove? onEntityFlagUpdate? onEntityHealthChange? onEntityHit? onEntityHurt? onEntityMetadataUpdate? onEntitySpawned? onInitialize? onPlayerAbilityUpdate? onPlayerBreakBlock? onPlayerChat? onPlayerClosedContainer? onPlayerContainerInteraction? onPlayerGamemodeChange? onPlayerInteractWithBlock? onPlayerInteractWithEntity? onPlayerJoin? onPlayerLeave? onPlayerOpenedContainer? onPlayerPlaceBlock? onPlayerStartEmoting? onPlayerStartUsingItem? onPlayerStopEmoting? onPlayerStopUsingItem? onShutDown? onStartUp? onWorldInitialize? onWorldTick? priority type

    Properties

    afterChunkReady?: (event: ChunkReadySignal) => void
    afterEntityAttributeUpdate?: (event: EntityAttributeUpdateSignal) => void
    afterEntityDespawned?: (event: EntityDespawnedSignal) => void
    afterEntityDied?: (event: EntityDiedSignal) => void
    afterEntityDimensionChange?: (event: EntityDimensionChangeSignal) => void
    afterEntityDropItem?: (event: EntityDropItemSignal) => void
    afterEntityEffectAdd?: (event: EffectAddSignal) => void
    afterEntityEffectRemove?: (event: EffectRemoveSignal) => void
    afterEntityFlagUpdate?: (event: EntityFlagUpdateSignal) => void
    afterEntityHealthChange?: (event: EntityHealthChangedSignal) => void
    afterEntityHit?: (event: EntityHitSignal) => void
    afterEntityHurt?: (event: EntityHurtSignal) => void
    afterEntityMetadataUpdate?: (event: EntityMetadataUpdateSignal) => void
    afterEntitySpawned?: (event: EntitySpawnedSignal) => void
    afterPlayerAbilityUpdate?: (event: PlayerAbilityUpdateSignal) => void
    afterPlayerBreakBlock?: (event: PlayerBreakBlockSignal) => void
    afterPlayerChat?: (event: PlayerChatSignal) => void
    afterPlayerClosedContainer?: (event: PlayerClosedContainerSignal) => void
    afterPlayerContainerInteraction?: (
        event: PlayerContainerInteractionSignal,
    ) => void
    afterPlayerGamemodeChange?: (event: PlayerGamemodeChangeSignal) => void
    afterPlayerInteractWithBlock?: (event: PlayerInteractWithBlockSignal) => void
    afterPlayerInteractWithEntity?: (event: PlayerInteractWithEntitySignal) => void
    afterPlayerJoin?: (event: PlayerJoinSignal) => void
    afterPlayerLeave?: (event: PlayerLeaveSignal) => void
    afterPlayerOpenedContainer?: (event: PlayerOpenedContainerSignal) => void
    afterPlayerPlaceBlock?: (event: PlayerPlaceBlockSignal) => void
    afterPlayerStartEmoting?: (event: PlayerStartEmotingSignal) => void
    afterPlayerStartUsingItem?: (event: PlayerStartUsingItemSignal) => void
    afterPlayerStopEmoting?: (event: PlayerStopEmotingSignal) => void
    afterPlayerStopUsingItem?: (event: PlayerStopUsingItemSignal) => void
    afterWorldInitialize?: (event: WorldInitializeSignal) => void
    afterWorldTick?: (event: WorldTickSignal) => void
    beforeChunkReady?: (event: ChunkReadySignal) => boolean
    beforeEntityAttributeUpdate?: (event: EntityAttributeUpdateSignal) => boolean
    beforeEntityDespawned?: (event: EntityDespawnedSignal) => boolean
    beforeEntityDied?: (event: EntityDiedSignal) => boolean
    beforeEntityDimensionChange?: (event: EntityDimensionChangeSignal) => boolean
    beforeEntityDropItem?: (event: EntityDropItemSignal) => boolean
    beforeEntityEffectAdd?: (event: EffectAddSignal) => boolean
    beforeEntityEffectRemove?: (event: EffectRemoveSignal) => boolean
    beforeEntityFlagUpdate?: (event: EntityFlagUpdateSignal) => boolean
    beforeEntityHealthChange?: (event: EntityHealthChangedSignal) => boolean
    beforeEntityHit?: (event: EntityHitSignal) => boolean
    beforeEntityHurt?: (event: EntityHurtSignal) => boolean
    beforeEntityMetadataUpdate?: (event: EntityMetadataUpdateSignal) => boolean
    beforeEntitySpawned?: (event: EntitySpawnedSignal) => boolean
    beforePlayerAbilityUpdate?: (event: PlayerAbilityUpdateSignal) => boolean
    beforePlayerBreakBlock?: (event: PlayerBreakBlockSignal) => boolean
    beforePlayerChat?: (event: PlayerChatSignal) => boolean
    beforePlayerClosedContainer?: (event: PlayerClosedContainerSignal) => boolean
    beforePlayerContainerInteraction?: (
        event: PlayerContainerInteractionSignal,
    ) => boolean
    beforePlayerGamemodeChange?: (event: PlayerGamemodeChangeSignal) => boolean
    beforePlayerInteractWithBlock?: (
        event: PlayerInteractWithBlockSignal,
    ) => boolean
    beforePlayerInteractWithEntity?: (
        event: PlayerInteractWithEntitySignal,
    ) => boolean
    beforePlayerJoin?: (event: PlayerJoinSignal) => boolean
    beforePlayerLeave?: (event: PlayerLeaveSignal) => boolean
    beforePlayerOpenedContainer?: (event: PlayerOpenedContainerSignal) => boolean
    beforePlayerPlaceBlock?: (event: PlayerPlaceBlockSignal) => boolean
    beforePlayerStartEmoting?: (event: PlayerStartEmotingSignal) => boolean
    beforePlayerStartUsingItem?: (event: PlayerStartUsingItemSignal) => boolean
    beforePlayerStopEmoting?: (event: PlayerStopEmotingSignal) => boolean
    beforePlayerStopUsingItem?: (event: PlayerStopUsingItemSignal) => boolean
    beforeWorldInitialize?: (event: WorldInitializeSignal) => boolean
    beforeWorldTick?: (event: WorldTickSignal) => boolean
    logger: Logger

    The logger instance for the plugin.

    maxListeners: number

    The maximum number of listeners for the plugin.

    onChunkReady?: (event: ChunkReadySignal) => void
    onEntityAttributeUpdate?: (event: EntityAttributeUpdateSignal) => void
    onEntityDespawned?: (event: EntityDespawnedSignal) => void
    onEntityDied?: (event: EntityDiedSignal) => void
    onEntityDimensionChange?: (event: EntityDimensionChangeSignal) => void
    onEntityDropItem?: (event: EntityDropItemSignal) => void
    onEntityEffectAdd?: (event: EffectAddSignal) => void
    onEntityEffectRemove?: (event: EffectRemoveSignal) => void
    onEntityFlagUpdate?: (event: EntityFlagUpdateSignal) => void
    onEntityHealthChange?: (event: EntityHealthChangedSignal) => void
    onEntityHit?: (event: EntityHitSignal) => void
    onEntityHurt?: (event: EntityHurtSignal) => void
    onEntityMetadataUpdate?: (event: EntityMetadataUpdateSignal) => void
    onEntitySpawned?: (event: EntitySpawnedSignal) => void
    onInitialize?: (plugin: Plugin) => void
    onPlayerAbilityUpdate?: (event: PlayerAbilityUpdateSignal) => void
    onPlayerBreakBlock?: (event: PlayerBreakBlockSignal) => void
    onPlayerChat?: (event: PlayerChatSignal) => void
    onPlayerClosedContainer?: (event: PlayerClosedContainerSignal) => void
    onPlayerContainerInteraction?: (event: PlayerContainerInteractionSignal) => void
    onPlayerGamemodeChange?: (event: PlayerGamemodeChangeSignal) => void
    onPlayerInteractWithBlock?: (event: PlayerInteractWithBlockSignal) => void
    onPlayerInteractWithEntity?: (event: PlayerInteractWithEntitySignal) => void
    onPlayerJoin?: (event: PlayerJoinSignal) => void
    onPlayerLeave?: (event: PlayerLeaveSignal) => void
    onPlayerOpenedContainer?: (event: PlayerOpenedContainerSignal) => void
    onPlayerPlaceBlock?: (event: PlayerPlaceBlockSignal) => void
    onPlayerStartEmoting?: (event: PlayerStartEmotingSignal) => void
    onPlayerStartUsingItem?: (event: PlayerStartUsingItemSignal) => void
    onPlayerStopEmoting?: (event: PlayerStopEmotingSignal) => void
    onPlayerStopUsingItem?: (event: PlayerStopUsingItemSignal) => void
    onShutDown?: (plugin: Plugin) => void
    onStartUp?: (plugin: Plugin) => void
    onWorldInitialize?: (event: WorldInitializeSignal) => void
    onWorldTick?: (event: WorldTickSignal) => void
    priority: PluginPriority

    The type of the plugin.

    The type of the plugin.