@minecraft/server
    Preparing search index...

    Class EntityHealthComponentBeta

    Defines the health properties of an entity.

    import { system, EntityHealthComponent, EntityComponentTypes, DimensionLocation } from "@minecraft/server";
    import { MinecraftEntityTypes } from "@minecraft/vanilla-data";

    function applyDamageThenHeal(
    log: (message: string, status?: number) => void,
    targetLocation: DimensionLocation
    ) {
    const skelly = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.Skeleton, targetLocation);

    skelly.applyDamage(19); // skeletons have max damage of 20 so this is a near-death skeleton

    system.runTimeout(() => {
    const health = skelly.getComponent(EntityComponentTypes.Health) as EntityHealthComponent;
    log("Skeleton health before heal: " + health?.currentValue);
    health?.resetToMaxValue();
    log("Skeleton health after heal: " + health?.currentValue);
    }, 20);
    }

    Hierarchy (View Summary)

    Index

    Properties

    currentValue: number

    Current value of this attribute for this instance.

    This property can throw when used.

    defaultValue: number

    Returns the default defined value for this attribute.

    This property can throw when used.

    effectiveMax: number

    Returns the effective max of this attribute given any other ambient components or factors.

    This property can throw when used.

    effectiveMin: number

    Returns the effective min of this attribute given any other ambient components or factors.

    This property can throw when used.

    entity: Entity

    The entity that owns this component. The entity will be undefined if it has been removed.

    This property can throw when used.

    InvalidEntityError

    isValid: boolean

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

    typeId: string

    Identifier of the component.

    componentId: "minecraft:health" = 'minecraft:health'

    Methods

    • Beta

      Returns void

      Resets the current value of this attribute to the defined default value.

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

      This function can throw errors.

    • Beta

      Returns void

      Resets the current value of this attribute to the maximum defined value.

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

      This function can throw errors.

    • Beta

      Returns void

      Resets the current value of this attribute to the minimum defined value.

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

      This function can throw errors.

    • Beta

      Parameters

      • value: number

      Returns boolean

      Sets the current value of this attribute. The provided value will be clamped to the range of this attribute.

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

      This function can throw errors.