DarknessComponent

Controls the darkness veil drawn over a scene or room by the LightingSystem.

With width/height of Infinity (the default) the veil covers the whole screen. With finite dimensions the veil is a "room" rectangle in world pixels centered on the owning entity's position.

Hierarchy

• Component
  • DarknessComponent

Index

Constructors

• constructor

Properties

• color
• dependencies
• height
• intensity
• owner
• width

Methods

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

Constructors

constructor

• DarknessComponent(options?: DarknessComponentOptions): DarknessComponent

• Overrides Component.constructor

  Parameters

  • optionaloptions: DarknessComponentOptions

  Returns DarknessComponent

Properties

publiccolor

color: Color

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

publicheight

height: number

publicintensity

intensity: number

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

publicwidth

width: number

Methods

inheritedclone

• clone(): Component

• Inherited from Component.clone

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

  ---

  Returns Component

inheriteddeserialize

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

• Inherited from Component.deserialize

  Parameters

  • data: Record<string, any>

  Returns void

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