Class WorldArea

Implements

WorldArea

Implemented by

WorldArea

Index

Constructors

Methods

isEdgePoint create calculateNextTravellingPoint createFromWorldPoint getX getY getWidth getHeight getPlane contains contains2D distanceTo distanceTo2D isInMeleeDistance hasLineOfSightTo toWorldPoint toWorldPointList

Constructors

constructor

new WorldArea(
    x: number,
    y: number,
    width: number,
    height: number,
    plane: number,
): WorldArea
Creates a new WorldArea at the X and Y world position
Parameters
- x: number
  the world X position, can use WorldPoint position
- y: number
  the world Y position, can use WorldPoint position
- width: number
  the width of the area from the X and Y position
- height: number
  the height of the area from the X and Y position
- plane: number
  the plane (Z) on which this area resides on, can use WorldPoint position
Returns WorldArea

Methods

`Static`isEdgePoint

isEdgePoint(current: WorldArea, point: WorldPoint): boolean
Parameters
- current: WorldArea
- point: WorldPoint
Returns boolean

`Static`create

create(swLocation: WorldPoint, neLocation: WorldPoint): WorldArea
Creates a new WorldArea from the south-west and north-east WorldPoint's provided
Parameters
- swLocation: WorldPoint
- neLocation: WorldPoint
Returns WorldArea

`Static`calculateNextTravellingPoint

calculateNextTravellingPoint(
    origin: WorldArea,
    target: WorldArea,
    stopAtMeleeDistance: boolean,
): WorldArea
Calculates the next travelling location from the origin area towards the target area using a similar walking algorithm by Jagex
Parameters
- origin: WorldArea
- target: WorldArea
- stopAtMeleeDistance: boolean
Returns WorldArea

`Static`createFromWorldPoint

createFromWorldPoint(location: WorldPoint, size: number): WorldArea
Creates a new WorldArea from a WorldPoint expanding based on the size provided
Parameters
- location: WorldPoint
- size: number
Returns WorldArea

getX

getX(): number
Returns number

getY

getY(): number
Returns number

getWidth

getWidth(): number
Returns number

getHeight

getHeight(): number
Returns number

getPlane

getPlane(): number
Returns number

contains

contains(other: WorldPoint): boolean
Parameters
- other: WorldPoint
Returns boolean

contains2D

contains2D(other: WorldPoint): boolean
Parameters
- other: WorldPoint
Returns boolean

distanceTo

distanceTo(other: WorldArea): number
Parameters
- other: WorldArea
Returns number

distanceTo2D

distanceTo2D(other: WorldArea): number
Parameters
- other: WorldArea
Returns number

isInMeleeDistance

isInMeleeDistance(other: WorldArea): boolean
Parameters
- other: WorldArea
Returns boolean

hasLineOfSightTo

hasLineOfSightTo(current: WorldView, other: WorldArea): boolean
Parameters
- current: WorldView
- other: WorldArea
Returns boolean

toWorldPoint

toWorldPoint(): WorldPoint
Returns WorldPoint

toWorldPointList

toWorldPointList(): WorldPoint[]
Returns WorldPoint[]