Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PerceptionManager

A helper class which manages the refresh workflow for perception layers on the canvas. This controls the logic which batches multiple requested updates to minimize the amount of work required. A singleton instance is available as canvas#perception.

see

{Canvas#perception}

Hierarchy

  • any
    • PerceptionManager

Index

Constructors

Methods

Properties

Constructors

constructor

Methods

applyRenderFlags

  • applyRenderFlags(): void
  • override

    Returns void

update

  • update(flags: any, v2?: boolean): void

  • Update perception manager flags which configure which behaviors occur on the next frame render.

    Parameters

    • flags: any

      Flag values (true) to assign where the keys belong to PerceptionManager.FLAGS

    • v2: boolean = true

    Returns void

initialize

  • initialize(): void

  • A helper function to perform an immediate initialization plus incremental refresh.

    Returns void

refresh

  • refresh(): void

  • A helper function to perform an incremental refresh only.

    Returns void

Properties

Static RENDER_FLAGS

RENDER_FLAGS: { initializeLighting: { propagate: string[] }; refreshLighting: { propagate: string[] }; refreshLightSources: {}; refreshVisionSources: {}; refreshPrimary: {}; initializeVision: { propagate: string[] }; refreshVision: { propagate: string[] }; initializeSounds: { propagate: string[] }; refreshSounds: {}; refreshTiles: { propagate: string[] }; soundFadeDuration: {}; identifyInteriorWalls: { propagate: string[] }; forceUpdateFog: { propagate: string[] } } = ...
override

Type declaration

  • initializeLighting: { propagate: string[] }
    • propagate: string[]
  • refreshLighting: { propagate: string[] }
    • propagate: string[]
  • refreshLightSources: {}
    • refreshVisionSources: {}
      • refreshPrimary: {}
        • initializeVision: { propagate: string[] }
          • propagate: string[]
        • refreshVision: { propagate: string[] }
          • propagate: string[]
        • initializeSounds: { propagate: string[] }
          • propagate: string[]
        • refreshSounds: {}
          • refreshTiles: { propagate: string[] }
            • propagate: string[]
          • soundFadeDuration: {}
            • identifyInteriorWalls: { propagate: string[] }
              • propagate: string[]
            • forceUpdateFog: { propagate: string[] }
              • propagate: string[]

            Static RENDER_FLAG_PRIORITY

            RENDER_FLAG_PRIORITY: string = "PERCEPTION"
            override

            Static COMPATIBILITY_MAPPING

            COMPATIBILITY_MAPPING: { lighting.initialize: string; lighting.refresh: string; sight.initialize: string; sight.refresh: string; sounds.initialize: string; sounds.refresh: string; sounds.fade: string; foreground.refresh: string } = ...

            A shim mapping which supports backwards compatibility for old-style (V9 and before) perception manager flags.

            Type declaration

            • lighting.initialize: string
            • lighting.refresh: string
            • sight.initialize: string
            • sight.refresh: string
            • sounds.initialize: string
            • sounds.refresh: string
            • sounds.fade: string
            • foreground.refresh: string