Interface PBLightSource

Hierarchy

  • PBLightSource

Properties

active? brightness? color? range? type?

Properties

Optional active

active?: boolean

default = true, whether the lightSource is active or not.

Optional brightness

brightness?: number

default = 250, ranges from 1 (dim) to 100,000 (very bright), expressed in Lumens for Point and Spot.

Optional color

color?: PBColor3

default = Color.white, the tint of the light, in RGB format where each component is a floating point value with a range from 0 to 1.

Optional range

range?: number

default = 10, how far the light travels, expressed in meters.

Optional type

type?: {
    $case: "point";
    point: PBLightSource_Point;
} | {
    $case: "spot";
    spot: PBLightSource_Spot;
}

Settings

Member Visibility

Theme