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

    Class EntityHealthComponent

    Defines the health properties of an entity.

    // A function that applies damage and then heals the entity
    import { Entity, EntityComponentTypes, system, world } from '@minecraft/server';

    function applyDamageAndHeal(entity: Entity) {
        entity.applyDamage(19); // Many mobs have max damage of 20 so this is a near-death mob

        system.runTimeout(() => {
            const health = entity.getComponent(EntityComponentTypes.Health);
            if (health) {
                world.sendMessage(`Entity health before heal: ${health.currentValue}`);

                health.resetToMaxValue();

                world.sendMessage(`Entity after before heal: ${health.currentValue}`);
            } else {
                console.warn('Entity does not have health component');
            }
        }, 40); // Run in a few seconds (40 ticks)
    }

    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

    Properties

    currentValue defaultValue effectiveMax effectiveMin entity typeId componentId

    Methods

    isValid resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

    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.

    typeId: string

    Identifier of the component.

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

    Methods

    • Returns boolean

      Whether the component is valid.

      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.

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

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

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

    • Parameters

      • value: number

      Returns boolean

      Sets the current value of this attribute.

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods