Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BuoyancySensor

A SensorBase that outputs data about how its BasePart is interacting with Terrain water.

Memory categoryInstances

Member index 2

HistoryMember
565FullySubmerged: bool
565TouchingSurface: bool
inherited from SensorBase
565UpdateType: SensorUpdateType
574Sense(): null
565OnSensorOutputChanged()
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 SensorBase that outputs data about how its BasePart is interacting with Terrain water, allowing you to determine if the part is or is not in water.

History 4

Members 2

FullySubmerged

TypeDefault
boolfalse

This property is true when the entirety of the BasePart is submerged in Terrain water with at least one voxel of water above it.

Thread safetyReadSafe
CategoryOutput
Loaded/Savedtrue

History 1

TouchingSurface

TypeDefault
boolfalse

This property is true when any position on the BasePart is touching Terrain water. The detection measurements are not exact and may use the bounding box of the part instead of its exact geometry.

Thread safetyReadSafe
CategoryOutput
Loaded/Savedtrue

History 1

Settings