Script API - v1.21.0
    Preparing search index...

    Class EntityUnderwaterMovementComponentBeta

    Defines the general movement speed underwater of this entity.

    Hierarchy (View Summary)

    Index

    Properties

    currentValue defaultValue effectiveMax effectiveMin entity typeId componentId

    Methods

    isValid resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

    Properties

    currentValue: number

    Current value of this attribute for this instance.

    This property can throw when used.

    defaultValue: number

    Returns the default defined value for this attribute.

    This property can throw when used.

    effectiveMax: number

    Returns the effective max of this attribute given any other ambient components or factors.

    This property can throw when used.

    effectiveMin: number

    Returns the effective min of this attribute given any other ambient components or factors.

    This property can throw when used.

    entity: Entity

    The entity that owns this component. The entity will be undefined if it has been removed.

    typeId: string

    Identifier of the component.

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

    Methods

    • Beta

      Returns boolean

      Whether the component is valid.

      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.

    • Beta

      Parameters

      • value: number

      Returns boolean

      Sets the current value of this attribute.

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods