Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WalkToTileHandler

Hierarchy

Implements

Index

Constructors

constructor

  • Parameters

    Returns WalkToTileHandler

Properties

Readonly event

event: IEventEmitter<this, IWalkToTileHandlerEvents> = new EventEmitter<this, E>(this)

Methods

deregister

  • deregister(): void
  • Returns void

Protected onCancelMoveToTile

  • Parameters

    Returns boolean

Protected onHoldMoveToTile

  • Parameters

    Returns boolean

Protected onHoldMoveToTilePreview

  • Parameters

    Returns boolean

onMoveComplete

  • onMoveComplete(): void
  • Event handler for when the movement completes

    Returns void

Protected onMoveToTile

  • Parameters

    Returns boolean

Protected onPostMove

  • onPostMove(player: Player, fromX: number, fromY: number, fromZ: number, fromTile: ITile, toX: number, toY: number, toZ: number, toTile: ITile): void
  • Parameters

    • player: Player
    • fromX: number
    • fromY: number
    • fromZ: number
    • fromTile: ITile
    • toX: number
    • toY: number
    • toZ: number
    • toTile: ITile

    Returns void

Protected onReleaseMoveToTilePreview

  • onReleaseMoveToTilePreview(): void
  • Returns void

Protected onStatChanged

  • Parameters

    Returns void

Protected onWalkPathChange

  • onWalkPathChange(player: Player, walkPath: IVector2[] | undefined): void
  • Parameters

    Returns void

register

  • register(): void
  • Returns void

reset

  • reset(target?: IVector2, clearWalkPath?: boolean): void
  • Resets the handler, removing any intent, path, and target.

    Parameters

    • Optional target: IVector2

      Resets the overlays to this target

    • Default value clearWalkPath: boolean = true

      Resets the walk along path

    Returns void

stopMovement

  • stopMovement(): void
  • Returns void

Generated using TypeDoc