An effect source is constructed by providing configuration options.
Optionaloptions: BaseEffectSourceOptions = {}Options which modify the base effect source instance
The data of this source.
Some other object which is responsible for this source.
The geometric shape of the effect source which is generated later.
The Sound instance which this source drives.
ReadonlysourceThe source id linked to this effect source.
Records of suppression strings with a boolean value. If any of this record is true, the source is suppressed.
Protected_A collection of boolean flags which control rendering and refresh behavior for the source.
StaticdefaultEffect source default data.
Whether or not the source is disabled
The elevation of the point source
The ID of the Level the point source is in
The x-coordinate of the source location
The y-coordinate of the source location
Static AbstracteffectsThe target collection into the effects canvas group.
StaticsourceIs this source currently active? A source is active if it is attached to an effect collection and is not disabled or suppressed.
Is this source attached to an effect collection?
The elevation bound to this source.
Is this source temporarily suppressed?
Returns the update ID associated with this source. The update ID is increased whenever the shape of the source changes.
The x-coordinate of the point source origin.
The y-coordinate of the point source origin.
Subclass specific destruction steps.
Subclass specific data initialization steps.
Provided data for configuration
Add this BaseEffectSource instance to the active collection.
Update the set of effects which are applied to the managed Sound.
Optionaloptions: { muffled?: boolean } = {}Optionalmuffled?: booleanIs the sound currently muffled?
Steps that must be performed when the source is destroyed.
Get the effective volume at which an AmbientSound source should be played for a certain listener.
Optionaloptions: { easing?: boolean } = {}Initialize and configure the source using provided data.
Provided data for configuration
Additional options which modify source initialization
Optionalreset?: booleanShould source data be reset to default values before applying changes?
The initialized source
Refresh the state and uniforms of the source. Only active sources are refreshed.
Remove this BaseEffectSource instance from the active collection.
Discard prepared effect nodes so that they are rebuilt from current source data.
Toggle playback of the Sound driven by this source, adjusting its volume and effects.
Should the sound be playing?
The target playback volume
Optionaloptions: { fade?: number; muffled?: boolean } = {}Optionalfade?: numberDuration of volume transitions in milliseconds
Optionalmuffled?: booleanIs the sound currently muffled?
Test whether the point is contained within the shape of the source.
The point.
Is inside the source?
Protected_ProtectedSubclass specific configuration steps. Occurs after data initialization and shape computation. Only called if the source is attached and not disabled and its data or shapes have changed.
Changes to the source data which were applied
Protected_ProtectedIf true is returned, BaseEffectSource#_createShapes is called in BaseEffectSource#initialize.
Changes to the source data which were applied
Protected Abstract_ProtectedCreate the polygon shape (or shapes) for this source using configured data.
Protected Abstract_ProtectedSubclass-specific refresh steps.
A specialized subclass of the BaseEffectSource which describes a point-based source of sound.
Mixes
PointEffectSource