ParticleAttractor
Applies attraction to particles within a configured region.
- Creatable
Instance.new("ParticleAttractor")- Inherits
- Instance
- Replication
- Standard
Behavior
ParticleAttractor applies attraction to particles within a configured region.
Summary
The distance-based reduction in particle attraction strength.
The contribution of the configured direction to particle attraction.
Whether this particle attractor is enabled.
The radius of the particle attraction region.
The boundary shape used for this region.
The dimensions of this region, in studs.
The magnitude of the particle attraction.
Returns this instance if it is an ExecutionGroup.
Properties
Attenuation
ParticleAttractor.Attenuation: number = 1The distance-based reduction in particle attraction strength.
Directionality
ParticleAttractor.Directionality: number = 0The contribution of the configured direction to particle attraction.
Enabled
ParticleAttractor.Enabled: boolean = trueWhether this particle attractor is enabled.
Radius
ParticleAttractor.Radius: number = 12The radius of the particle attraction region.
Shape
ParticleAttractor.Shape: Enum.ParticleAttractorShape = Enum.ParticleAttractorShape.SphereThe boundary shape used for this region.
Size
ParticleAttractor.Size: Vector3 = Vector3.new(8, 8, 8)The dimensions of this region, in studs.
Strength
ParticleAttractor.Strength: number = 20The magnitude of the particle attraction.
Methods
GetExecutionGroup
ParticleAttractor:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying