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

Function getDocumentContextOptions

  • getDocumentContextOptions(
        application: ApplicationV2<
            ApplicationConfiguration,
            ApplicationRenderOptions,
        >,
        menuItems: ContextMenuEntry[],
    ): void

    A hook event that fires when a context menu related to a certain Document type is being prepared. Substitute "Document" in the hook name to target a specific document class, for example getActorContextOptions.

    Parameters

    • application: ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>

      The Application instance that the context menu is constructed within

    • menuItems: ContextMenuEntry[]

      An array of prepared menu items which should be mutated by the hook

    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.