Class default

Hierarchy

default

Index

Properties

Accessors

Methods

dragEnd dragStart setBindable setDelay setInputFilter setStickyDistance stopDragging get

Properties

`Static` isDragging

isDragging: boolean = false

Accessors

host

get host(): IDraggableComponent
Returns IDraggableComponent
- Defined in src/game/ui/util/Draggable.ts:70

Methods

dragEnd

dragEnd(event?: IDraggableInputEvent): boolean
Parameters
- Optional event: IDraggableInputEvent
Returns boolean
- Defined in src/game/ui/util/Draggable.ts:222

dragStart

dragStart(event: IDraggableInputEvent): boolean
Parameters
- event: IDraggableInputEvent
Returns boolean
- Defined in src/game/ui/util/Draggable.ts:151

setBindable

setBindable(bindables: ArrayOr<default>, priority?: number): default
Sets this draggable to be dragged on a bindable press/release instead of mouse/touch. Incompatible with setInputFilter
Parameters
- bindables: ArrayOr<default>
- Optional priority: number
Returns default
- Defined in src/game/ui/util/Draggable.ts:104

setDelay

setDelay(delay: number): default
Parameters
- delay: number
Returns default
- Defined in src/game/ui/util/Draggable.ts:87

setInputFilter

setInputFilter(filter?: ((input: IDraggableInputEvent) => any)): default
Parameters
- Optional filter: ((input: IDraggableInputEvent) => any)
  - - (input: IDraggableInputEvent): any
    - Parameters
      
      input: IDraggableInputEvent
      
      Returns any
Returns default
- Defined in src/game/ui/util/Draggable.ts:93

setStickyDistance

setStickyDistance(stickyDistance: number): default
Parameters
- stickyDistance: number
Returns default
- Defined in src/game/ui/util/Draggable.ts:81

stopDragging

stopDragging(): void
Returns void
- Defined in src/game/ui/util/Draggable.ts:128

`Static` get

get(host: IDraggableComponent): default
Parameters
- host: IDraggableComponent
Returns default
- Defined in src/game/ui/util/Draggable.ts:54

Generated using TypeDoc