SoundEffect¶
SoundEffect is the base class that all other sound effects derive from. A SoundEffect can be applied to either a Sound or SoundGroup by being parented to either.
Description¶
SoundEffect is the base class that all other sound effects derive from. A SoundEffect can be applied to either a Sound or SoundGroup by being parented to either. Multiple effects can be applied to the same Sound or SoundGroup. The order the effects will be applied in is determined by that effect's Priority.
Inheritance¶
Object → Instance → SoundEffect
Nova inheritance: Instance → SoundEffect
Known subclasses: ChorusSoundEffect, CompressorSoundEffect, CustomSoundEffect, DistortionSoundEffect, EchoSoundEffect, EqualizerSoundEffect, FlangeSoundEffect, PitchShiftSoundEffect, and 2 more
Properties¶
Enabled Supported Property Toggles the effect on and off.
Priority Supported Property Determines the order the effect will be applied in relation to other effects.
Determines the order the effect will be applied in relation to other effects. Higher priority effects will be applied earlier. The exception is when Priority equals 0 (which is the default). In this case, the base priority for the effect will be used. If the priority of two effects are equal, then the order is undetermined.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
Roblox reference: SoundEffect
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.