Class default

Hierarchy

default
- default

Index

Constructors

constructor

new default(host: IInteractionHandlerHost): default
Parameters
- host: IInteractionHandlerHost
Returns default
Inherited from default.constructor
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:61

Properties

`Readonly` event

event: IEventEmitter<default, IInteractionHandlerEvents>

Accessors

`Protected` actionMenu

get actionMenu(): undefined | default
Returns undefined | default
Inherited from InteractionHandler.actionMenu
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:57

`Protected` host

get host(): undefined | IInteractionHandlerHost
Returns undefined | IInteractionHandlerHost
Inherited from InteractionHandler.host
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:41

`Protected` hoveredTile

get hoveredTile(): undefined | default
Returns undefined | default
Inherited from InteractionHandler.hoveredTile
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:45

`Protected` movement

get movement(): undefined | default
Returns undefined | default
Inherited from InteractionHandler.movement
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:49

`Protected` pathing

get pathing(): undefined | default
Returns undefined | default
Inherited from InteractionHandler.pathing
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:53

Methods

deregister

deregister(): default
Returns default
Inherited from default.deregister
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:81

forcePreviewPath

forcePreviewPath(path: IVector2[]): void
Parameters
- path: IVector2[]
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/PathingHandler.ts:297

`Protected` isMouseWithin

isMouseWithin(api?: InteractionHandlerRequiredBindHandlerApi): boolean
Parameters
- Optional api: InteractionHandlerRequiredBindHandlerApi
Returns boolean
Inherited from default.isMouseWithin
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:66

`Protected` onCancelMoveToTile

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

onHoldMoveToTile

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

`Protected` onHoldMoveToTilePreview

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

onMoveComplete

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

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

`Protected` onMoveToTile

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

`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/PathingHandler.ts:177

`Protected` onReleaseMoveToTilePreview

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

`Protected` onWalkToChange

onWalkToChange(player: default, walkTo: undefined | WalkTo): void
Parameters
- player: default
- walkTo: undefined | WalkTo
Returns void
- Defined in src/game/ui/screen/screens/game/util/movement/PathingHandler.ts:186

register

register(): default
Returns default
Inherited from default.register
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:74

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/PathingHandler.ts:68

stopMovement

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

updatePreview

updatePreview(target: IVector2, forced?: boolean, range?: FindPathRange): undefined | IVector2[]
Finds a path to a target and then updates the overlay to that path (if it was valid)
Parameters
- target: IVector2
- forced: boolean = false
- range: FindPathRange = FindPathRangeType.SameTile
Returns undefined | IVector2[]
- Defined in src/game/ui/screen/screens/game/util/movement/PathingHandler.ts:273

`Protected` wasCatalystStartWithin

wasCatalystStartWithin(api: InteractionHandlerRequiredBindHandlerApi): boolean
Parameters
- api: InteractionHandlerRequiredBindHandlerApi
Returns boolean
Inherited from default.wasCatalystStartWithin
- Defined in src/game/ui/screen/screens/game/util/movement/InteractionHandler.ts:70

Generated using TypeDoc