Class EntityNavigationGenericComponent

Allows this entity to generate paths by walking, swimming, flying and/or climbing around and jumping up and down a block.

Example: navigationGeneric.js

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

const dolphin = world
    .getDimension("overworld")
    .spawnEntity("minecraft:dolphin", { x: 0, y: 0, z: 0 });
const navigationGeneric = dolphin.getComponent("minecraft:navigation.generic");
console.warn(
    "dolphin - avoidDamageBlocks: " + navigationGeneric.avoidDamageBlocks,
);
console.warn("dolphin - avoidPortals: " + navigationGeneric.avoidPortals);
console.warn("dolphin - avoidSun: " + navigationGeneric.avoidSun);
console.warn("dolphin - avoidWater: " + navigationGeneric.avoidWater);
console.warn("dolphin - canBreach: " + navigationGeneric.canBreach);
console.warn("dolphin - canBreakDoors: " + navigationGeneric.canBreakDoors);
console.warn("dolphin - canFloat: " + navigationGeneric.canFloat);
console.warn("dolphin - canJump: " + navigationGeneric.canJump);
console.warn("dolphin - canOpenDoors: " + navigationGeneric.canOpenDoors);
console.warn(
    "dolphin - canOpenIronDoors: " + navigationGeneric.canOpenIronDoors,
);
console.warn("dolphin - canPassDoors: " + navigationGeneric.canPassDoors);
console.warn("dolphin - canPathFromAir: " + navigationGeneric.canPathFromAir);
console.warn("dolphin - canPathOverLava: " + navigationGeneric.canPathOverLava);
console.warn(
    "dolphin - canPathOverWater: " + navigationGeneric.canPathOverWater,
);
console.warn("dolphin - canSink: " + navigationGeneric.canSink);
console.warn("dolphin - canSwim: " + navigationGeneric.canSwim);
console.warn("dolphin - canWalk: " + navigationGeneric.canWalk);
console.warn("dolphin - canWalkInLava: " + navigationGeneric.canWalkInLava);
console.warn("dolphin - isAmphibious: " + navigationGeneric.isAmphibious);
console.warn("dolphin - isValid: " + navigationGeneric.isValid());

Hierarchy (View Summary)

Constructors

constructor

Properties

avoidDamageBlocks avoidPortals avoidSun avoidWater canBreach canBreakDoors canFloat canJump canOpenDoors canOpenIronDoors canPassDoors canPathFromAir canPathOverLava canPathOverWater canSink canSwim canWalk canWalkInLava entity isAmphibious typeId componentId

Methods

isValid

Constructors

Privateconstructor

Properties

ReadonlyavoidDamageBlocks

avoidDamageBlocks: boolean

Remarks

Tells the pathfinder to avoid blocks that cause damage when finding a path.

Throws

This property can throw when used.

ReadonlyavoidPortals

avoidPortals: boolean

Remarks

Tells the pathfinder to avoid portals (like nether portals) when finding a path.

Throws

This property can throw when used.

ReadonlyavoidSun

avoidSun: boolean

Remarks

Whether or not the pathfinder should avoid tiles that are exposed to the sun when creating paths.

Throws

This property can throw when used.

ReadonlyavoidWater

avoidWater: boolean

Remarks

Tells the pathfinder to avoid water when creating a path.

Throws

This property can throw when used.

ReadonlycanBreach

canBreach: boolean

Remarks

Tells the pathfinder whether or not it can jump out of water (like a dolphin).

Throws

This property can throw when used.

ReadonlycanBreakDoors

canBreakDoors: boolean

Remarks

Tells the pathfinder that it can path through a closed door and break it.

Throws

This property can throw when used.

ReadonlycanFloat

canFloat: boolean

Remarks

Tells the pathfinder whether or not it can float.

Throws

This property can throw when used.

ReadonlycanJump

canJump: boolean

Remarks

Tells the pathfinder whether or not it can jump up blocks.

Throws

This property can throw when used.

ReadonlycanOpenDoors

canOpenDoors: boolean

Remarks

Tells the pathfinder that it can path through a closed door assuming the AI will open the door.

Throws

This property can throw when used.

ReadonlycanOpenIronDoors

canOpenIronDoors: boolean

Remarks

Tells the pathfinder that it can path through a closed iron door assuming the AI will open the door.

Throws

This property can throw when used.

ReadonlycanPassDoors

canPassDoors: boolean

Remarks

Whether a path can be created through a door.

Throws

This property can throw when used.

ReadonlycanPathFromAir

canPathFromAir: boolean

Remarks

Tells the pathfinder that it can start pathing when in the air.

Throws

This property can throw when used.

ReadonlycanPathOverLava

canPathOverLava: boolean

Remarks

Tells the pathfinder whether or not it can travel on the surface of the lava.

Throws

This property can throw when used.

ReadonlycanPathOverWater

canPathOverWater: boolean

Remarks

Tells the pathfinder whether or not it can travel on the surface of the water.

Throws

This property can throw when used.

ReadonlycanSink

canSink: boolean

Remarks

Tells the pathfinder whether or not it will be pulled down by gravity while in water.

Throws

This property can throw when used.

ReadonlycanSwim

canSwim: boolean

Remarks

Tells the pathfinder whether or not it can path anywhere through water and plays swimming animation along that path.

Throws

This property can throw when used.

ReadonlycanWalk

canWalk: boolean

Remarks

Tells the pathfinder whether or not it can walk on the ground outside water.

Throws

This property can throw when used.

ReadonlycanWalkInLava

canWalkInLava: boolean

Remarks

Tells the pathfinder whether or not it can travel in lava like walking on ground.

Throws

This property can throw when used.

Readonlyentity

entity: Entity

Remarks

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

ReadonlyisAmphibious

isAmphibious: boolean

Remarks

Tells the pathfinder whether or not it can walk on the ground or go underwater.

Throws

This property can throw when used.

ReadonlytypeId

typeId: string

Remarks

Identifier of the component.

Static ReadonlycomponentId

componentId: "minecraft:navigation.generic" = 'minecraft:navigation.generic'

Methods

isValid

  • isValid(): boolean

    Returns boolean

    Whether the component is valid.

    Deprecated

    This function is deprecated and will be removed in 2.0.0.

    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

On This Page

Constructors
Properties
Methods