Class EntityHealthComponent

Defines the health properties of an entity.

Hierarchy

Constructors

constructor

Properties

current typeId value componentId

Methods

resetToDefaultValue resetToMaxValue resetToMinValue setCurrent

Constructors

Protected constructor

Properties

Readonly current

current: number

Read-only. Returns the current value of health for the entity.

Throws

This property can throw when used.

Readonly typeId

typeId: string

Identifier of this component. Should always be minecraft:health.

Readonly value

value: number

Value for health as defined through entity components.

Throws

This property can throw when used.

Static Readonly componentId

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

Identifier of this component. Should always be minecraft:health.

Methods

resetToDefaultValue

  • Returns void

    Remarks

    Resets the current health value of the entity to its default value.

    Throws

    This function can throw errors.

resetToMaxValue

  • Returns void

    Remarks

    Resets the current health of the entity to its maximum value.

    Throws

    This function can throw errors.

resetToMinValue

  • Returns void

    Remarks

    Resets the current health to the minimum value.

    Throws

    This function can throw errors.

setCurrent

  • Parameters

    • value: number

    Returns void

    Remarks

    Sets the current health of the entity.

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page