Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SensorBase

An abstract class for various sensor instance types.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable]

Member index 3

HistoryMember
731UpdateType: SensorUpdateType
574Sense(): null
565OnSensorOutputChanged()
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

A SensorBase is an instance that, when parented to a BasePart, outputs additional data about the world around that part. Often, other systems will consume the sensor's output data.

History 8

Members 3

OnSensorOutputChanged

Parameters (0)
No parameters.

Fires when one of the sensor's output properties changes value. The event carries no arguments; read the relevant output property to get its new value.

A sensor only recomputes its outputs while UpdateType is SensorUpdateType.OnRead (the default), so with the default update type this event fires as the outputs are recalculated on read. When UpdateType is SensorUpdateType.Manual, the outputs — and therefore this event — change only when you set the output properties yourself.

Thread safetyUnsafe

History 1

Sense

Parameters (0)
No parameters.
Returns (1)
null

Recomputes the sensor's output properties immediately.

This method is deprecated and should not be used in new work. When UpdateType is SensorUpdateType.OnRead (the default), the sensor recalculates its output properties automatically the next time you read them, so calling this method is unnecessary. When UpdateType is SensorUpdateType.Manual, the outputs are never recomputed automatically; set the output properties yourself rather than calling this method.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

UpdateType

TypeDefault
SensorUpdateType

Determines how the sensor will update its output data.

With SensorUpdateType.OnRead, internal sensor logic is run so that the output properties are always up to date. In this mode, the sensor will only run if you read the properties and they are currently outdated.

With SensorUpdateType.Manual, the output properties will never change. Instead, you can write your own scripts to set the output properties as you like.

Thread safetyReadSafe
CategorySettings
Loaded/Savedtrue

History 3

Settings