AreaLight
Emits light from a rectangular source.
Behavior
AreaLight emits light from a rectangular source.
Summary
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 rectangular source height, in studs.
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 area light emits from both sides of its rectangle.
Whether the light contributes to volumetric lighting.
The rectangular source width, in studs.
Returns this instance if it is an ExecutionGroup.
Properties
Brightness
AreaLight.Brightness: number = 1The intensity multiplier applied to the emitted light.
Color
AreaLight.Color: Color3 = Color3.new(1, 1, 1)The color of the emitted light.
ContactShadows
AreaLight.ContactShadows: boolean = falseWhether the light adds contact shadows near surface intersections.
Enabled
AreaLight.Enabled: boolean = trueWhether this light contributes illumination.
Face
AreaLight.Face: Enum.NormalId = Enum.NormalId.FrontThe Part face on which the surface texture, light, or interface is placed.
Height
AreaLight.Height: number = 4The rectangular source height, in studs.
IesProfile
AreaLight.IesProfile: Content = ""The content identifier of the light's IES intensity profile.
Range
AreaLight.Range: number = 8The maximum distance affected by the light, in studs.
RenderLayer
AreaLight.RenderLayer: Enum.LightRenderLayer = Enum.LightRenderLayer.BothThe rendering layer used for this geometry or light.
Shadows
AreaLight.Shadows: boolean = falseWhether this light casts shadows. Additional shadow-casting lights increase rendering work.
SourceRadius
AreaLight.SourceRadius: number = 0.25The radius of the light source used for soft-shadow calculations.
Temperature
AreaLight.Temperature: number = 6500The color temperature used to tint the light.
Texture
AreaLight.Texture: Content = ""The content identifier of the texture used by this instance.
TwoSided
AreaLight.TwoSided: boolean = falseWhether the area light emits from both sides of its rectangle.
Volumetric
AreaLight.Volumetric: boolean = falseWhether the light contributes to volumetric lighting.
Width
AreaLight.Width: number = 4The rectangular source width, in studs.
Methods
GetExecutionGroup
AreaLight: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