tsParticles - v4.0.0-beta.12
    Preparing search index...

    Interface IExternalInteractor<TParticle>

    External interactor interface

    interface IExternalInteractor<TParticle extends Particle = Particle> {
        handleClickMode?: (
            mode: string,
            interactivityData: IInteractivityData,
        ) => void;
        loadModeOptions?: (
            options: Modes,
            ...sources: RecursivePartial<IModes | undefined>[],
        ) => void;
        loadOptions?: (
            options: Options,
            ...sources: (RecursivePartial<IOptions> | undefined)[],
        ) => void;
        loadParticlesOptions?: (
            options: InteractivityParticlesOptions,
            ...sources: (RecursivePartial<IInteractivityParticlesOptions> | undefined)[],
        ) => void;
        maxDistance: number;
        type: InteractorType;
        clear(particle: TParticle, delta: IDelta): void;
        init(): void;
        interact(interactivityData: IInteractivityData, delta: IDelta): void;
        isEnabled(
            interactivityData: IInteractivityData,
            particle?: TParticle,
        ): boolean;
        reset(interactivityData: IInteractivityData, particle: TParticle): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    handleClickMode? loadModeOptions? loadOptions? loadParticlesOptions? maxDistance type

    Methods

    clear init interact isEnabled reset

    Properties

    handleClickMode?: (mode: string, interactivityData: IInteractivityData) => void
    loadModeOptions?: (
        options: Modes,
        ...sources: RecursivePartial<IModes | undefined>[],
    ) => void
    loadOptions?: (
        options: Options,
        ...sources: (RecursivePartial<IOptions> | undefined)[],
    ) => void

    Loads interactor options from source options

    loadParticlesOptions?: (
        options: InteractivityParticlesOptions,
        ...sources: (RecursivePartial<IInteractivityParticlesOptions> | undefined)[],
    ) => void

    Loads particles options from source options

    maxDistance: number

    The maximum distance for this interactor

    type: InteractorType

    The interactor type

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods