Class EntityMovementComponent

Hierarchy (View Summary)

EntityAttributeComponent
- EntityMovementComponent

Index

Constructors

Properties

currentValue defaultValue effectiveMax effectiveMin entity isValid typeId

Methods

resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

Constructors

`Private`constructor

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

Properties

`Readonly`currentValue

currentValue: number

Throws

This property can throw errors.

World Ready

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

`Readonly`defaultValue

defaultValue: number

Throws

This property can throw errors.

World Ready

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

`Readonly`effectiveMax

effectiveMax: number

Throws

This property can throw errors.

World Ready

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

`Readonly`effectiveMin

effectiveMin: number

Throws

This property can throw errors.

World Ready

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

`Readonly`entity

entity: Entity

Throws

This property can throw errors.

InvalidEntityError

World Ready

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

`Readonly`isValid

isValid: boolean

`Readonly`typeId

typeId: string

Methods

resetToDefaultValue

resetToDefaultValue(): void
Returns void
Remarks
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
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
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
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.ArgumentOutOfBoundsError

InvalidEntityError

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

Inherited from EntityAttributeComponent.setCurrentValue