LightOccluderComponent

Marks an entity as a light-blocking obstacle that projects dynamic shadows in the LightingSystem.

Box shapes are centered on the transform origin by default (anchor: Vector.Half, matching Shape.Box). Polygon and circle shapes are positioned by their own vertex/center coordinates, same as Shape.Polygon and Shape.Circle — offset shifts any shape further from the transform origin in local space.

Hierarchy

• Component
  • LightOccluderComponent

Index

Constructors

• constructor

Properties

• castShadows
• dependencies
• owner

Accessors

• offset
• shape

Methods

• clone
• deserialize
• localVertices
• onAdd
• onRemove
• serialize
• toJSON

Constructors

constructor

• LightOccluderComponent(options: LightOccluderComponentOptions): LightOccluderComponent

• Overrides Component.constructor

  Parameters

  • options: LightOccluderComponentOptions

  Returns LightOccluderComponent

Properties

publiccastShadows

castShadows: boolean

optionalreadonlyinheriteddependencies

dependencies?: ComponentCtor<Component>[]

Inherited from Component.dependencies

Optionally list any component types this component depends on If the owner entity does not have these components, new components will be added to the entity

Only components with zero-arg constructors are supported as automatic component dependencies

inheritedowner

owner: Entity<any> | null = null

Inherited from Component.owner

Current owning Entity, if any, of this component. Null if not added to any Entity

Accessors

publicoffset

• get offset(): Vector
• set offset(offset: Vector): void

• Returns Vector

• Parameters

  • offset: Vector

  Returns void

publicshape

• get shape(): OccluderShape
• set shape(shape: OccluderShape): void

• Returns OccluderShape

• Parameters

  • shape: OccluderShape

  Returns void

Methods

publicclone

• clone(): LightOccluderComponent

• Overrides Component.clone

  Clones any properties on this component, if that property value has a clone() method it will be called

  ---

  Returns LightOccluderComponent

inheriteddeserialize

• deserialize(data: Record<string, any>): void

• Inherited from Component.deserialize

  Parameters

  • data: Record<string, any>

  Returns void

publiclocalVertices

• localVertices(): Vector[]

• Evaluates the bounding shape vertices in local space, factoring in local offsets. Returns an empty array for circular primitives. Cached until shape or offset are reassigned.

  ---

  Returns Vector[]

optionalinheritedonAdd

• onAdd(owner: Entity): void

• Inherited from Component.onAdd

  Optional callback called when a component is added to an entity

  ---

  Parameters

  • owner: Entity

  Returns void

optionalinheritedonRemove

• onRemove(previousOwner: Entity): void

• Inherited from Component.onRemove

  Optional callback called when a component is removed from an entity

  ---

  Parameters

  • previousOwner: Entity

  Returns void

inheritedserialize

• serialize(): Record<string, any>

• Inherited from Component.serialize

  Returns Record<string, any>

inheritedtoJSON

• toJSON(pretty?: boolean): string

• Inherited from Component.toJSON

  Parameters

  • pretty: boolean = false

  Returns string