Class EntityUnderwaterMovementComponent

Defines the general movement speed underwater of this entity.

Hierarchy (View Summary)

EntityAttributeComponent
- EntityUnderwaterMovementComponent

Index

Constructors

`Private`constructor

new EntityUnderwaterMovementComponent(): EntityUnderwaterMovementComponent
Returns EntityUnderwaterMovementComponent
Overrides EntityAttributeComponent.constructor

Properties

`Readonly`currentValue

currentValue: number

Remarks

Current value of this attribute for this instance.

Throws

This property can throw when used.

World Ready

This property can't be read in early-execution mode.

`Readonly`defaultValue

defaultValue: number

Remarks

Returns the default defined value for this attribute.

Throws

This property can throw when used.

World Ready

This property can't be read in early-execution mode.

`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.

World Ready

This property can't be read in early-execution mode.

`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.

World Ready

This property can't be read in early-execution mode.

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

World Ready

This property can't be read in early-execution mode.

`Readonly`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.

World Ready

This property can't be read in early-execution mode.

`Readonly`typeId

typeId: string

Remarks

Identifier of the component.

World Ready

This property can't be read in early-execution mode.

`Static` `Readonly`componentId

componentId: "minecraft:underwater_movement" = 'minecraft:underwater_movement'

Methods

resetToDefaultValue

resetToDefaultValue(): void
Returns void
Remarks
Resets the current value of this attribute to the defined default value.

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

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

Inherited from EntityAttributeComponent.resetToDefaultValue

resetToMaxValue

resetToMaxValue(): void
Returns void
Remarks
Resets the current value of this attribute to the maximum defined value.

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

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

Inherited from EntityAttributeComponent.resetToMaxValue

resetToMinValue

resetToMinValue(): void
Returns void
Remarks
Resets the current value of this attribute to the minimum defined value.

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

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

Inherited from EntityAttributeComponent.resetToMinValue

setCurrentValue

setCurrentValue(value: number): boolean
Parameters
- value: number
Returns boolean
Remarks
Sets the current value of this attribute.

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

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

minecraftcommon.ArgumentOutOfBoundsError

InvalidEntityError

World Ready
This function can't be called in early-execution mode.

Inherited from EntityAttributeComponent.setCurrentValue

Class EntityUnderwaterMovementComponent

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns EntityUnderwaterMovementComponent

Properties

ReadonlycurrentValue

Remarks

Throws

World Ready

ReadonlydefaultValue

Remarks

Throws

World Ready

ReadonlyeffectiveMax

Remarks

Throws

World Ready

ReadonlyeffectiveMin

Remarks

Throws

World Ready

Readonlyentity

Remarks

Throws

World Ready

ReadonlyisValid

Remarks

World Ready

ReadonlytypeId

Remarks

World Ready

Static ReadonlycomponentId

Methods

resetToDefaultValue

Returns void

Remarks

Write Privilege

Throws

World Ready

resetToMaxValue

Returns void

Remarks

Write Privilege

Throws

World Ready

resetToMinValue

Returns void

Remarks

Write Privilege

Throws

World Ready

setCurrentValue

Parameters

Returns boolean

Remarks

Write Privilege

Throws

World Ready

Settings

On This Page

`Private`constructor

`Readonly`currentValue

`Readonly`defaultValue

`Readonly`effectiveMax

`Readonly`effectiveMin

`Readonly`entity

`Readonly`isValid

`Readonly`typeId

`Static` `Readonly`componentId