Class PointDarknessSource

A specialized subclass of the BaseLightSource which renders a source of darkness as a point-based effect.

Mixes

PointEffectSource

Hierarchy (View Summary)

BaseLightSource<this>
- PointDarknessSource

Index

Constructors

constructor

Accessors

active attached background coloration darkness effectsCollection elevation hasActiveLayer illumination isAnimated isPreview level requiresEdges suppressed updateId x y _layers ANIMATIONS

Constructors

constructor

new PointDarknessSource(options?: BaseEffectSourceOptions): PointDarknessSource
An effect source is constructed by providing configuration options.
Parameters
- Optionaloptions: BaseEffectSourceOptions = {}
  Options which modify the base effect source instance
Returns PointDarknessSource
Inherited from BaseLightSource.constructor

Properties

animation

animation: RenderedEffectSourceAnimationConfig = {}

The animation configuration applied to this source

colorRGB

colorRGB: [r: number, g: number, b: number] | null = null

The color of the source as an RGB vector.

data

data: any = ...

The data of this source.

layers

layers: {
    background: RenderedEffectSourceLayer;
    coloration: RenderedEffectSourceLayer;
    illumination: RenderedEffectSourceLayer;
} = ...

Track the status of rendering layers

object

object: object | null

Some other object which is responsible for this source.

ratio

ratio: number = 1

A ratio of dim:bright as part of the source radius

shape

shape: Polygon

The geometric shape of the effect source which is generated later.

`Readonly`sourceId

sourceId: string

The source id linked to this effect source.

suppression

suppression: Record<string, boolean> = {}

Records of suppression strings with a boolean value. If any of this record is true, the source is suppressed.

`Protected`_flags

_flags: Record<string, number | boolean> = {}

A collection of boolean flags which control rendering and refresh behavior for the source.

`Protected`_geometry

_geometry: Geometry | null = null

PIXI Geometry generated to draw meshes.

`Protected`_padding

_padding: number = ...

Padding applied on the darkness source shape for visual appearance only. Note: for now, padding is increased radius. It might evolve in a future release.

`Protected`_visualShape

_visualShape: SourceShape

The optional geometric shape is solely utilized for visual representation regarding darkness sources. Used only when an additional radius is added for visuals.

`Static`_brightLightingLevel

_brightLightingLevel: -2 = LIGHTING_LEVELS.DARKNESS

`Static`_dimLightingLevel

_dimLightingLevel: -1 = LIGHTING_LEVELS.HALFDARK

`Static`_initializeShaderKeys

_initializeShaderKeys: string[] = ...

`Static`_refreshUniformsKeys

_refreshUniformsKeys: string[] = ...

`Static`defaultData

defaultData: {
    alpha: number;
    animation: {};
    attenuation: number;
    bright: number;
    color: null;
    coloration: number;
    contrast: number;
    dim: number;
    disabled: boolean;
    elevation: number;
    level: string;
    luminosity: number;
    preview: boolean;
    saturation: number;
    seed: null;
    shadows: number;
    vision: boolean;
    x: number;
    y: number;
} = ...

Effect source default data.

Type Declaration

alpha: number
animation: {}
attenuation: number
bright: number
color: null
coloration: number
contrast: number
dim: number
disabled: boolean
Whether or not the source is disabled
elevation: number
The elevation of the point source
level: string
The ID of the Level the point source is in
luminosity: number
preview: boolean
saturation: number
seed: null
shadows: number
vision: boolean
x: number
The x-coordinate of the source location
y: number
The y-coordinate of the source location

`Static`EDGE_OFFSET

EDGE_OFFSET: number = -8

The offset in pixels applied to create soft edges.

`Static`effectsCollection

effectsCollection: string = "darknessSources"

`Static`sourceType

sourceType: string = "darkness"

Accessors

active

get active(): boolean
Is this source currently active? A source is active if it is attached to an effect collection and is not disabled or suppressed.

Returns boolean
Inherited from PointEffectSourceMixin(BaseLightSource).active

attached

get attached(): boolean
Is this source attached to an effect collection?

Returns boolean
Inherited from PointEffectSourceMixin(BaseLightSource).attached

background

get background(): PointSourceMesh
A convenience accessor to the background layer mesh.

Returns PointSourceMesh
Inherited from RenderedEffectSource.background

coloration

get coloration(): PointSourceMesh
A convenience accessor to the coloration layer mesh.

Returns PointSourceMesh
Inherited from RenderedEffectSource.coloration

darkness

get darkness(): PointSourceMesh
A convenience accessor to the darkness layer mesh.

