ControllerPartSensor
CreatorHub

A SensorBase that outputs data about another BasePart based on Humanoid floor and ladder detection logic.

Memory category	Instances

Member index 8

History		Member
731		HitFrame: CFrame
731		HitNormal: Vector3
731		LadderSearchHeight: float
731		LadderSearchOffset: float
731		SearchDistance: float
731		SensedMaterial: Material
731		SensedPart: BasePart
731		SensorMode: SensorMode
3 members inherited from SensorBase
731		UpdateType: SensorUpdateType
574		Sense(): null
565		OnSensorOutputChanged()
68 members inherited from Instance
731		Archivable: bool
731		Attributes: string
731		AttributesReplicate: string
731		AttributesSerialize: BinaryString
731		Capabilities: SecurityCapabilities
731		DataCost: int
731		DefinesCapabilities: bool
731		HistoryId: UniqueId
731		IsInSandbox: bool
731		Name: string
731		Parent: Instance
731		PredictionMode: PredictionMode
731		PropertyStatusStudio: PropertyStatus
731		RobloxLocked: bool
731		Sandboxed: bool
731		SourceAssetId: int64
731		Tags: SharedString
731		UniqueId: UniqueId
731		archivable: bool
731		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
731		children(): Instances
731		clone(): Instance
731		destroy(): null
731		findFirstChild(name: string, recursive: bool = false): Instance
731		getChildren(): Instances
731		isDescendantOf(ancestor: Instance): bool
731		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
731		childAdded(child: Instance)
6 members inherited from Object
731		ClassName: string
731		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
731		isA(className: string): bool
647		Changed(property: string)

Description

A SensorBase that outputs data about another BasePart based on Humanoid floor and ladder detection logic. It is primarily used for sending data to a character controller. Using a ControllerPartSensor allows you to detect BaseParts in the same manner as the Humanoid uses for detecting floors and ladders.

History 30
Hide member changes

731 Change Default of SensorMode from to Floor
731 Change Default of SensedPart from to
731 Change Default of SensedMaterial from to Air
731 Change Default of SearchDistance from to 0
731 Change Default of LadderSearchOffset from to 5
731 Change Default of LadderSearchHeight from to 6
731 Change Default of HitNormal from to Vector3(0, 1, 0)
731 Change Default of HitFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
726 Change Default of SensorMode from Floor to
726 Change Default of SensedPart from to
726 Change Default of SensedMaterial from Air to
726 Change Default of SearchDistance from 0 to
726 Change Default of LadderSearchOffset from 5 to
726 Change Default of LadderSearchHeight from 6 to
726 Change Default of HitNormal from Vector3(0, 1, 0) to
726 Change Default of HitFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
722 Change Default of HitNormal from Vector3(0, 0, 0) to Vector3(0, 1, 0)
717 Add LadderSearchOffset
717 Add LadderSearchHeight
714 Add SensedMaterial
705 Change Default of HitFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
705 Change Default of HitFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
702 Change Default of HitFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
597 Change Tags of ControllerPartSensor from [NotBrowsable] to []
565 Add SensorMode
565 Add SensedPart
565 Add SearchDistance
565 Add HitNormal
565 Add HitFrame
565 Add ControllerPartSensor

Members 8

HitFrame
CreatorHub

Type		Default
CFrame		0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

The position in world space where the sensor hit the ControllerPartSensor.SensedPart.

Thread safety	ReadSafe
Category	Output
Loaded/Saved	true

History 6

731 Change Default of HitFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
726 Change Default of HitFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
705 Change Default of HitFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
705 Change Default of HitFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
702 Change Default of HitFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
565 Add HitFrame

HitNormal
CreatorHub

Type		Default
Vector3		0, 1, 0

The surface normal at the position where the sensor hit the SensedPart.

Thread safety	ReadSafe
Category	Output
Loaded/Saved	true

History 4

