EntityHealthComponent

Class in @minecraft/server

Extends EntityComponent

An entity’s health.

import { EntityHealthComponent } from '@minecraft/server';

Example

TypeScript JavaScript

import { world, type EntityHealthComponent } from '@minecraft/server';

for (const player of world.getAllPlayers()) {
    const component: EntityHealthComponent | undefined = player.getComponent('minecraft:health');
    if (component) {
        console.log(player.name, component.currentValue);
    }
}

import { world } from '@minecraft/server';

for (const player of world.getAllPlayers()) {
    const component = player.getComponent('minecraft:health');
    if (component) {
        console.log(player.name, component.currentValue);
    }
}

Properties

typeId

read-only

readonly typeId: "minecraft:health";

entity

read-only

readonly entity: Entity;

Types

Entity

isValid

read-only

readonly isValid: boolean;

currentValue

read-only

readonly currentValue: number;

effectiveMax

read-only

readonly effectiveMax: number;

effectiveMin

read-only

readonly effectiveMin: number;

defaultValue

read-only

readonly defaultValue: number;

The maximum, in Basalt.

Methods

setCurrentValue

setCurrentValue(value: number): boolean;

Sets the health, within the maximum; zero kills.

Parameters

value

number

Returns

boolean

resetToMaxValue

resetToMaxValue(): void;

resetToDefaultValue

resetToDefaultValue(): void;

resetToMinValue

resetToMinValue(): void;

Used by

EntityComponentTypeMap.minecraft:health, EntityComponentTypeMap.health