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
726		HitFrame: CFrame
726		HitNormal: Vector3
726		LadderSearchHeight: float
726		LadderSearchOffset: float
726		SearchDistance: float
726		SensedMaterial: Material
726		SensedPart: BasePart
726		SensorMode: SensorMode
3 members inherited from SensorBase
726		UpdateType: SensorUpdateType
574		Sense(): null
565		OnSensorOutputChanged()
60 members inherited from Instance
726		Archivable: bool
726		Capabilities: SecurityCapabilities
726		DataCost: int
726		IsInSandbox: bool
726		Name: string
726		Parent: Instance
726		PredictionMode: PredictionMode
726		RobloxLocked: bool
726		Sandboxed: bool
726		SourceAssetId: int64
726		UniqueId: UniqueId
726		archivable: bool
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
726		children(): Instances
726		clone(): Instance
726		destroy(): null
726		findFirstChild(name: string, recursive: bool = false): Instance
726		getChildren(): Instances
726		isDescendantOf(ancestor: Instance): bool
726		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()
726		childAdded(child: Instance)
6 members inherited from Object
726		ClassName: string
726		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
726		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 22
Hide member changes

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

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

Thread safety	ReadSafe
Category	Output
Loaded/Saved	true

History 5

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

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

Thread safety	ReadSafe
Category	Output
Loaded/Saved	true

History 3

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

Thread safety	ReadSafe
Category	Input
Loaded/Saved	true

History 2

726 Change Default of LadderSearchHeight from 6 to
717 Add LadderSearchHeight

LadderSearchOffset
CreatorHub

Type		Default
float

Thread safety	ReadSafe
Category	Input
Loaded/Saved	true

History 2

726 Change Default of LadderSearchOffset from 5 to
717 Add LadderSearchOffset

SearchDistance
CreatorHub

Type		Default
float

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

Thread safety	ReadSafe
Category	Input
Loaded/Saved	true

History 2

726 Change Default of SearchDistance from 0 to
565 Add SearchDistance

SensedMaterial
CreatorHub

Type		Default
Material

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

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 2

726 Change Default of SensedPart from to
565 Add SensedPart

SensorMode
CreatorHub

Type		Default
SensorMode

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 2

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 22
Hide member changes

Members 8

HitFrame
CreatorHub

History 5

HitNormal
CreatorHub

History 3

LadderSearchHeight
CreatorHub

History 2

LadderSearchOffset
CreatorHub

History 2

SearchDistance
CreatorHub

History 2

SensedMaterial
CreatorHub

History 2

SensedPart
CreatorHub

History 2

SensorMode
CreatorHub

History 2

Settings