Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SpotLight

A light source that emits light directionally in the shape of a cone with a spherical base.

Memory categoryInstances

Member index 3

HistoryMember
554Angle: float
554Face: NormalId
554Range: float
inherited from Light
553Brightness: float
553Color: Color3
553Enabled: bool
553Shadows: 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 Spotlight emits light of a specified Color and Brightness in the shape of a cone with a spherical base. This object is ideal for directional light sources like flashlights and headlights.

Range controls the distance of illumination and Angle defines the angle of light emission from the cone's apex as illustrated below.

A spotlight must be a direct child of a BasePart or Attachment and will exhibit the following behavior:

  • When the spotlight is parented to a BasePart, the Face property determines the face of the part from which light emanates.

  • Although Attachments don't have faces, the Face property determines the axis of the attachment from which light emanates; -Z is front, +X is right, +Y is top, etc.

See also SurfaceLight and PointLight.

History 24

Members 3

Angle

TypeDefault
float

The angle of which the light is shone from the SpotLight.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 9

Face

TypeDefault
NormalId

Sets the side of the parent that the SpotLight comes from.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Range

TypeDefault
float

The size of the area that the SpotLight will illuminate.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 9

Settings