Entity.PathNavigation

since: 2.0.3b33 (broken in 3.0.0b124, 3.1.0b125)

Object used to build path and move mobs to the required coordinates using specified parameters. All the setters return current Entity.PathNavigation instance to be able to produce chained calls.

Index

Methods

• canOpenDoors
• canPassDoors
• getAvoidDamageBlocks
• getAvoidPortals
• getAvoidSun
• getAvoidWater
• getCanBreach
• getCanFloat
• getCanJump
• getCanOpenIronDoors
• getCanPathOverLava
• getCanSink
• getCanWalkInLava
• getHasEndPathRadius
• getSpeed
• getTerminationThreshold
• getTickTimeout
• isAmphibious
• isRiverFollowing
• isStuck
• moveToCoords
• moveToEntity
• setAvoidDamageBlocks
• setAvoidPortals
• setAvoidSun
• setAvoidWater
• setCanBreach
• setCanFloat
• setCanJump
• setCanOpenDoors
• setCanOpenIronDoors
• setCanPassDoors
• setCanPathOverLava
• setCanSink
• setCanWalkInLava
• setEndPathRadius
• setHasEndPathRadius
• setIsAmphibious
• setIsRiverFollowing
• setResultFunction
• setSpeed
• setTickTimeout

Methods

canOpenDoors

• canOpenDoors(): boolean

• Returns boolean

  Whether the entity can open doors.

canPassDoors

• canPassDoors(): boolean

• Returns boolean

  Whether the entity can pass doors.

getAvoidDamageBlocks

• getAvoidDamageBlocks(): boolean

• Returns boolean

getAvoidPortals

• getAvoidPortals(): boolean

• Returns boolean

getAvoidSun

• getAvoidSun(): boolean

• since: 2.2.1b93

  Returns boolean

getAvoidWater

• getAvoidWater(): boolean

• Returns boolean

  Whether the entity avoids water.

getCanBreach

• getCanBreach(): boolean

• Returns boolean

getCanFloat

• getCanFloat(): boolean

• Returns boolean

getCanJump

• getCanJump(): boolean

• Returns boolean

  Whether entity can jump.

getCanOpenIronDoors

• getCanOpenIronDoors(): boolean

• since: 2.2.1b93

  Returns boolean

getCanPathOverLava

• getCanPathOverLava(): boolean

• since: 2.2.1b93

  Returns boolean

getCanSink

• getCanSink(): boolean

• Returns boolean

getCanWalkInLava

• getCanWalkInLava(): boolean

• since: 2.2.1b93

  Returns boolean

getHasEndPathRadius

• getHasEndPathRadius(): boolean

• since: 2.2.1b93

  Returns boolean

getSpeed

• getSpeed(): number

• Returns number

  Entity's speed value.

getTerminationThreshold

• getTerminationThreshold(): number
• getTerminationThreshold(threshold: number): PathNavigation

• since: 2.2.1b93

  Returns number

getTickTimeout

• getTickTimeout(): number

• since: 2.2.1b93

  Returns number

isAmphibious

• isAmphibious(): boolean

• Returns boolean

isRiverFollowing

• isRiverFollowing(): boolean

• Returns boolean

isStuck

• isStuck(ticks: number): boolean

• since: 2.2.1b93

  Parameters

  • ticks: number

  Returns boolean

moveToCoords

• moveToCoords(x: number, y: number, z: number, speed: number): PathNavigation

• Builds path to the specified coordinates.

  ---

  Parameters

  • x: number

  • y: number

  • z: number

  • speed: number

    entity movement speed

  Returns PathNavigation

moveToEntity

• moveToEntity(entity: number, speed: number): PathNavigation

• Builds path to the specified entity. Note that current coordinates of entity are used, and are not updated.

  ---

  Parameters

  • entity: number

  • speed: number

    entity movement speed

  Returns PathNavigation

setAvoidDamageBlocks

• setAvoidDamageBlocks(avoid: boolean): PathNavigation

• Parameters

  • avoid: boolean

  Returns PathNavigation

setAvoidPortals

• setAvoidPortals(avoid: boolean): PathNavigation

• Parameters

  • avoid: boolean

  Returns PathNavigation

setAvoidSun

• setAvoidSun(avoid: boolean): PathNavigation

• Sets entity's sun avoiding.

  ---

  Parameters

  • avoid: boolean

  Returns PathNavigation

setAvoidWater

• setAvoidWater(avoid: boolean): PathNavigation

• Sets entity's water avoiding.

  ---

  Parameters

  • avoid: boolean

  Returns PathNavigation

setCanBreach

• setCanBreach(can: boolean): PathNavigation

• Parameters

  • can: boolean

  Returns PathNavigation

setCanFloat

• setCanFloat(can: boolean): PathNavigation

• Parameters

  • can: boolean

  Returns PathNavigation

setCanJump

• setCanJump(can: boolean): PathNavigation

• Enables or disables entity's jumping ability.

  ---

  Parameters

  • can: boolean

  Returns PathNavigation

setCanOpenDoors

• setCanOpenDoors(can: boolean): PathNavigation

• Sets entity's door opening ability.

  ---

  Parameters

  • can: boolean

  Returns PathNavigation

setCanOpenIronDoors

• setCanOpenIronDoors(can: boolean): PathNavigation

• since: 2.2.1b93

  Parameters

  • can: boolean

  Returns PathNavigation

setCanPassDoors

• setCanPassDoors(can: boolean): PathNavigation

• Sets entity's door passing ability.

  ---

  Parameters

  • can: boolean

  Returns PathNavigation

setCanPathOverLava

• setCanPathOverLava(can: boolean): PathNavigation

• since: 2.2.1b93

  Parameters

  • can: boolean

  Returns PathNavigation

setCanSink

• setCanSink(can: boolean): PathNavigation

• Parameters

  • can: boolean

  Returns PathNavigation

setCanWalkInLava

• setCanWalkInLava(can: boolean): PathNavigation

• since: 2.2.1b93

  Parameters

  • can: boolean

  Returns PathNavigation

setEndPathRadius

• setEndPathRadius(radius: number): PathNavigation

• Parameters

  • radius: number

  Returns PathNavigation

setHasEndPathRadius

• setHasEndPathRadius(has: boolean): PathNavigation

• since: 2.2.1b93

  Parameters

  • has: boolean

  Returns PathNavigation

setIsAmphibious

• setIsAmphibious(amphibious: boolean): PathNavigation

• Parameters

  • amphibious: boolean

  Returns PathNavigation

setIsRiverFollowing

• setIsRiverFollowing(follow: boolean): PathNavigation

• Parameters

  • follow: boolean

  Returns PathNavigation

setResultFunction

• setResultFunction(callback: PathNavigationResultFunction): PathNavigation

• Sets function to be notified when path navigation is finished or aborted.

  ---

  Parameters

  • callback: PathNavigationResultFunction

    function to be called when navigation is finished or aborted

  Returns PathNavigation

setSpeed

• setSpeed(speed: number): PathNavigation

• Sets entity's speed value.

  ---

  Parameters

  • speed: number

  Returns PathNavigation

setTickTimeout

• setTickTimeout(ticks: number): PathNavigation

• since: 2.2.1b93

  Parameters

  • ticks: number

  Returns PathNavigation