Class EntityUnderwaterMovementComponent

Defines the general movement speed underwater of this entity.

Hierarchy

Constructors

constructor

Properties

current typeId value componentId

Methods

resetToDefaultValue resetToMaxValue resetToMinValue setCurrent

Constructors

Protected constructor

Properties

Readonly current

current: number

Read-only. Returns the current value of movement speed underwater for the entity.

Throws

This property can throw when used.

Readonly typeId

typeId: string

Identifier of this component. Should always be minecraft:underwater_movement.

Readonly value

value: number

Value for movement speed underwater as defined through entity components.

Throws

This property can throw when used.

Static Readonly componentId

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

Identifier of this component. Should always be minecraft:underwater_movement.

Methods

resetToDefaultValue

  • Returns void

    Remarks

    Resets the current movement speed underwater for the entity to the default value implied by the current component state of the entity.

    Throws

    This function can throw errors.

resetToMaxValue

  • Returns void

    Remarks

    Resets the movement speed underwater to the maximum value for the entity, as determined by the set of components that are on the entity.

    Throws

    This function can throw errors.

resetToMinValue

  • Returns void

    Remarks

    Resets the movement speed underwater to the minimum value as defined by the component state of this entity.

    Throws

    This function can throw errors.

setCurrent

  • Parameters

    • value: number

    Returns void

    Remarks

    Sets the current value of movement speed underwater for the entity.

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page