Interface ISortableEvents

Hierarchy

ISortableEvents

Index

Methods

sort sortEnd sortStart sortableCommit sortableTransfer subscribeDraggableEvents

Methods

sort

sort(item: IDraggableComponent, index: undefined | number, bindable: undefined | default, undo: (() => void)): any
Emitted on the user attempting to reorder the item in this sortable
Parameters
- item: IDraggableComponent
- index: undefined | number
- bindable: undefined | default
- undo: (() => void)
  - - (): void
    - Returns void
Returns any
- Defined in src/game/ui/util/Sortable.ts:56

sortEnd

sortEnd(item: IDraggableComponent): any
Emitted when the user is no longer sorting an item (for any reason)
Parameters
- item: IDraggableComponent
Returns any
- Defined in src/game/ui/util/Sortable.ts:44

sortStart

sortStart(item: IDraggableComponent): any
Emitted when the user begins sorting an item
Parameters
- item: IDraggableComponent
Returns any
- Defined in src/game/ui/util/Sortable.ts:40

sortableCommit

sortableCommit(): any
Emitted when the order should have changed

Returns any
- Defined in src/game/ui/util/Sortable.ts:48

sortableTransfer

sortableTransfer(item: IDraggableComponent, index: undefined | number, bindable: undefined | default, undo: (() => void), oldParent?: ISortableComponent): any
Emitted on the user attempting to transfer the item to another sortable
Parameters
- item: IDraggableComponent
- index: undefined | number
- bindable: undefined | default
- undo: (() => void)
  - - (): void
    - Returns void
- Optional oldParent: ISortableComponent
Returns any
- Defined in src/game/ui/util/Sortable.ts:52

subscribeDraggableEvents

subscribeDraggableEvents(item: IDraggableComponent, untilEvents: IUntilSubscriber<IDraggableComponent, IComponentEvents & IDraggableEvents>): any
Emitted when draggable events are subscribed on an item
Parameters
- item: IDraggableComponent
- untilEvents: IUntilSubscriber<IDraggableComponent, IComponentEvents & IDraggableEvents>
Returns any
- Defined in src/game/ui/util/Sortable.ts:36

Generated using TypeDoc