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

Methods

  • Parameters

    Returns (arg: EntitySpawnAfterEvent) => void

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

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

    This function can be called in early-execution mode.

    import { world, system, EntitySpawnAfterEvent, DimensionLocation } from "@minecraft/server";
    import { Vector3Utils } from "@minecraft/math";

    function logEntitySpawnEvent(
    log: (message: string, status?: number) => void,
    targetLocation: DimensionLocation
    ) {
    // register a new function that is called when a new entity is created.
    world.afterEvents.entitySpawn.subscribe((entityEvent: EntitySpawnAfterEvent) => {
    if (entityEvent && entityEvent.entity) {
    log(`New entity of type ${entityEvent.entity.typeId} created!`, 1);
    } else {
    log(`The entity event did not work as expected.`, -1);
    }
    });

    system.runTimeout(() => {
    targetLocation.dimension.spawnEntity(
    "minecraft:horse<minecraft:ageable_grow_up>",
    Vector3Utils.add(targetLocation, { x: 0, y: 1, z: 0 })
    );
    }, 20);
    }
  • Parameters

    • callback: (arg: EntitySpawnAfterEvent) => void

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

    Returns void

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

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

    This function can be called in early-execution mode.