GravityField
Applies directional or radial gravity within a bounded region.
- Creatable
Instance.new("GravityField")- Inherits
- Instance
- Replication
- Standard
Behavior
GravityField applies directional or radial gravity within a bounded region.
Summary
Whether this gravity field adds to the existing gravity rather than replacing it.
The direction of acceleration applied by this gravity field.
Whether this gravity field is enabled.
The distance attenuation applied to the gravity field.
The relative priority used to order or process this object.
The radius of the gravity-field boundary.
The boundary shape used for this region.
The magnitude of the particle attraction.
Returns this instance if it is an ExecutionGroup.
Returns this field's gravity contribution at the supplied world-space position.
Properties
Additive
GravityField.Additive: boolean = falseWhether this gravity field adds to the existing gravity rather than replacing it.
Direction
GravityField.Direction: Vector3 = Vector3.new(0, -1, 0)The direction of acceleration applied by this gravity field.
Enabled
GravityField.Enabled: boolean = trueWhether this gravity field is enabled.
Falloff
GravityField.Falloff: Enum.GravityFalloff = Enum.GravityFalloff.NoneThe distance attenuation applied to the gravity field.
Priority
GravityField.Priority: number = 0The relative priority used to order or process this object.
Radius
GravityField.Radius: number = 100The radius of the gravity-field boundary.
Shape
GravityField.Shape: Enum.GravityFieldShape = Enum.GravityFieldShape.SphereThe boundary shape used for this region.
Strength
GravityField.Strength: number = 196.2The magnitude of the particle attraction.
Methods
GetExecutionGroup
GravityField:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
GetPullAt
Returns this field's gravity contribution at the supplied world-space position.
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