Skip to main content

Class: EntityNavigationComponent

Allows this entity to generate paths that include vertical walls (for example, like Minecraft spiders do.)

Extends​

Extended by​

Constructors​

new EntityNavigationComponent()​

private new EntityNavigationComponent(): EntityNavigationComponent

Returns​

EntityNavigationComponent

Overrides​

EntityComponent . constructor

Properties​

avoidDamageBlocks​

readonly avoidDamageBlocks: boolean

Remarks​

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

Throws​

This property can throw when used.

avoidPortals​

readonly avoidPortals: boolean

Remarks​

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

Throws​

This property can throw when used.

avoidSun​

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

avoidWater​

readonly avoidWater: boolean

Remarks​

Tells the pathfinder to avoid water when creating a path.

Throws​

This property can throw when used.

canBreach​

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

canBreakDoors​

readonly canBreakDoors: boolean

Remarks​

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

Throws​

This property can throw when used.

canFloat​

readonly canFloat: boolean

Remarks​

Tells the pathfinder whether or not it can float.

Throws​

This property can throw when used.

canJump​

readonly canJump: boolean

Remarks​

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

Throws​

This property can throw when used.

canOpenDoors​

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

canOpenIronDoors​

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

canPassDoors​

readonly canPassDoors: boolean

Remarks​

Whether a path can be created through a door.

Throws​

This property can throw when used.

canPathFromAir​

readonly canPathFromAir: boolean

Remarks​

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

Throws​

This property can throw when used.

canPathOverLava​

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

canPathOverWater​

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

canSink​

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

canSwim​

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

canWalk​

readonly canWalk: boolean

Remarks​

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

Throws​

This property can throw when used.

canWalkInLava​

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

entity​

Beta

readonly entity: Entity

Remarks​

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

Inherited from​

EntityComponent . entity

isAmphibious​

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

typeId​

readonly typeId: string

Remarks​

Identifier of the component.

Inherited from​

EntityComponent . typeId

Methods​

isValid()​

isValid(): boolean

Returns​

boolean

Whether the component is valid.

Inherited from​

EntityComponent . isValid

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.