Class ExternalLighter

External light interactor

Hierarchy

ExternalInteractorBase<LightContainer>
- ExternalLighter

Index

Constructors

Properties

container maxDistance type

Methods

clear init interact isEnabled loadModeOptions reset

Constructors

constructor

new ExternalLighter(
pluginManager: PluginManager,
container: LightContainer,
): ExternalLighter
Parameters
- pluginManager: PluginManager
- container: LightContainer
Returns ExternalLighter
Overrides ExternalInteractorBase<LightContainer>.constructor
- Defined in interactions/light/src/ExternalLighter.ts:23

Properties

`Protected` `Readonly`container

container: LightContainer

`Readonly`maxDistance

maxDistance: 0

type

type: InteractorType

Methods

clear

clear(): void
Returns void
Overrides ExternalInteractorBase.clear
- Defined in interactions/light/src/ExternalLighter.ts:29

init

init(): void
Returns void
Overrides ExternalInteractorBase.init
- Defined in interactions/light/src/ExternalLighter.ts:33

interact

interact(interactivityData: IInteractivityData): void
Parameters
- interactivityData: IInteractivityData
Returns void
Overrides ExternalInteractorBase.interact
- Defined in interactions/light/src/ExternalLighter.ts:37

isEnabled

isEnabled(
interactivityData: IInteractivityData,
particle?: LightParticle,
): boolean
Parameters
- interactivityData: IInteractivityData
- Optionalparticle: LightParticle
Returns boolean
Overrides ExternalInteractorBase.isEnabled
- Defined in interactions/light/src/ExternalLighter.ts:57

loadModeOptions

loadModeOptions(
options: Modes & LightMode,
...sources: RecursivePartial<IModes & ILightMode | undefined>[],
): void
Parameters
- options: Modes & LightMode
- ...sources: RecursivePartial<IModes & ILightMode | undefined>[]
Returns void
- Defined in interactions/light/src/ExternalLighter.ts:81

reset

reset(): void
Returns void
Overrides ExternalInteractorBase.reset
- Defined in interactions/light/src/ExternalLighter.ts:85