Class default

Hierarchy

Host<IWalkToTileHandlerEvents>
- default

Index

Constructors

Properties

Accessors

Methods

deregister onCancelMoveToTile onHoldMoveToTile onHoldMoveToTilePreview onMoveComplete onMoveToTile onPostMove onReleaseMoveToTilePreview onWalkPathChange register reset stopMovement

Constructors

constructor

new default(surface: default<HTMLElement>): default
Parameters
- surface: default<HTMLElement>
Returns default
Overrides Host.constructor
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:64

Properties

`Readonly` event

event: IEventEmitter<default, IWalkToTileHandlerEvents> = ...

Accessors

surface

get surface(): default<HTMLElement>
Returns default<HTMLElement>
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:60

Methods

deregister

deregister(): void
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:74

`Protected` onCancelMoveToTile

onCancelMoveToTile(_api: IBindHandlerApi): boolean
Parameters
- _api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:151

onHoldMoveToTile

onHoldMoveToTile(api: IBindHandlerApi): boolean
Parameters
- api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:133

`Protected` onHoldMoveToTilePreview

onHoldMoveToTilePreview(api: IBindHandlerApi): boolean
Parameters
- api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:161

onMoveComplete

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

Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:87

`Protected` onMoveToTile

onMoveToTile(api: IBindHandlerApi): boolean
Parameters
- api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:118

`Protected` onPostMove

onPostMove(player: default, fromTile: default, toTile: default): void
Parameters
- player: default
- fromTile: default
- toTile: default
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:193

`Protected` onReleaseMoveToTilePreview

onReleaseMoveToTilePreview(): void
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:184

`Protected` onWalkPathChange

onWalkPathChange(player: default, walkPath: undefined | IVector2[]): void
Parameters
- player: default
- walkPath: undefined | IVector2[]
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:202

register

register(): void
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:69

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
- clearWalkPath: boolean = true
  
  Resets the walk along path
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:96

stopMovement

stopMovement(): void
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/WalkToTileHandler.ts:79

Generated using TypeDoc