Class LightComponentElement

The LightComponentElement interface provides properties and methods for manipulating <pc-light> elements. The LightComponentElement interface also inherits the properties and methods of the HTMLElement interface.

Engine component: LightComponent (light).

Hierarchy (View Summary)

ComponentElement
- LightComponentElement

Accessors

castShadows

get castShadows(): boolean
Gets the cast shadows flag of the light.

Returns boolean
The cast shadows flag.
- Defined in src/components/light-component.ts:144
set castShadows(value: boolean): void
Sets the cast shadows flag of the light.
Parameters
- value: boolean
  The cast shadows flag.
Returns void
- Defined in src/components/light-component.ts:133

closestApp

get closestApp(): AppElement | null
The nearest ancestor <pc-app> element, or null if this element has no <pc-app> ancestor. The search starts at the parent, so an element never resolves to itself.

Returns AppElement | null
The closest app element, or null.
Inherited from ComponentElement.closestApp
- Defined in src/async-element.ts:31

closestEntity

get closestEntity(): EntityBaseElement | null
The nearest ancestor element that fronts an entity — <pc-entity>, <pc-model> or <pc-node> — or null if this element has no such ancestor. The search starts at the parent, so an element never resolves to itself.

Returns EntityBaseElement | null
The closest entity-fronting element, or null.
Inherited from ComponentElement.closestEntity
- Defined in src/async-element.ts:41

color

get color(): Color
Gets the color of the light.

Returns Color
The color.
- Defined in src/components/light-component.ts:163
set color(value: Color): void
Sets the color of the light.
Parameters
- value: Color
  The color.
Returns void
- Defined in src/components/light-component.ts:152

component

get component(): LightComponent
Gets the underlying PlayCanvas light component.

Returns LightComponent
The light component.
Overrides ComponentElement.component
- Defined in src/components/light-component.ts:125

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:241
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:230

innerConeAngle

get innerConeAngle(): number
Gets the inner cone angle of the light.

Returns number
The inner cone angle.
- Defined in src/components/light-component.ts:182
set innerConeAngle(value: number): void
Sets the inner cone angle of the light.
Parameters
- value: number
  The inner cone angle.
Returns void
- Defined in src/components/light-component.ts:171

intensity

get intensity(): number
Gets the intensity of the light.

Returns number
The intensity.
- Defined in src/components/light-component.ts:201
set intensity(value: number): void
Sets the intensity of the light.
Parameters
- value: number
  The intensity.
Returns void
- Defined in src/components/light-component.ts:190

normalOffsetBias

get normalOffsetBias(): number
Gets the normal offset bias of the light.

Returns number
The normal offset bias.
- Defined in src/components/light-component.ts:220
set normalOffsetBias(value: number): void
Sets the normal offset bias of the light.
Parameters
- value: number
  The normal offset bias.
Returns void
- Defined in src/components/light-component.ts:209

outerConeAngle

get outerConeAngle(): number
Gets the outer cone angle of the light.

Returns number
The outer cone angle.
- Defined in src/components/light-component.ts:239
set outerConeAngle(value: number): void
Sets the outer cone angle of the light.
Parameters
- value: number
  The outer cone angle.
Returns void
- Defined in src/components/light-component.ts:228

penumbraFalloff

get penumbraFalloff(): number
Gets the penumbra falloff of the light.

Returns number
The penumbra falloff.
- Defined in src/components/light-component.ts:470
set penumbraFalloff(value: number): void
Sets the penumbra falloff of the light. Used for PCSS shadows.
Parameters
- value: number
  The penumbra falloff.
Returns void
- Defined in src/components/light-component.ts:459

penumbraSize

get penumbraSize(): number
Gets the penumbra size of the light.

Returns number
The penumbra size.
- Defined in src/components/light-component.ts:451
set penumbraSize(value: number): void
Sets the penumbra size of the light. Used for PCSS shadows.
Parameters
- value: number
  The penumbra size.
Returns void
- Defined in src/components/light-component.ts:440

range

get range(): number
Gets the range of the light.

Returns number
The range.
- Defined in src/components/light-component.ts:258
set range(value: number): void
Sets the range of the light.
Parameters
- value: number
  The range.
Returns void
- Defined in src/components/light-component.ts:247

shadowBias

get shadowBias(): number
Gets the shadow bias of the light.

Returns number
The shadow bias.
- Defined in src/components/light-component.ts:277
set shadowBias(value: number): void
Sets the shadow bias of the light.
Parameters
- value: number
  The shadow bias.
Returns void
- Defined in src/components/light-component.ts:266

shadowBlockerSamples

get shadowBlockerSamples(): number
Gets the number of shadow blocker samples.

