SurfaceLight

Show Deprecated

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

Code Samples

Creating a New Surface Light

local part = Instance.new("Part")
part.Anchored = true
part.Position = Vector3.new(0, 0, 0)
part.Parent = workspace
local light = Instance.new("SurfaceLight")
light.Color = Color3.fromRGB(255, 255, 255)
light.Brightness = 1
light.Range = 16
light.Parent = part

Summary

Properties

  • read parallel

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

  • read parallel

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

  • read parallel

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

Properties inherited from Light
  • read parallel

    Sets how bright the emitted light is, defaults to 1.

  • read parallel

    The color of the emitted light.

  • read parallel

    If set to true, light will be emitted from the source object.

  • read parallel

    If set to true, will project shadows if light is blocked by an obstacle.

Properties

Angle

read parallel

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

read parallel

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

Range

read parallel

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

Methods

Events