Class EntityExhaustionComponent`Beta`

Defines the interactions with this entity for Exhaustion. Wraps the minecraft.player.exhaustion attribute.

Hierarchy (View Summary)

EntityAttributeComponent
- EntityExhaustionComponent

Index

Constructors

`Private`constructor

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

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.

`Static` `Readonly` `Beta`componentId

componentId: "minecraft:player.exhaustion" = 'minecraft:player.exhaustion'

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.
Inherited from EntityAttributeComponent.resetToDefaultValue
- 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.
Inherited from EntityAttributeComponent.resetToMaxValue
- 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.
Inherited from EntityAttributeComponent.resetToMinValue
- 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
Inherited from EntityAttributeComponent.setCurrentValue
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10409

Class EntityExhaustionComponentBeta

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns EntityExhaustionComponent

Properties

Readonly BetacurrentValue

Remarks

Throws

Readonly BetadefaultValue

Remarks

Throws

Readonly BetaeffectiveMax

Remarks

Throws

Readonly BetaeffectiveMin

Remarks

Throws

Readonly Betaentity

Remarks

Throws

Readonly BetaisValid

Remarks

Readonly BetatypeId

Remarks

Static Readonly BetacomponentId

Methods

resetToDefaultValue

Returns void

Remarks

Throws

resetToMaxValue

Returns void

Remarks

Throws

resetToMinValue

Returns void

Remarks

Throws

setCurrentValue

Parameters

Returns boolean

Remarks

Throws

Settings

On This Page

Class EntityExhaustionComponent`Beta`

`Private`constructor

`Readonly` `Beta`currentValue

`Readonly` `Beta`defaultValue

`Readonly` `Beta`effectiveMax

`Readonly` `Beta`effectiveMin

`Readonly` `Beta`entity

`Readonly` `Beta`isValid

`Readonly` `Beta`typeId

`Static` `Readonly` `Beta`componentId