Returns number
The number of shadow blocker samples.
- Defined in src/components/light-component.ts:508
set shadowBlockerSamples(value: number): void
Sets the number of shadow blocker samples. Used for PCSS shadows.
Parameters
- value: number
  The number of shadow blocker samples.
Returns void
- Defined in src/components/light-component.ts:497

shadowDistance

get shadowDistance(): number
Gets the shadow distance of the light.

Returns number
The shadow distance.
- Defined in src/components/light-component.ts:296
set shadowDistance(value: number): void
Sets the shadow distance of the light.
Parameters
- value: number
  The shadow distance.
Returns void
- Defined in src/components/light-component.ts:285

shadowIntensity

get shadowIntensity(): number
Gets the shadow intensity of the light.

Returns number
The shadow intensity.
- Defined in src/components/light-component.ts:315
set shadowIntensity(value: number): void
Sets the shadow intensity of the light.
Parameters
- value: number
  The shadow intensity.
Returns void
- Defined in src/components/light-component.ts:304

shadowResolution

get shadowResolution(): number
Gets the shadow resolution of the light.

Returns number
The shadow resolution.
- Defined in src/components/light-component.ts:334
set shadowResolution(value: number): void
Sets the shadow resolution of the light.
Parameters
- value: number
  The shadow resolution.
Returns void
- Defined in src/components/light-component.ts:323

shadowSamples

get shadowSamples(): number
Gets the number of shadow samples.

Returns number
The number of shadow samples.
- Defined in src/components/light-component.ts:489
set shadowSamples(value: number): void
Sets the number of shadow samples. Used for PCSS shadows.
Parameters
- value: number
  The number of shadow samples.
Returns void
- Defined in src/components/light-component.ts:478

shadowType

get shadowType(): | "pcf1-16f"
| "pcf1-32f"
| "pcf3-16f"
| "pcf3-32f"
| "pcf5-16f"
| "pcf5-32f"
| "vsm-16f"
| "vsm-32f"
| "pcss-32f"
Gets the shadow type of the light.

Returns
    | "pcf1-16f"
    | "pcf1-32f"
    | "pcf3-16f"
    | "pcf3-32f"
    | "pcf5-16f"
    | "pcf5-32f"
    | "vsm-16f"
    | "vsm-32f"
    | "pcss-32f"
The shadow type.
- Defined in src/components/light-component.ts:374
set shadowType(
    value:
        | "pcf1-16f"
        | "pcf1-32f"
        | "pcf3-16f"
        | "pcf3-32f"
        | "pcf5-16f"
        | "pcf5-32f"
        | "vsm-16f"
        | "vsm-32f"
        | "pcss-32f",
): void
Sets the shadow type of the light.
Parameters
- value:
      | "pcf1-16f"
      | "pcf1-32f"
      | "pcf3-16f"
      | "pcf3-32f"
      | "pcf5-16f"
      | "pcf5-32f"
      | "vsm-16f"
      | "vsm-32f"
      | "pcss-32f"
  The shadow type. Can be:
  
  pcf1-16f - 1-tap percentage-closer filtered shadow map with 16-bit depth.
  
  pcf1-32f - 1-tap percentage-closer filtered shadow map with 32-bit depth.
  
  pcf3-16f - 3-tap percentage-closer filtered shadow map with 16-bit depth.
  
  pcf3-32f - 3-tap percentage-closer filtered shadow map with 32-bit depth.
  
  pcf5-16f - 5-tap percentage-closer filtered shadow map with 16-bit depth.
  
  pcf5-32f - 5-tap percentage-closer filtered shadow map with 32-bit depth.
  
  vsm-16f - Variance shadow map with 16-bit depth.
  
  vsm-32f - Variance shadow map with 32-bit depth.
  
  pcss-32f - Percentage-closer soft shadow with 32-bit depth.
Returns void
- Defined in src/components/light-component.ts:352

type

get type(): "directional" | "omni" | "spot"
Gets the type of the light.

Returns "directional" | "omni" | "spot"
The type.
- Defined in src/components/light-component.ts:394
set type(value: "directional" | "omni" | "spot"): void
Sets the type of the light. Can be directional, omni or spot. Defaults to directional.
Parameters
- value: "directional" | "omni" | "spot"
  The type.
Returns void
- Defined in src/components/light-component.ts:383

vsmBias

get vsmBias(): number
Gets the VSM bias of the light.

Returns number
The VSM bias.
- Defined in src/components/light-component.ts:413
set vsmBias(value: number): void
Sets the VSM bias of the light.
Parameters
- value: number
  The VSM bias.
Returns void
- Defined in src/components/light-component.ts:402

vsmBlurSize

get vsmBlurSize(): number
Gets the VSM blur size of the light.

Returns number
The VSM blur size.
- Defined in src/components/light-component.ts:432
set vsmBlurSize(value: number): void
Sets the VSM blur size of the light. Minimum is 1, maximum is 25. Default is 11.
Parameters
- value: number
  The VSM blur size.
