Class EntityAttributeComponent`Beta`

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.

Hierarchy (View Summary)

EntityComponent
- EntityAttributeComponent

Index

Constructors

Properties

currentValue defaultValue effectiveMax effectiveMin entity isValid typeId

Methods

resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

Constructors

`Private`constructor

new EntityAttributeComponent(): EntityAttributeComponent
Beta
Returns EntityAttributeComponent
Overrides EntityComponent.constructor
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10334

Properties

`Readonly` `Beta`currentValue

currentValue: number

Remarks

Current value of this attribute for this instance.

Throws

This property can throw when used.

`Readonly` `Beta`defaultValue

defaultValue: number

Remarks

Returns the default defined value for this attribute.

Throws

This property can throw when used.

`Readonly` `Beta`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` `Beta`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` `Beta`entity

entity: Entity

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

`Readonly` `Beta`isValid

isValid: boolean

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.

`Readonly` `Beta`typeId

typeId: string

Remarks

Identifier of the component.

Methods

resetToDefaultValue

resetToDefaultValue(): void
Beta
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.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10374

resetToMaxValue

resetToMaxValue(): void
Beta
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.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10384

resetToMinValue

resetToMinValue(): void
Beta
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.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10394

setCurrentValue

setCurrentValue(value: number): boolean
Beta
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
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10409