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

Function activateNote

  • activateNote(note: canvas.placeables.Note, options: object): void

    A hook event that fires whenever a map note is double-clicked. The hook provides the note placeable and the arguments passed to the associated foundry.applications.sheets.journal.JournalEntrySheet render call. Hooked functions may modify the render arguments or cancel the render by returning false.

    Parameters

    • note: canvas.placeables.Note

      The note that was activated.

    • options: object

      Options for rendering the associated foundry.applications.sheets.journal.JournalEntrySheet.

    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.