Class EntityMovementComponent

Defines the general movement speed of this entity.

Hierarchy (View Summary)

EntityAttributeComponent
- EntityMovementComponent

Index

Constructors

`Private`constructor

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

Properties

`Readonly`currentValue

currentValue: number

Remarks

Current value of this attribute for this instance.

Throws

This property can throw when used.

`Readonly`defaultValue

defaultValue: number

Remarks

Returns the default defined value for this attribute.

Throws

This property can throw when used.

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

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

`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

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

`Readonly`typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly`componentId

componentId: "minecraft:movement" = 'minecraft:movement'

Methods

resetToDefaultValue

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

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

Throws
This function can throw errors.

Inherited from EntityAttributeComponent.resetToDefaultValue

resetToMaxValue

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

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

Throws
This function can throw errors.

Inherited from EntityAttributeComponent.resetToMaxValue

resetToMinValue

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

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

Throws
This function can throw errors.

Inherited from EntityAttributeComponent.resetToMinValue

setCurrentValue

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

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

Inherited from EntityAttributeComponent.setCurrentValue

Class EntityMovementComponent

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns EntityMovementComponent

Properties

ReadonlycurrentValue

Remarks

Throws

ReadonlydefaultValue

Remarks

Throws

ReadonlyeffectiveMax

Remarks

Throws

ReadonlyeffectiveMin

Remarks

Throws

Readonlyentity

Remarks

Throws

ReadonlyisValid

Remarks

ReadonlytypeId

Remarks

Static ReadonlycomponentId

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

`Private`constructor

`Readonly`currentValue

`Readonly`defaultValue

`Readonly`effectiveMax

`Readonly`effectiveMin

`Readonly`entity

`Readonly`isValid

`Readonly`typeId

`Static` `Readonly`componentId