Class EntitySpawnAfterEventSignal

Registers a script-based event handler for handling what happens when an entity spawns.

Example

logEntitySpawnEvents.ts 

// Register a new function that is called when a new entity is created.
import { world, EntitySpawnAfterEvent } from '@minecraft/server';

world.afterEvents.entitySpawn.subscribe((entityEvent: EntitySpawnAfterEvent) => {
    const spawnLocation = entityEvent.entity.location;
    world.sendMessage(
        `New entity of type '${entityEvent.entity.typeId}' spawned at ${spawnLocation.x}, ${spawnLocation.y}, ${spawnLocation.z}!`,
    );
});

Hierarchy

  • EntitySpawnAfterEventSignal

Constructors

constructor

Methods

subscribe unsubscribe

Constructors

Private constructor

Methods

subscribe

  • Parameters

    • callback: ((arg) => void)

      Function that handles the spawn event.

    Returns ((arg) => void)

      • (arg): void

      • Parameters

        Returns void

        Remarks

        Method to register an event handler for what happens when an entity spawns.

        This function can't be called in read-only mode.

    Remarks

    Method to register an event handler for what happens when an entity spawns.

    This function can't be called in read-only mode.

unsubscribe

  • Parameters

    • callback: ((arg) => void)

      Original function that was passed into the subscribe event, that is to be unregistered.

    Returns void

    Remarks

    Unregisters a method that was previously subscribed to the subscription event.

    This function can't be called in read-only mode.

Settings

Member Visibility

Theme

On This Page