Class SkeldjsPathfinder

Represents a pathfinding utility for the SkeldJS Client.

See SkeldjsPathfinderEvents for events to listen to.

Hierarchy

EventEmitter<SkeldjsPathfinderEvents>
- SkeldjsPathfinder

Index

Properties

Constructors

constructor

Methods

Accessors

Properties

Static MovementInterval

MovementInterval: 6 = ...

config

config: PathfinderConfig = {}

Optional destination

destination: Vector2

The destination of the pathfinder.

Optional following

following: PlayerData<Hostable<any>>

The player that the pathfinder is currently finding.

Optional grid

grid: Grid

The grid of nodes for the pathfinder engine.

isPaused

isPaused: boolean

Optional path

path: Node[]

The current intended path of the pathfinder.

Constructors

constructor

new SkeldjsPathfinder(client: SkeldjsClient, config?: PathfinderConfig): SkeldjsPathfinder

Overrides EventEmitter.constructor
- Defined in pathfinding/lib/Pathfinder.ts:80
Parameters
- client: SkeldjsClient
- config: PathfinderConfig = {}
Returns SkeldjsPathfinder

Methods

emit

emit<Event>(event: Event): Promise<Event>

Inherited from EventEmitter.emit
- Defined in events/lib/EventEmitter.ts:36
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSerial

emitSerial<Event>(event: Event): Promise<Event>

Inherited from EventEmitter.emitSerial
- Defined in events/lib/EventEmitter.ts:50
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSync

emitSync<Event>(event: Event): Event

Inherited from EventEmitter.emitSync
- Defined in events/lib/EventEmitter.ts:62
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Event

follow

follow(player: PlayerDataResolvable): void

- Defined in pathfinding/lib/Pathfinder.ts:313
Parameters
- player: PlayerDataResolvable
Returns void

getListeners

getListeners<Event>(event: string): Listener<Event>[]

Inherited from EventEmitter.getListeners
- Defined in events/lib/EventEmitter.ts:138
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: string
Returns Listener<Event>[]

getMapId

getMapId(): string

- Defined in pathfinding/lib/Pathfinder.ts:127
Returns string

go

go(pos: PlayerDataResolvable | Vector2 | Node): void

- Defined in pathfinding/lib/Pathfinder.ts:260
Parameters
- pos: PlayerDataResolvable | Vector2 | Node
Returns void

off

off<EventName>(event: EventName, listener: Listener<SkeldjsPathfinderEvents[EventName]>): void
off<K>(event: string, listener: Listener<K>): void

Inherited from EventEmitter.off
- Defined in events/lib/EventEmitter.ts:125
Type parameters
- EventName: "pathfinding.end" | "engine.move" | "pathfinding.pause" | "engine.recalculate" | "pathfinding.start" | "pathfinding.stop"
Parameters
- event: EventName
- listener: Listener<SkeldjsPathfinderEvents[EventName]>
Returns void
Inherited from EventEmitter.off
- Defined in events/lib/EventEmitter.ts:129
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns void

on

on<EventName>(event: EventName, listener: Listener<SkeldjsPathfinderEvents[EventName]>): () => void
on<K>(event: string, listener: Listener<K>): () => void

Inherited from EventEmitter.on
- Defined in events/lib/EventEmitter.ts:74
Type parameters
- EventName: "pathfinding.end" | "engine.move" | "pathfinding.pause" | "engine.recalculate" | "pathfinding.start" | "pathfinding.stop"
Parameters
- event: EventName
- listener: Listener<SkeldjsPathfinderEvents[EventName]>
Returns () => void
- - (): void
  - Returns void
Inherited from EventEmitter.on
- Defined in events/lib/EventEmitter.ts:78
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns () => void
- - (): void
  - Returns void

once

once<EventName>(event: EventName, listener: Listener<SkeldjsPathfinderEvents[EventName]>): () => void
once<K>(event: string, listener: Listener<K>): () => void

