Class EntityHealthComponentBeta

Defines the health properties of an entity.

Example: applyDamageThenHeal.ts

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)

Constructors

constructor

Properties

currentValue defaultValue effectiveMax effectiveMin entity isValid typeId componentId

Methods

resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

Constructors

Privateconstructor

Properties

Readonly BetacurrentValue

currentValue: number

Remarks

Current value of this attribute for this instance.

Throws

This property can throw when used.

Readonly BetadefaultValue

defaultValue: number

Remarks

Returns the default defined value for this attribute.

Throws

This property can throw when used.

Readonly BetaeffectiveMax

effectiveMax: number

Remarks

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

Throws

This property can throw when used.

Readonly BetaeffectiveMin

effectiveMin: number

Remarks

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

Throws

This property can throw when used.

Readonly Betaentity

entity: Entity

Remarks

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

Throws

This property can throw when used.

InvalidEntityError

Readonly BetaisValid

isValid: boolean

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.

Readonly BetatypeId

typeId: string

Remarks

Identifier of the component.

Static Readonly BetacomponentId

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

Methods

resetToDefaultValue

resetToMaxValue

resetToMinValue

setCurrentValue

Settings

Member Visibility

On This Page

Constructors
Properties
Methods