Class default

constructor

• new default(): default

  Returns default

Static_bmsDarknessChangeHandler

Static_bmsDeleteBehaviorHookId

Static_bmsDeleteRegionHookId

Static_bmsLightSource

Static_bmsUpdateHookId

Static_bmsUpdateRegionHookId

Staticevents

StaticLOCALIZATION_PREFIXES

Static_bmsCleanupSource

• _bmsCleanupSource(system: any): void

  Parameters

  • system: any

  Returns void

StaticdefineSchema

• defineSchema(): {
      alpha: any;
      animationIntensity: any;
      animationSpeed: any;
      animationType: any;
      color: any;
      darkness: any;
      luminosity: any;
      negative: any;
      walls: any;
  }

  Returns {
      alpha: any;
      animationIntensity: any;
      animationSpeed: any;
      animationType: any;
      color: any;
      darkness: any;
      luminosity: any;
      negative: any;
      walls: any;
  }

  • alpha: any

    Overall opacity of the coloration layer (0–1).

  • animationIntensity: any

  • animationSpeed: any

  • animationType: any

    Key into CONFIG.Canvas.lightAnimations, or "none".

  • color: any

    Hex color string for the emitted light.

  • darkness: any

    Scene darkness level activation range (mirrors core LightData.darkness). The light is active only when canvas.darknessLevel falls within [min, max].

  • luminosity: any

    1.0 = fully bright (darknessLevel → 0), 0.5 = dim (darknessLevel → 0.5), 0 = visual-only (no fog-of-war / vision illumination).

  • negative: any

    When true, use BmsRegionDarknessSource (negative polarity). When false, use BmsRegionLightSource (positive polarity).

  • walls: any

    When true, a ClockwiseSweepPolygon is cast from the region centroid so walls clip the lit area.

StaticmigrateData

• migrateData(source: any): any

  Convert legacy boolean darkness field to negative for backward compatibility.

  Parameters

  • source: any

  Returns any

StaticonBehaviorUnviewed

• onBehaviorUnviewed(this: default, event: any): Promise<void>

  Parameters

  • this: default
  • event: any

  Returns Promise<void>

StaticonBehaviorViewed

• onBehaviorViewed(this: default, event: any): Promise<void>

  Parameters

  • this: default
  • event: any

  Returns Promise<void>

StaticonGeometryChange

• onGeometryChange(this: default, event: any): Promise<void>

  Parameters

  • this: default
  • event: any

  Returns Promise<void>