Inherited from EventEmitter.once
- Defined in events/lib/EventEmitter.ts:86
Type parameters
- EventName: "pathfinding.end" | "engine.move" | "pathfinding.pause" | "engine.recalculate" | "pathfinding.start" | "pathfinding.stop"
Parameters
- event: EventName
- listener: Listener<SkeldjsPathfinderEvents[EventName]>
Returns () => void
- - (): void
  - Returns void
Inherited from EventEmitter.once
- Defined in events/lib/EventEmitter.ts:90
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns () => void
- - (): void
  - Returns void

pause

pause(): void

- Defined in pathfinding/lib/Pathfinder.ts:227
Returns void

recalculate

recalculate(): Promise<void>

- Defined in pathfinding/lib/Pathfinder.ts:213
Returns Promise<void>

removeAllListeners

removeAllListeners(): void

Inherited from EventEmitter.removeAllListeners
- Defined in events/lib/EventEmitter.ts:152
Returns void

removeListeners

removeListeners(event: string): void

Inherited from EventEmitter.removeListeners
- Defined in events/lib/EventEmitter.ts:147
Parameters
- event: string
Returns void

start

start(): void

- Defined in pathfinding/lib/Pathfinder.ts:232
Returns void

stop

stop(): void

- Defined in pathfinding/lib/Pathfinder.ts:250
Returns void

vent

vent(ventId: number): void

- Defined in pathfinding/lib/Pathfinder.ts:290
Parameters
- ventId: number
Returns void

wait

wait<EventName>(event: EventName): Promise<SkeldjsPathfinderEvents[EventName]>
wait(event: string): Promise<BasicEvent>

Inherited from EventEmitter.wait
- Defined in events/lib/EventEmitter.ts:99
Type parameters
- EventName: "pathfinding.end" | "engine.move" | "pathfinding.pause" | "engine.recalculate" | "pathfinding.start" | "pathfinding.stop"
Parameters
- event: EventName
Returns Promise<SkeldjsPathfinderEvents[EventName]>
Inherited from EventEmitter.wait
- Defined in events/lib/EventEmitter.ts:102
Parameters
- event: string
Returns Promise<BasicEvent>

waitf

waitf<EventName>(event: EventName, filter: (ev: SkeldjsPathfinderEvents[EventName]) => boolean | Promise<boolean>): Promise<SkeldjsPathfinderEvents[EventName]>
waitf<K>(event: string, filter: (ev: K) => boolean | Promise<boolean>): Promise<BasicEvent>

Inherited from EventEmitter.waitf
- Defined in events/lib/EventEmitter.ts:109
Type parameters
- EventName: "pathfinding.end" | "engine.move" | "pathfinding.pause" | "engine.recalculate" | "pathfinding.start" | "pathfinding.stop"
Parameters
- event: EventName
- filter: (ev: SkeldjsPathfinderEvents[EventName]) => boolean | Promise<boolean>
  - - (ev: SkeldjsPathfinderEvents[EventName]): boolean | Promise<boolean>
    - Parameters
      - ev: SkeldjsPathfinderEvents[EventName]
      Returns boolean | Promise<boolean>
Returns Promise<SkeldjsPathfinderEvents[EventName]>
Inherited from EventEmitter.waitf
- Defined in events/lib/EventEmitter.ts:113
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- filter: (ev: K) => boolean | Promise<boolean>
  - - (ev: K): boolean | Promise<boolean>
    - Parameters
      - ev: K
      Returns boolean | Promise<boolean>
Returns Promise<BasicEvent>

Accessors

myPlayer

get myPlayer(): undefined | PlayerData<SkeldjsClient>

- Defined in pathfinding/lib/Pathfinder.ts:123
Returns undefined | PlayerData<SkeldjsClient>

position

get position(): undefined | Vector2

- Defined in pathfinding/lib/Pathfinder.ts:115
Returns undefined | Vector2

transform

get transform(): undefined | CustomNetworkTransform<Hostable<any>>

- Defined in pathfinding/lib/Pathfinder.ts:119
Returns undefined | CustomNetworkTransform<Hostable<any>>

Generated using TypeDoc