SurfaceLight
Emits light from a selected face of a Part.
Behavior
SurfaceLight emits light from a selected face of a Part.
Summary
The angular extent of light emission, in degrees.
The intensity multiplier applied to the emitted light.
The color of the emitted light.
Whether the light adds contact shadows near surface intersections.
Whether this light contributes illumination.
The Part face on which the surface texture, light, or interface is placed.
The content identifier of the light's IES intensity profile.
The maximum distance affected by the light, in studs.
The rendering layer used for this geometry or light.
Whether this light casts shadows.
The radius of the light source used for soft-shadow calculations.
The color temperature used to tint the light.
The content identifier of the texture used by this instance.
Whether the light contributes to volumetric lighting.
Returns this instance if it is an ExecutionGroup.
Properties
Angle
SurfaceLight.Angle: number = 90The angular extent of light emission, in degrees.
Brightness
SurfaceLight.Brightness: number = 1The intensity multiplier applied to the emitted light.
Color
SurfaceLight.Color: Color3 = Color3.new(1, 1, 1)The color of the emitted light.
ContactShadows
SurfaceLight.ContactShadows: boolean = falseWhether the light adds contact shadows near surface intersections.
Enabled
SurfaceLight.Enabled: boolean = trueWhether this light contributes illumination.
Face
SurfaceLight.Face: Enum.NormalId = Enum.NormalId.FrontThe Part face on which the surface texture, light, or interface is placed.
IesProfile
SurfaceLight.IesProfile: Content = ""The content identifier of the light's IES intensity profile.
Range
SurfaceLight.Range: number = 8The maximum distance affected by the light, in studs.
RenderLayer
SurfaceLight.RenderLayer: Enum.LightRenderLayer = Enum.LightRenderLayer.BothThe rendering layer used for this geometry or light.
Shadows
SurfaceLight.Shadows: boolean = falseWhether this light casts shadows. Additional shadow-casting lights increase rendering work.
SourceRadius
SurfaceLight.SourceRadius: number = 0.25The radius of the light source used for soft-shadow calculations.
Temperature
SurfaceLight.Temperature: number = 6500The color temperature used to tint the light.
Texture
SurfaceLight.Texture: Content = ""The content identifier of the texture used by this instance.
Volumetric
SurfaceLight.Volumetric: boolean = falseWhether the light contributes to volumetric lighting.
Methods
GetExecutionGroup
SurfaceLight:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying