Script API - v1.21.100
    Preparing search index...

    Class EntityHealthComponent

    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);
    }

    import { system, world } from "@minecraft/server";

    system.runInterval(() => {
        const players = world.getPlayers();
        for (const player of players) {
            const health = player.getComponent("health");
            player.onScreenDisplay.setActionBar(`Health: ${health.currentValue} / ${health.effectiveMax}`);
        }
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    currentValue defaultValue effectiveMax effectiveMin entity isValid typeId componentId

    Methods

    resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

    Constructors

    Properties

    currentValue: number

    Current value of this attribute for this instance.

    This property can throw when used.

    This property can't be read in early-execution mode.

    defaultValue: number

    Returns the default defined value for this attribute.

    This property can throw when used.

    This property can't be read in early-execution mode.

    effectiveMax: number

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

    This property can throw when used.

    This property can't be read in early-execution mode.

    effectiveMin: number

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

    This property can throw when used.

    This property can't be read in early-execution mode.

    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

    This property can't be read in early-execution mode.

    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.

    This property can't be read in early-execution mode.

    typeId: string

    Identifier of the component.

    This property can't be read in early-execution mode.

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

    Methods

    • 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.

      This function can't be called in early-execution mode.

    • 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.

      This function can't be called in early-execution mode.

    • 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.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods