Options
All
  • Public
  • Public/Protected
  • All
Menu

The client-side JournalEntry document which extends the common BaseJournalEntry model.

mixes

ClientDocumentMixin

see

Journal The world-level collection of JournalEntry documents

see

JournalSheet The JournalEntry configuration application

Hierarchy

  • any
    • JournalEntry

Index

Constructors

  • Returns JournalEntry

Accessors

  • get visible(): boolean
  • A boolean indicator for whether the JournalEntry is visible to the current user in the directory sidebar

    Returns boolean

  • get sceneNote(): Note
  • Return a reference to the Note instance for this Journal Entry in the current Scene, if any. If multiple notes are placed for this Journal Entry, only the first will be returned.

    Returns Note

Methods

  • Show the JournalEntry to connected players. By default, the entry will only be shown to players who have permission to observe it. If the parameter force is passed, the entry will be shown to all players regardless of normal permission.

    alias

    Journal.show

    Parameters

    • force: boolean = false

    Returns Promise<JournalEntry>

    A Promise that resolves back to the shown entry once the request is processed

  • panToNote(options?: { scale: number; duration: number }): Promise<void>
  • If the JournalEntry has a pinned note on the canvas, this method will animate to that note The note will also be highlighted as if hovered upon by the mouse

    Parameters

    • options: { scale: number; duration: number } = {}
      • scale: number
      • duration: number

    Returns Promise<void>

    A Promise which resolves once the pan animation has concluded

  • _preCreate(data: any, options: any, user: any): Promise<any>
  • inheritdoc

    Parameters

    • data: any
    • options: any
    • user: any

    Returns Promise<any>

  • _preUpdate(changed: any, options: any, user: any): Promise<any>
  • inheritdoc

    Parameters

    • changed: any
    • options: any
    • user: any

    Returns Promise<any>

  • _onUpdate(data: any, options: any, userId: any): void
  • override

    Parameters

    • data: any
    • options: any
    • userId: any

    Returns void

  • _onDelete(options: any, userId: any): void
  • override

    Parameters

    • options: any
    • userId: any

    Returns void