Interface IExternalInteractor

Hierarchy

IInteractor
- IExternalInteractor

Implemented by

ExternalInteractorBase

Index

Properties

handleClickMode? loadModeOptions? loadOptions? loadParticlesOptions? type

Methods

clear init interact isEnabled reset

Properties

`Optional` handleClickMode

handleClickMode?: ((mode) => void)

Type declaration

- (mode): void
- Parameters
  - mode: string
  Returns void

`Optional` loadModeOptions

loadModeOptions?: ((options, ...sources) => void)

Type declaration

- (options, ...sources): void
- Parameters
  - options: Modes
  - Rest ...sources: RecursivePartial<undefined | IModes>[]
  Returns void

`Optional` loadOptions

loadOptions?: ((options, ...sources) => void)

Type declaration

- (options, ...sources): void
- Parameters
  - options: Options
  - Rest ...sources: (undefined | RecursivePartial<IOptions>)[]
  Returns void

`Optional` loadParticlesOptions

loadParticlesOptions?: ((options, ...sources) => void)

Type declaration

- (options, ...sources): void
- Parameters
  - options: ParticlesOptions
  - Rest ...sources: (undefined | RecursivePartial<IParticlesOptions>)[]
  Returns void

type

type: InteractorType

Methods

clear

clear(particle, delta): void
Parameters
- particle: Particle
- delta: IDelta
Returns void
Inherited from IInteractor.clear
- Defined in Core/Interfaces/IInteractor.ts:22

init

init(): void
Returns void
Inherited from IInteractor.init
- Defined in Core/Interfaces/IInteractor.ts:24

interact

interact(delta): Promise<void>
Parameters
- delta: IDelta
Returns Promise<void>
- Defined in Core/Interfaces/IExternalInteractor.ts:16

isEnabled

isEnabled(particle?): boolean
Parameters
- Optional particle: Particle
Returns boolean
- Defined in Core/Interfaces/IExternalInteractor.ts:18

reset

reset(particle): void
Parameters
- particle: Particle
Returns void
Inherited from IInteractor.reset
- Defined in Core/Interfaces/IInteractor.ts:26