Class EntityVariantComponent

Used to differentiate the component group of a variant of an entity from others. (e.g. ocelot, villager).

Example

entityVariantValue.js 

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

for (const entity of world.getDimension("overworld").getEntities()) {
    const variant = entity.getComponent("variant");
    if (!variant) continue;
    variant.value;
    variant.isValid();
}

Hierarchy

Constructors

constructor

Properties

entity typeId value 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 typeId

typeId: string

Remarks

Identifier of the component.

Readonly value

value: number

Remarks

Current value for variant for this entity, as specified via components.

Throws

This property can throw when used.

Static Readonly componentId

componentId: "minecraft:variant" = 'minecraft:variant'

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