Class EntityMovementComponentBeta

Defines the general movement speed of this entity.

Hierarchy (View Summary)

Properties

currentValue defaultValue effectiveMax effectiveMin entity typeId componentId

Methods

isValid resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

Properties

Readonly BetacurrentValue

currentValue: number

Remarks

Current value of this attribute for this instance.

Throws

This property can throw when used.

Readonly BetadefaultValue

defaultValue: number

Remarks

Returns the default defined value for this attribute.

Throws

This property can throw when used.

Readonly BetaeffectiveMax

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 BetaeffectiveMin

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 Betaentity

entity: Entity

Remarks

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

Readonly BetatypeId

typeId: string

Remarks

Identifier of the component.

Static Readonly BetacomponentId

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

Methods

isValid

  • isValid(): boolean
  • Beta

    Returns boolean

    Whether the component is valid.

    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.

resetToDefaultValue

  • resetToDefaultValue(): void
  • Beta

    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.

resetToMaxValue

  • resetToMaxValue(): void
  • Beta

    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.

resetToMinValue

  • resetToMinValue(): void
  • Beta

    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.

setCurrentValue

  • setCurrentValue(value: number): boolean
  • Beta

    Parameters

    • value: number

    Returns boolean

    Remarks

    Sets the current value of this attribute.

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

    Throws

    This function can throw errors.

Settings

Member Visibility

On This Page

Properties
Methods