Class EntityMovementSwayComponent

When added, this move control causes the mob to sway side to side giving the impression it is swimming.

Example

entityMovementSway.js 

import { world } from "@minecraft/server";

world.afterEvents.entitySpawn.subscribe(({ entity }) => {
    const movementSway = entity.getComponent("movement.sway");
    movementSway.swayAmplitude;
    movementSway.swayFrequency;
    movementSway.isValid();
});

Hierarchy

Constructors

constructor

Properties

entity maxTurn swayAmplitude swayFrequency typeId componentId

Methods

isValid

Constructors

Private constructor

Properties

Readonly entity

entity: Entity

Remarks

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

Readonly maxTurn

maxTurn: number

Remarks

Maximum turn rate for this movement modality of the mob.

Throws

This property can throw when used.

Readonly swayAmplitude

swayAmplitude: number

Remarks

Amplitude of the sway motion.

Throws

This property can throw when used.

Readonly swayFrequency

swayFrequency: number

Remarks

Amount of sway frequency.

Throws

This property can throw when used.

Readonly typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

componentId: "minecraft:movement.sway" = 'minecraft:movement.sway'

Methods

isValid

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

Settings

Member Visibility

Theme

On This Page