Bedrock API Reference

Appearance

@minecraft/server

@minecraft/server / EntityAttributeComponent

Class: EntityAttributeComponent ​

Defined in: @minecraft/server/index.d.ts:9722

This is a base abstract class for any entity component that centers around a number and can have a minimum, maximum, and default defined value.

Extends ​

Extended by ​

Properties ​

currentValue ​

readonly currentValue: number

Defined in: @minecraft/server/index.d.ts:9730

Remarks ​

Current value of this attribute for this instance.

Throws ​

This property can throw when used.

defaultValue ​

readonly defaultValue: number

Defined in: @minecraft/server/index.d.ts:9737

Remarks ​

Returns the default defined value for this attribute.

Throws ​

This property can throw when used.

effectiveMax ​

readonly effectiveMax: number

Defined in: @minecraft/server/index.d.ts:9745

Remarks ​

Returns the effective max of this attribute given any other ambient components or factors.

Throws ​

This property can throw when used.

effectiveMin ​

readonly effectiveMin: number

Defined in: @minecraft/server/index.d.ts:9753

Remarks ​

Returns the effective min of this attribute given any other ambient components or factors.

Throws ​

This property can throw when used.

entity ​

readonly entity: Entity

Defined in: @minecraft/server/index.d.ts:9981

Remarks ​

The entity that owns this component. The entity will be undefined if it has been removed.

Throws ​

This property can throw when used.

InvalidEntityError

Inherited from ​

EntityComponent.entity

isValid ​

readonly isValid: boolean

Defined in: @minecraft/server/index.d.ts:6234

Remarks ​

Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

Inherited from ​

EntityComponent.isValid

typeId ​

readonly typeId: string

Defined in: @minecraft/server/index.d.ts:6240

Remarks ​

Identifier of the component.

Inherited from ​

EntityComponent.typeId

Methods ​

resetToDefaultValue() ​

resetToDefaultValue(): void

Defined in: @minecraft/server/index.d.ts:9763

Returns ​

void

Remarks ​

Resets the current value of this attribute to the defined default value.

This function can't be called in restricted-execution mode.

Throws ​

This function can throw errors.

resetToMaxValue() ​

resetToMaxValue(): void

Defined in: @minecraft/server/index.d.ts:9773

Returns ​

void

Remarks ​

Resets the current value of this attribute to the maximum defined value.

This function can't be called in restricted-execution mode.

Throws ​

This function can throw errors.

resetToMinValue() ​

resetToMinValue(): void

Defined in: @minecraft/server/index.d.ts:9783

Returns ​

void

Remarks ​

Resets the current value of this attribute to the minimum defined value.

This function can't be called in restricted-execution mode.

Throws ​

This function can throw errors.

setCurrentValue() ​

setCurrentValue(value): boolean

Defined in: @minecraft/server/index.d.ts:9798

Parameters ​

value ​

number

Returns ​

boolean

Remarks ​

Sets the current value of this attribute.

This function can't be called in restricted-execution mode.

Throws ​

If the value is out of bounds, an ArgumentOutOfBounds Error is thrown.

minecraftcommon.ArgumentOutOfBoundsError

InvalidEntityError