Class Tool<Options, EventsMap>`Abstract`

Type Parameters

Options extends { [optionName: string]: any }
EventsMap extends { [callbackName: string]: any }

Hierarchy

Tool

Index

Constructors

Properties

_enabled app toolOptions toolOptionsDefault

Accessors

Methods

fire hasEvent off on onDisable onEnable once setOptions updateOptions

Constructors

constructor

new Tool<Options, EventsMap>(): Tool<Options, EventsMap>
创建新的工具实例
Type Parameters
- Options extends { [optionName: string]: any }
- EventsMap extends { [callbackName: string]: any }
Returns Tool<Options, EventsMap>
- Defined in src/utils/helpers/toolBase.ts:25

Properties

`Private` _enabled

_enabled: boolean

app

app: AppBase

toolOptions

toolOptions: Options

`Protected` toolOptionsDefault

toolOptionsDefault: Options

Accessors

enabled

get enabled(): boolean
获得工具的启用状态

Returns boolean
- Defined in src/utils/helpers/toolBase.ts:43
set enabled(value: boolean): void
设置工具启用状态（触发启用和禁用时的额外操作）
Parameters
- value: boolean
Returns void
- Defined in src/utils/helpers/toolBase.ts:34

Methods

`Protected` fire

fire<EventName>(eventName: EventName, arg1?: any, arg2?: any, arg3?: any, arg4?: any, arg5?: any, arg6?: any, arg7?: any, arg8?: any): EventHandler
手动触发事件

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- Optional arg1: any
  
  参数1
- Optional arg2: any
  
  参数2
- Optional arg3: any
  
  参数3
- Optional arg4: any
  
  参数4
- Optional arg5: any
  
  参数5
- Optional arg6: any
  
  参数6
- Optional arg7: any
  
  参数7
- Optional arg8: any
  
  参数8
Returns EventHandler
- Defined in src/utils/helpers/toolBase.ts:128

hasEvent

hasEvent<EventName>(eventName: EventName): boolean
检测是否监听此事件

Returns
是否监听此事件
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
Returns boolean
- Defined in src/utils/helpers/toolBase.ts:111

off

off<EventName>(eventName: EventName, linstener: EventsMap[EventName], scope?: object): EventHandler
注销事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: EventsMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
- Defined in src/utils/helpers/toolBase.ts:102

on

on<EventName>(eventName: EventName, linstener: EventsMap[EventName], scope?: object): EventHandler
注册事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: EventsMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
- Defined in src/utils/helpers/toolBase.ts:80

`Protected` onDisable

onDisable(): void
Returns void
- Defined in src/utils/helpers/toolBase.ts:134

`Protected` onEnable

onEnable(): void
Returns void
- Defined in src/utils/helpers/toolBase.ts:133

once

once<EventName>(eventName: EventName, linstener: EventsMap[EventName], scope?: object): EventHandler
注册单次事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: EventsMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
- Defined in src/utils/helpers/toolBase.ts:91

setOptions

setOptions(options: Options): void
设置选项
Parameters
- options: Options
  
  选项
Returns void
- Defined in src/utils/helpers/toolBase.ts:52

updateOptions

updateOptions(options: { [ P in string | number | symbol]?: Options[P] }): void
更新选项
Parameters
- options: { [ P in string | number | symbol]?: Options[P] }
  
  选项
Returns void
- Defined in src/utils/helpers/toolBase.ts:65