Returns PointSourceMesh

effectsCollection

get effectsCollection(): Collection<
string,
BaseEffectSource<BaseEffectSourceData, Polygon>,
>
The EffectsCanvasGroup collection linked to this effect source.

Returns Collection<string, BaseEffectSource<BaseEffectSourceData, Polygon>>
Inherited from PointEffectSourceMixin(BaseLightSource).effectsCollection

elevation

get elevation(): number
The elevation bound to this source.

Returns number
Inherited from PointEffectSourceMixin(BaseLightSource).elevation

hasActiveLayer

get hasActiveLayer(): boolean
Has the rendered source at least one active layer?

Returns boolean
Inherited from RenderedEffectSource.hasActiveLayer

illumination

get illumination(): PointSourceMesh
A convenience accessor to the illumination layer mesh.

Returns PointSourceMesh
Inherited from RenderedEffectSource.illumination

isAnimated

get isAnimated(): boolean
Is the rendered source animated?

Returns boolean
Inherited from RenderedEffectSource.isAnimated

isPreview

get isPreview(): boolean
Is this RenderedEffectSource a temporary preview?

Returns boolean
Inherited from RenderedEffectSource.isPreview

level

get level(): documents.Level
The level this source is in.

Returns documents.Level
Inherited from PointEffectSourceMixin(BaseLightSource).level

requiresEdges

get requiresEdges(): boolean
Returns boolean

suppressed

get suppressed(): boolean
Is this source temporarily suppressed?

Returns boolean
Inherited from PointEffectSourceMixin(BaseLightSource).suppressed

updateId

get updateId(): number
Returns the update ID associated with this source. The update ID is increased whenever the shape of the source changes.

Returns number
Inherited from PointEffectSourceMixin(BaseLightSource).updateId

x

get x(): number
The x-coordinate of the point source origin.

Returns number
Inherited from PointEffectSourceMixin(BaseLightSource).x

y

get y(): number
The y-coordinate of the point source origin.

Returns number
Inherited from PointEffectSourceMixin(BaseLightSource).y

`Static`_layers

get _layers(): {
    darkness: {
        blendMode: string;
        defaultShader: typeof AdaptiveDarknessShader;
    };
}
Returns {
    darkness: {
        blendMode: string;
        defaultShader: typeof AdaptiveDarknessShader;
    };
}

`Static`ANIMATIONS

get ANIMATIONS(): DarknessSourceAnimationConfig
Returns DarknessSourceAnimationConfig

Methods

_configure

_configure(changes: any): void
Parameters
- changes: any
Returns void
Inherited from BaseLightSource._configure

_createShapes

_createShapes(): void
Returns void
Overrides BaseLightSource._createShapes

_destroy

_destroy(): void
Returns void
Inherited from BaseLightSource._destroy

_drawMesh

_drawMesh(layerId: any): Mesh<MeshMaterial> | null
Create a Mesh for a certain rendered layer of this source.
Parameters
- layerId: any
  The layer key in layers to draw
Returns Mesh<MeshMaterial> | null
The drawn mesh for this layer, or null if no mesh is required

Overrides BaseLightSource._drawMesh

_getEdgeCreationOptions

_getEdgeCreationOptions(): {
    direction: 1;
    light: 20;
    object: object
    | null;
    priority: any;
    sight: 20;
    type: string;
}
Returns {
    direction: 1;
    light: 20;
    object: object | null;
    priority: any;
    sight: 20;
    type: string;
}

_getPolygonConfiguration

_getPolygonConfiguration(): any
Returns any
Inherit Doc

_initialize

_initialize(data: any): void
Parameters
- data: any
Returns void
Overrides BaseLightSource._initialize

_refresh

_refresh(): void
Returns void
Inherited from BaseLightSource._refresh

_updateBackgroundUniforms

_updateBackgroundUniforms(): void
Update shader uniforms used for the background layer.

Returns void
Inherited from BaseLightSource._updateBackgroundUniforms

_updateColorationUniforms

_updateColorationUniforms(): void
Update shader uniforms used for the coloration layer.

Returns void
Inherited from BaseLightSource._updateColorationUniforms

_updateCommonUniforms

_updateCommonUniforms(shader: any): void
Parameters
- shader: any
Returns void
Inherited from BaseLightSource._updateCommonUniforms

_updateGeometry

_updateGeometry(): void
Returns void
Overrides BaseLightSource._updateGeometry

_updateIlluminationUniforms

_updateIlluminationUniforms(): void
Update shader uniforms used for the illumination layer.

Returns void
Inherited from BaseLightSource._updateIlluminationUniforms

