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 (View Summary)

Constructors

constructor

Properties

entity isValid maxTurn swayAmplitude swayFrequency typeId componentId

Constructors

Privateconstructor

Properties

Readonlyentity

entity: Entity

Remarks

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

Throws

This property can throw when used.

InvalidEntityError

Readonly BetaisValid

isValid: boolean

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.

ReadonlymaxTurn

maxTurn: number

Remarks

Maximum turn rate for this movement modality of the mob.

Throws

This property can throw when used.

ReadonlyswayAmplitude

swayAmplitude: number

Remarks

Amplitude of the sway motion.

Throws

This property can throw when used.

ReadonlyswayFrequency

swayFrequency: number

Remarks

Amount of sway frequency.

Throws

This property can throw when used.

ReadonlytypeId

typeId: string

Remarks

Identifier of the component.

Static ReadonlycomponentId

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

Settings

Member Visibility

On This Page

Constructors
Properties