The vision mask which contains the current line-of-sight texture.

Hierarchy (view full)

Constructors

Properties

clearColor: number[] = ...
autoRender: boolean = false
vision: any

The current vision Container.

blurFilter: AlphaBlurFilter

The BlurFilter which applies to the vision mask texture. This filter applies a NORMAL blend mode to the container.

displayed: boolean = false

Should our Container also be displayed on screen, in addition to being drawn to the cached RenderTexture?

renderDirty: boolean = true

Does the Container need to be rendered? Set to false after the Container is rendered.

_renderPaths: Map<RenderTexture, {
    renderFunction: Function;
    clearColor: number[];
}> = ...

A map of render textures, linked to their render function and an optional RGBA clear color.

Type declaration

  • renderFunction: Function
  • clearColor: number[]
textureConfiguration: {
    scaleMode: any;
    format: any;
    multisample: any;
} = ...

Type declaration

  • scaleMode: any
  • format: any
  • multisample: any

Accessors

  • get sprite(): any
  • A PIXI.Sprite or SpriteMesh which is bound to this CachedContainer. The RenderTexture from this Container is associated with the Sprite which is automatically rendered.

    Returns any

  • get renderTexture(): RenderTexture
  • The primary render texture bound to this cached container.

    Returns RenderTexture

  • set alphaMode(mode): void
  • Set the alpha mode of the cached container render texture.

    Parameters

    • mode: ALPHA_MODES

    Returns void

Methods

  • Initialize the vision mask with the los and the fov graphics objects.

    Parameters

    • vision: Container

      The vision container to attach

    Returns any

  • Detach the vision mask from the cached container.

    Returns any

    The detached vision container.

  • Create a render texture, provide a render method and an optional clear color.

    Parameters

    • Optional options: {
          renderFunction: Function;
          clearColor: number[];
      } = {}

      Optional parameters.

      • renderFunction: Function

        Render function that will be called to render into the RT.

      • clearColor: number[]

        An optional clear color to clear the RT before rendering into it.

    Returns RenderTexture

    A reference to the created render texture.

  • Remove a previously created render texture.

    Parameters

    • renderTexture: RenderTexture

      The render texture to remove.

    • Optional destroy: boolean = true

      Should the render texture be destroyed?

    Returns void

  • Clear the cached container, removing its current contents.

    Parameters

    • Optional destroy: boolean = true

      Tell children that we should destroy texture as well.

    Returns CachedContainer

    A reference to the cleared container for chaining.

  • Parameters

    • renderer: any

    Returns void

    Inherit Doc

  • Protected

    Custom rendering for secondary render textures

    Parameters

    • renderer: Renderer

      The active canvas renderer.

    Returns void

  • Protected

    Bind a render texture to this renderer. Must be called after bindPrimaryBuffer and before bindInitialBuffer.

    Parameters

    • renderer: Renderer

      The active canvas renderer.

    • tex: RenderTexture

      The texture to bind.

    • Optional clearColor: number[]

      A custom clear color.

    Returns void

  • Resize a render texture passed as a parameter with the renderer.

    Parameters

    • renderer: Renderer

      The active canvas renderer.

    • rt: RenderTexture

      The render texture to resize.

    Returns void