JournalEntry

JournalEntry

The JournalEntry class

Constructor

new JournalEntry()

Source:

Members

(static) config

Source:

Configure the attributes of the JournalEntry Entity

sceneNote :Note

Source:

Return a reference to the Note instance for this JournalEntry in the current Scene, if any

Type:

visible

Source:

A boolean indicator for whether or not the JournalEntry is visible to the current user in the directory sidebar

Methods

_onUpdate()

Source:

panToNote()

Source:

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

(async) show(mode, force) → {Promise}

Source:

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.

Parameters:
Name Type Default Description
mode String text

Which JournalEntry mode to display? Default is text.

force Boolean false

Display the entry to all players regardless of normal permissions

Returns:

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

Type
Promise