Documentation - v19.16.0-dev
    Preparing search index...

    Generates a navigation graph from the current 2.5D voxel projection and owns its result.

    Index

    Constructors

    Properties

    signals: { onChanged: ViewerSignal<(...args: any[]) => any> } = ...

    Signals emitted whenever generation state, result, error, or freshness changes.

    Accessors

    • get error(): string | null

      Message from the latest failed generation, or null otherwise.

      Returns string | null

    • get needsUpdate(): boolean

      Whether voxelization or flood fill changed after the current result was generated.

      Returns boolean

    • get result(): GeneratedNavigationMesh | null

      Latest compact worker result, or null before generation or after clearing it.

      Returns GeneratedNavigationMesh | null

    Methods

    • Cancels the active worker run and returns the controller to its idle state.

      Returns void

    • Cancels generation and removes the current result and active graph.

      Returns void

    • Disconnects signals and terminates the navigation-mesh worker.

      Returns void

    • Restores a previously generated result and graph without running the worker again.

      Parameters

      • result: GeneratedNavigationMesh | null

        Compact worker result to restore, or null to clear it.

      • graph: NavigationGraph | null

        Materialized graph associated with the result, or null to clear it.

      Returns void

    • Starts tracking flood-fill changes that can invalidate a generated graph.

      Returns void

    • Generates and activates a navigation graph from the current voxel and flood-fill results.

      Parameters

      Returns Promise<NavigationGraph>

      The generated and activated graph.