731 Change Default of HitNormal from to Vector3(0, 1, 0)
726 Change Default of HitNormal from Vector3(0, 1, 0) to
722 Change Default of HitNormal from Vector3(0, 0, 0) to Vector3(0, 1, 0)
565 Add HitNormal

LadderSearchHeight
CreatorHub

Type		Default
float		6

Top of the vertical extent the sensor scans for a climbable ladder, in studs relative to the sensor's parent BasePart. Together with ControllerPartSensor.LadderSearchOffset, it defines the height range: the region extends upward to LadderSearchHeight minus LadderSearchOffset.

Defaults to 6; clamped to non-negative values.

Only affects sensing when ControllerPartSensor.SensorMode is a ladder mode such as SensorMode.Ladder. Because SensorMode defaults to SensorMode.Floor, this has no effect until SensorMode is changed.

Thread safety	ReadSafe
Category	Input
Loaded/Saved	true

History 3

731 Change Default of LadderSearchHeight from to 6
726 Change Default of LadderSearchHeight from 6 to
717 Add LadderSearchHeight

LadderSearchOffset
CreatorHub

Type		Default
float		5

Downward offset, in studs relative to the parent BasePart, that positions the vertical extent scanned for a climbable ladder. Behaves like a hip-height offset: increasing it lowers both the bottom and top of the searched region, and scales the rung-spacing tolerance used to decide whether a surface is climbable.

Defaults to 5; clamped to non-negative values.

Thread safety	ReadSafe
Category	Input
Loaded/Saved	true

History 3

731 Change Default of LadderSearchOffset from to 5
726 Change Default of LadderSearchOffset from 5 to
717 Add LadderSearchOffset

SearchDistance
CreatorHub

Type		Default
float		0

The distance from the sensor's parent BasePart to use when sensing other parts.

Thread safety	ReadSafe
Category	Input
Loaded/Saved	true

History 3

731 Change Default of SearchDistance from to 0
726 Change Default of SearchDistance from 0 to
565 Add SearchDistance

SensedMaterial
CreatorHub

Type		Default
Material		Air

Surface Material of the part the sensor currently detects, matching the material Humanoid floor and ladder detection report for the same contact. Updated as an output alongside ControllerPartSensor.SensedPart, ControllerPartSensor.HitFrame, and ControllerPartSensor.HitNormal each time the sensor senses.

Defaults to Material.Air.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

731 Change Default of SensedMaterial from to Air
726 Change Default of SensedMaterial from Air to
714 Add SensedMaterial

SensedPart
CreatorHub

Type		Default
BasePart

A reference to the BasePart hit by the sensor.

Thread safety	ReadSafe
Category	Output
Loaded/Saved	true

History 3

731 Change Default of SensedPart from to
726 Change Default of SensedPart from to
565 Add SensedPart

SensorMode
CreatorHub

Type		Default
SensorMode		Floor

Determines what behavior this SensorBase uses when sensing other parts.

A setting of SensorMode.Ladder performs the same ladder detection logic used by a Humanoid to populate sensor output. It currently always senses along the forward vector of its parent BasePart.

A setting of SensorMode.Floor performs the same floor detection logic used by a Humanoid to populate sensor output. It currently always senses along the negative up vector of the world.

Thread safety	ReadSafe
Category	Input
Loaded/Saved	true

History 3

731 Change Default of SensorMode from to Floor
726 Change Default of SensorMode from Floor to
565 Add SensorMode

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ControllerPartSensor
CreatorHub

Member index 8

Description

History 30
Hide member changes

Members 8

HitFrame
CreatorHub

History 6

HitNormal
CreatorHub

History 4

LadderSearchHeight
CreatorHub

History 3

LadderSearchOffset
CreatorHub

History 3

SearchDistance
CreatorHub

History 3

SensedMaterial
CreatorHub

History 3

SensedPart
CreatorHub

History 3

SensorMode
CreatorHub

History 3

Settings