• Preparing search index...
  • The search index is not available
Foundry Virtual Tabletop - API Documentation - Version 13
  • Foundry Virtual Tabletop - API Documentation - Version 13
  • hookEvents
  • configureCanvasEnvironment

Function configureCanvasEnvironment

  • configureCanvasEnvironment(config: CanvasEnvironmentConfig): void

    A hook event that fires at the beginning of foundry.canvas.groups.EnvironmentCanvasGroup#initialize which allows the environment configuration to be altered by hook functions. The provided config param should be mutated to make any desired changes. A method subscribing to this hook may return false to prevent further configuration.

    Parameters

    • config: CanvasEnvironmentConfig

    Returns void

Settings

Member Visibility
Foundry Virtual Tabletop - API Documentation - Version 13
  • Loading...

Public API documentation for Foundry Virtual Tabletop version 13.346 Stable. © 2025 Foundry Gaming LLC. All Rights Reserved.