Class EntityHealthComponent`Beta`

Defines the health properties of an entity.

Hierarchy (View Summary)

EntityAttributeComponent
- EntityHealthComponent

Index

Constructors

Properties

current typeId value componentId

Methods

resetToDefaultValue resetToMaxValue resetToMinValue setCurrent

Constructors

`Protected`constructor

new EntityHealthComponent(): EntityHealthComponent
Beta
Returns EntityHealthComponent
Overrides EntityAttributeComponent.constructor

Properties

`Readonly` `Beta`current

current: number

`Readonly` `Beta`typeId

typeId: string

`Readonly` `Beta`value

value: number

`Static` `Readonly` `Beta`componentId

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

Remarks

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

Methods

resetToDefaultValue

resetToDefaultValue(): void
Beta
Returns void
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

Inherited from EntityAttributeComponent.resetToDefaultValue

resetToMaxValue

resetToMaxValue(): void
Beta
Returns void
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

Inherited from EntityAttributeComponent.resetToMaxValue

resetToMinValue

resetToMinValue(): void
Beta
Returns void
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

Inherited from EntityAttributeComponent.resetToMinValue

setCurrent

setCurrent(value: number): boolean
Beta
Parameters
- value: number
Returns boolean
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

Inherited from EntityAttributeComponent.setCurrent