Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ForceField

Protects a Humanoid from taking damage dealt through the Humanoid:TakeDamage() method and protects BaseParts from having their joints broken due to an Explosion.

Memory categoryInstances

Member index 1

HistoryMember
553Visible: bool
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

A ForceField protects a Humanoid from taking damage dealt through the Humanoid:TakeDamage() method and protects BaseParts from having their joints broken due to an Explosion. A new ForceField is created when a character spawns on a SpawnLocation and the SpawnLocation.Duration property is greater than zero.

Damage and Joints

A ForceField influences the instance it's parented to. When parented to a Model, it protects all of the BaseParts descending from that model. If parented to a BasePart, the part's joints will only be protected if both the part and the part it's connected to also contain a ForceField.

ForceField only protects Humanoids from damage dealt by the Humanoid:TakeDamage() method. Humanoids can still be damaged by setting Humanoid.Health directly. For this reason, it's advised that you use Humanoid:TakeDamage() to assign damage while accounting for force field protection.

Visualization

When ForceField.Visible is set to true, a particle effect is created. A number of rules determine where this effect will be emitted from:

  • When parented to a Model, if the model includes a Humanoid named Humanoid with Humanoid.RigType set to R15, the effect will be emitted from the part named UpperTorso. Otherwise, the effect will be emitted from the part named Torso.
  • When parented to a BasePart the effect will be emitted from the part's BasePart.Position.

History 7

Members 1

Visible

TypeDefault
booltrue

Determines whether or not the ForceField particle effect is visible. Setting this to false lets you replace the default particle effect with a custom effect as demonstrated in the following code sample.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 6

Settings