Class EntityHealthComponentBeta

Defines the health properties of an entity.

Hierarchy

Constructors

constructor

Properties

currentValue defaultValue effectiveMax effectiveMin entity typeId componentId

Methods

resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

Constructors

Protected constructor

Properties

Readonly currentValue

currentValue: number

Readonly defaultValue

defaultValue: number

Readonly effectiveMax

effectiveMax: number

Readonly effectiveMin

effectiveMin: number

Readonly Beta entity

entity: Entity

Remarks

The entity that owns this component.

Readonly typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

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

Remarks

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

Methods

resetToDefaultValue

  • Returns void

    Remarks

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

    Throws

    This function can throw errors.

resetToMaxValue

  • Returns void

    Remarks

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

    Throws

    This function can throw errors.

resetToMinValue

  • Returns void

    Remarks

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

    Throws

    This function can throw errors.

setCurrentValue

  • Parameters

    • value: number

    Returns boolean

    Remarks

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

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page