Class
SoundEffect
NotCreatable
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.
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.
Properties 2#
Enabledboolean | Toggles the effect on and off.ReadSafe |
Priorityint | Determines the order the effect will be applied in relation to other effects.ReadSafe |
Enabled: boolean#
ReadSafe
Toggles the effect on and off. True by default.
Priority: int#
ReadSafe
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 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild
Subclasses 9#
ChorusSoundEffect, CompressorSoundEffect, DistortionSoundEffect, EchoSoundEffect, EqualizerSoundEffect, FlangeSoundEffect, PitchShiftSoundEffect, ReverbSoundEffect, TremoloSoundEffect