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

Function getHeaderControlsApplicationV2

  • getHeaderControlsApplicationV2(
        application: ApplicationV2<
            ApplicationConfiguration,
            ApplicationRenderOptions,
        >,
        controls: ApplicationHeaderControlsEntry[],
    ): void

    A hook event that fires whenever this ApplicationV2 is rendered to add controls to its header. Substitute the "ApplicationV2" in the hook event to target a specific ApplicationV2 type, for example "renderMyApplication". Each Application class in the inheritance chain will also fire this hook, i.e. "getHeaderControlsApplicationV2" will also fire.

    Parameters

    • application: ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>

      The Application instance being rendered

    • controls: ApplicationHeaderControlsEntry[]

      The array of header control menu options

    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.