Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SurfaceLight

A light source that emits illumination of a specified color and brightness from a face for a specified range.

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
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: 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
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: 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()
657StyledPropertiesChanged()
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 SurfaceLight is a light source that emits illumination of a specified Light.Color and Light.Brightness from a SurfaceLight.Face for a specified SurfaceLight.Range.

In order for a SurfaceLight to provide illumination, it must be the direct child of a BasePart or Attachment (the part or attachment itself must be a descendant of the Workspace). If a SurfaceLight is parented to a part, then the light will emanate from the part's selected face(s). If parented to an attachment SurfaceLight is equivalent to a SpotLight.

For more light types, please see the see also section.

See Also

History 16

Members 3

Angle

TypeDefault
float

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Face

TypeDefault
NormalId

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Range

TypeDefault
float

The distance from the SurfaceLight's face that will illuminate.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Settings