add

add(): void
Add this BaseEffectSource instance to the active collection.

Returns void
Inherited from BaseLightSource.add

animate

animate(dt: number): any
Animate the PointSource, if an animation is enabled and if it currently has rendered containers.
Parameters
- dt: number
  Delta time.
Returns any
Inherited from BaseLightSource.animate

animateFlickering

animateFlickering(
    dt: number,
    options?: {
        amplification?: number;
        intensity?: number;
        reverse?: boolean;
        speed?: number;
    },
): void
An animation with flickering ratio and light intensity
Parameters
- dt: number
  Delta time
- Optionaloptions: {
      amplification?: number;
      intensity?: number;
      reverse?: boolean;
      speed?: number;
  } = {}
  Additional options which modify the flame animation
  - Optionalamplification?: number
    Noise amplification (>1) or dampening (<1)
  - Optionalintensity?: number
    The animation intensity, from 1 to 10
  - Optionalreverse?: boolean
    Reverse the animation direction
  - Optionalspeed?: number
    The animation speed, from 0 to 10
Returns void
Inherited from BaseLightSource.animateFlickering

animatePulse

animatePulse(
dt: number,
options?: { intensity?: number; reverse?: boolean; speed?: number },
): void
A basic "pulse" animation which expands and contracts.
Parameters
- dt: number
  Delta time
- Optionaloptions: { intensity?: number; reverse?: boolean; speed?: number } = {}
  Additional options which modify the pulse animation
  - Optionalintensity?: number
    The animation intensity, from 1 to 10
  - Optionalreverse?: boolean
    Reverse the animation direction
  - Optionalspeed?: number
    The animation speed, from 0 to 10
Returns void
Inherited from BaseLightSource.animatePulse

animateSoundPulse

animateSoundPulse(
dt: number,
options?: { intensity?: number; reverse?: boolean; speed?: number },
): void
A sound-reactive animation that uses bass/mid/treble blending to control certain shader uniforms. "speed" is interpreted as how quickly we adapt to changes in audio. No time-based pulsing is used by default, but we incorporate dt into smoothing so that behavior is consistent across varying frame rates.
Parameters
- dt: number
  The delta time since the last frame, in milliseconds.
- Optionaloptions: { intensity?: number; reverse?: boolean; speed?: number } = {}
  Additional options for customizing the audio reaction.
  - Optionalintensity?: number
    A blend factor in [0..10] that transitions from bass (near 0) to treble (near 10) Mid frequencies dominate around intensity=5.
  - Optionalreverse?: boolean
    Whether to invert the final amplitude as 1 - amplitude.
  - Optionalspeed?: number
    A smoothing factor in [0..10], effectively updates/second.
Returns void
Inherited from BaseLightSource.animateSoundPulse

animateTime

animateTime(
dt: number,
options?: { intensity?: number; reverse?: boolean; speed?: number },
): void
Generic time-based animation used for Rendered Point Sources.
Parameters
- dt: number
  Delta time.
- Optionaloptions: { intensity?: number; reverse?: boolean; speed?: number } = {}
  Options which affect the time animation
  - Optionalintensity?: number
    The animation intensity, from 1 to 10
  - Optionalreverse?: boolean
    Reverse the animation direction
  - Optionalspeed?: number
    The animation speed, from 0 to 10
Returns void
Inherited from BaseLightSource.animateTime

animateTorch

animateTorch(
dt: number,
options?: { intensity?: number; reverse?: boolean; speed?: number },
): void
An animation with flickering ratio and light intensity.
Parameters
- dt: number
  Delta time
- Optionaloptions: { intensity?: number; reverse?: boolean; speed?: number } = {}
  Additional options which modify the flame animation
  - Optionalintensity?: number
    The animation intensity, from 1 to 10
  - Optionalreverse?: boolean
    Reverse the animation direction
  - Optionalspeed?: number
    The animation speed, from 0 to 10
Returns void
Inherited from BaseLightSource.animateTorch

destroy

destroy(): void
Steps that must be performed when the source is destroyed.

Returns void
Inherited from BaseLightSource.destroy

drawMeshes

drawMeshes(): Record<string, Mesh<MeshMaterial> | null>
Render the containers used to represent this light source within the LightingLayer

Returns Record<string, Mesh<MeshMaterial> | null>
Inherited from BaseLightSource.drawMeshes

initialize

initialize(data?: any, options?: { reset?: boolean }): PointDarknessSource
Initialize and configure the source using provided data.
Parameters
- data: any = {}
  Provided data for configuration
