Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FogExploration

The client-side FogExploration document which extends the common BaseFogExploration model.

mixes

ClientDocumentMixin

Hierarchy

  • any
    • FogExploration

Index

Constructors

Methods

Constructors

constructor

  • Returns FogExploration

Methods

explore

  • Explore fog of war for a new point source position.

    Parameters

    • source: PointSource

      The candidate source of exploration

    • force: boolean = false

    Returns boolean

    Is the source position newly explored?

getTexture

  • getTexture(): any

  • Transform the explored base64 data into a PIXI.Texture object

    Returns any

Static get

  • get([query]?: { scene: string; user: string }, options?: any): Promise<FogExploration>

  • Obtain the fog of war exploration progress for a specific Scene and User.

    Parameters

    • [query]: { scene: string; user: string } = {}

      Parameters for which FogExploration document is retrieved

      • scene: string
      • user: string
    • options: any = {}

    Returns Promise<FogExploration>