Class: EntityHealthComponent

Defines the health properties of an entity.

Example

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

Extends

• EntityAttributeComponent

Constructors

new EntityHealthComponent()

private new EntityHealthComponent(): EntityHealthComponent

Returns

EntityHealthComponent

Overrides

EntityAttributeComponent . constructor

Properties

currentValue

readonly currentValue: number

Remarks

Current value of this attribute for this instance.

Throws

This property can throw when used.

Inherited from

EntityAttributeComponent . currentValue

---

defaultValue

readonly defaultValue: number

Remarks

Returns the default defined value for this attribute.

Throws

This property can throw when used.

Inherited from

EntityAttributeComponent . defaultValue

---

effectiveMax

readonly effectiveMax: number

Remarks

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

Throws

This property can throw when used.

Inherited from

EntityAttributeComponent . effectiveMax

---

effectiveMin

readonly effectiveMin: number

Remarks

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

Throws

This property can throw when used.

Inherited from

EntityAttributeComponent . effectiveMin

---

entity

Beta

readonly entity: Entity

Remarks

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

Inherited from

EntityAttributeComponent . entity

---

typeId

readonly typeId: string

Remarks

Identifier of the component.

Inherited from

EntityAttributeComponent . typeId

---

componentId

static readonly componentId: "minecraft:health" = 'minecraft:health'

Methods

isValid()

isValid(): boolean

Returns

boolean

Whether the component is valid.

Inherited from

EntityAttributeComponent . isValid

Remarks

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.

---

resetToDefaultValue()

resetToDefaultValue(): void

Returns

void

Inherited from

EntityAttributeComponent . resetToDefaultValue

Remarks

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

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

Throws

This function can throw errors.

---

resetToMaxValue()

resetToMaxValue(): void

Returns

void

Inherited from

EntityAttributeComponent . resetToMaxValue

Remarks

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

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

Throws

This function can throw errors.

---

resetToMinValue()

resetToMinValue(): void

Returns

void

Inherited from

EntityAttributeComponent . resetToMinValue

Remarks

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

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

Throws

This function can throw errors.

---

setCurrentValue()

setCurrentValue(value): boolean

Parameters

Parameter	Type
value	number

Returns

boolean

Inherited from

EntityAttributeComponent . setCurrentValue

Remarks

Sets the current value of this attribute.

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

Throws

This function can throw errors.