Returns void
- Defined in src/components/light-component.ts:421

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready. Resolves the ready promise and dispatches a bubbling, composed ready event. Signals at most once per readiness cycle: a repeat call before _resetReady has re-armed the promise does nothing.

Returns void
Inherited from ComponentElement._onReady
- Defined in src/async-element.ts:51

`Protected`_resetReady

_resetReady(): void
Returns the ready promise to its pending state. Subclasses should call this when the resource their readiness announced is torn down (typically from disconnectedCallback), so that a later re-initialization can signal readiness again. Does nothing while the promise is still pending — an in-flight waiter carries over to the next readiness cycle rather than being stranded on a promise nothing will ever resolve.

Returns void
Inherited from ComponentElement._resetReady
- Defined in src/async-element.ts:65

`Protected`getInitialComponentData

getInitialComponentData(): {
    castShadows: boolean;
    color: Color;
    innerConeAngle: number;
    intensity: number;
    normalOffsetBias: number;
    outerConeAngle: number;
    penumbraFalloff: number;
    penumbraSize: number;
    range: number;
    shadowBias: number;
    shadowBlockerSamples: number;
    shadowDistance: number;
    shadowIntensity: number;
    shadowResolution: number;
    shadowSamples: number;
    shadowType: number
    | undefined;
    type: "directional" | "omni" | "spot";
    vsmBias: number;
    vsmBlurSize: number;
}
Returns the data the component is created with. Overridden by subclasses to supply the initial values of their cached properties.

Returns {
    castShadows: boolean;
    color: Color;
    innerConeAngle: number;
    intensity: number;
    normalOffsetBias: number;
    outerConeAngle: number;
    penumbraFalloff: number;
    penumbraSize: number;
    range: number;
    shadowBias: number;
    shadowBlockerSamples: number;
    shadowDistance: number;
    shadowIntensity: number;
    shadowResolution: number;
    shadowSamples: number;
    shadowType: number | undefined;
    type: "directional" | "omni" | "spot";
    vsmBias: number;
    vsmBlurSize: number;
}
The initial component data.
Overrides ComponentElement.getInitialComponentData
- Defined in src/components/light-component.ts:97

`Protected`initComponent

initComponent(): void
Configures the newly added component. Overridden by subclasses whose setup goes beyond the initial data — child-element handling, asset resolution and the like.

Returns void
Inherited from ComponentElement.initComponent
- Defined in src/components/component.ts:167

ready

ready(): Promise<LightComponentElement>
Returns a promise that resolves with this element when it's ready. This is the low-level primitive underlying whenReady, which is the recommended way to wait for elements.

Readiness tracks the element's current lifecycle: once a ready element is torn down (for example by removing it from the document), this returns a fresh promise that resolves when the element is next ready. A promise obtained earlier stays resolved — call this again after re-inserting an element rather than reusing a promise from before its removal.

Returns Promise<LightComponentElement>
A promise that resolves with this element when it's ready.
Inherited from ComponentElement.ready
- Defined in src/async-element.ts:83

Class LightComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

castShadows

Returns boolean

Parameters

Returns void

closestApp

Returns AppElement | null

closestEntity

Returns EntityBaseElement | null

color

Returns Color

Parameters

Returns void

component

Returns LightComponent

enabled

Returns boolean

Parameters

Returns void

innerConeAngle

Returns number

Parameters

Returns void

intensity

Returns number

Parameters

Returns void

normalOffsetBias

Returns number

Parameters

Returns void

outerConeAngle

Returns number

Parameters

Returns void

penumbraFalloff

Returns number

Parameters

Returns void

penumbraSize

Returns number

Parameters

Returns void

range

Returns number

Parameters

Returns void

shadowBias

Returns number

Parameters

Returns void

shadowBlockerSamples

Returns number

Parameters

Returns void

shadowDistance

Returns number

Parameters

Returns void

shadowIntensity

Returns number

Parameters

Returns void

shadowResolution

Returns number

Parameters

Returns void

shadowSamples

Returns number

Parameters

Returns void

shadowType

Returns | "pcf1-16f" | "pcf1-32f" | "pcf3-16f" | "pcf3-32f" | "pcf5-16f" | "pcf5-32f" | "vsm-16f" | "vsm-32f" | "pcss-32f"

Parameters

Returns void

Returns
| "pcf1-16f"
| "pcf1-32f"
| "pcf3-16f"
| "pcf3-32f"
| "pcf5-16f"
| "pcf5-32f"
| "vsm-16f"
| "vsm-32f"
| "pcss-32f"

`Protected`_onReady

`Protected`_resetReady

`Protected`getInitialComponentData

`Protected`initComponent