- options: { reset?: boolean } = {}
  Additional options which modify source initialization
  - Optionalreset?: boolean
    Should source data be reset to default values before applying changes?
Returns PointDarknessSource
The initialized source

Inherited from BaseLightSource.initialize

refresh

refresh(): void
Refresh the state and uniforms of the source. Only active sources are refreshed.

Returns void
Inherited from BaseLightSource.refresh

remove

remove(): void
Remove this BaseEffectSource instance from the active collection.

Returns void
Inherited from BaseLightSource.remove

testPoint

testPoint(point: any): boolean
Parameters
- point: any
Returns boolean
Overrides BaseLightSource.testPoint

`Protected`_configureLayer

_configureLayer(layer: object, layerId: string): void
Protected
Specific configuration for a layer.
Parameters
- layer: object
- layerId: string
Returns void
Inherited from BaseLightSource._configureLayer

`Protected`_configureShaders

_configureShaders(): Record<string, typeof AdaptiveLightingShader>
Protected
Configure which shaders are used for each rendered layer.

Returns Record<string, typeof AdaptiveLightingShader>
An object whose keys are layer identifiers and whose values are shader classes.

Inherited from BaseLightSource._configureShaders

`Protected`_initializeSoftEdges

_initializeSoftEdges(): void
Protected
Decide whether to render soft edges with a blur.

Returns void
Inherited from BaseLightSource._initializeSoftEdges

`Protected`_updateDarknessUniforms

_updateDarknessUniforms(): void
Protected
Update the uniforms of the shader on the darkness layer.

Returns void

`Static`getCorrectedColor

getCorrectedColor(
    level: LightingLevel,
    colorDim: Color,
    colorBright: Color,
    colorBackground?: Color,
): Color
Get corrected color according to level, dim color, bright color and background color.
Parameters
- level: LightingLevel
  The lighting level (one of CONST.LIGHTING_LEVELS)
- colorDim: Color
- colorBright: Color
- OptionalcolorBackground: Color
Returns Color
Inherited from BaseLightSource.getCorrectedColor

`Static`getCorrectedLevel

getCorrectedLevel(level: LightingLevel): number
Get corrected level according to level and active vision mode data.
Parameters
- level: LightingLevel
  The lighting level (one of CONST.LIGHTING_LEVELS)
Returns number
The corrected level.

Inherited from BaseLightSource.getCorrectedLevel

Class PointDarknessSource

Mixes

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PointDarknessSource

Properties

animation

colorRGB

data

layers

object

ratio

shape

ReadonlysourceId

suppression

Protected_flags

Protected_geometry

Protected_padding

Protected_visualShape

Static_brightLightingLevel

Static_dimLightingLevel

Static_initializeShaderKeys

Static_refreshUniformsKeys

StaticdefaultData

Type Declaration

alpha: number

animation: {}

attenuation: number

bright: number

color: null

coloration: number

contrast: number

dim: number

disabled: boolean

elevation: number

level: string

luminosity: number

preview: boolean

saturation: number

seed: null

shadows: number

vision: boolean

x: number

y: number

StaticEDGE_OFFSET

StaticeffectsCollection

StaticsourceType

Accessors

active

Returns boolean

attached

Returns boolean

background

Returns PointSourceMesh

coloration

Returns PointSourceMesh

darkness

Returns PointSourceMesh

effectsCollection

Returns Collection<string, BaseEffectSource<BaseEffectSourceData, Polygon>>

elevation

Returns number

hasActiveLayer

Returns boolean

illumination

Returns PointSourceMesh

isAnimated

Returns boolean

isPreview

Returns boolean

level

Returns documents.Level

requiresEdges

`Readonly`sourceId

`Protected`_flags

`Protected`_geometry

`Protected`_padding

`Protected`_visualShape

`Static`_brightLightingLevel

`Static`_dimLightingLevel

`Static`_initializeShaderKeys

`Static`_refreshUniformsKeys

`Static`defaultData

`Static`EDGE_OFFSET

`Static`effectsCollection

`Static`sourceType

`Static`_layers

Returns {
darkness: {
blendMode: string;
defaultShader: typeof AdaptiveDarknessShader;
};
}

`Static`ANIMATIONS

Returns {
direction: 1;
light: 20;
object: object | null;
priority: any;
sight: 20;
type: string;
}

`Optional`amplification?: number

`Optional`intensity?: number

`Optional`reverse?: boolean

`Optional`speed?: number

`Optional`intensity?: number

`Optional`reverse?: boolean

`Optional`speed?: number

`Optional`intensity?: number

`Optional`reverse?: boolean

`Optional`speed?: number