Class EntityHealthComponent

Defines the health properties of an entity.

Hierarchy

Constructors

constructor

Properties

currentValue defaultValue effectiveMax effectiveMin typeId componentId

Methods

resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

Constructors

Private constructor

Properties

Readonly currentValue

currentValue: number

Remarks

Current value of this attribute for this instance.

Throws

This property can throw when used.

Readonly defaultValue

defaultValue: number

Remarks

Returns the default defined value for this attribute.

Throws

This property can throw when used.

Readonly effectiveMax

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 effectiveMin

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 typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

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

Methods

resetToDefaultValue

  • Returns void

    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

  • Returns void

    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

  • Returns void

    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

  • Parameters

    • value: number

    Returns boolean

    Remarks

    Sets the current value of this attribute.

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

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page