Rolls Tracker - reonZ/pf2e-toolbelt GitHub Wiki

This feature tracks rolls in your world and offers an interface to see their statistics. To access its interface, click on the new button added to the controls UI on the left side of your screen.

Note

You can select more than one user/actor using the [Shift] key.

Important

The module won't record anything when a single user is logged in unless you enable the debug mode CONFIG.debug.modules = true

Filters

The feature offers a set of filters to see statistics based on roll types or time.

Type Filters

  • All Checks: display all check types.
  • Attack Rolls: display the attack checks.
  • Attack Outcomes: display attack checks by degree of success outcome.
  • Save Checks: display the save checks.
  • Save Outcomes: display save checks by degree of success outcome.
  • Skill Checks: display the skill checks.
  • Skills (First Half): display skill checks by skill slugs.
  • Skills (Second Half): display skill checks by skill slugs.
  • Perception Checks: display the perception checks.
  • initiative Checks: display the initiative checks.
  • Flat-Checks: display the flat-checks.

Time Filters

  • All Time: No time filter is used.
  • Time Range: Allow you to set a range from beginning of day to end of day.
  • Session: See rolls from a specific session.
  • Encounter: See rolls from a specific encounter.

Encounter

When an ecounter begins, it is automatically registered by the module. You can then access the data recorded while the encounter was taking place.

Session

A session can be created by the GM to group data in a set time span. Players will not see any new roll record as long as a session is running, everything will be updated as soon as the session ends.

Pause

The GM can pause/resume the recording of rolls in your world at any time.

Clear

The GM can clear records of rolls, encounters and sessions older than end of day of the provided date from your world.

Settings

Enabled 🌎 🔃

Enables the feature in your world.

API

/*
 * retrieves the api object for this feature
 */
game.modules.get("pf2e-toolbelt")?.api.rollsTracker;
/*
 * Starts a new session, you are not required to end the last session
 */
startSession: () => Promise<void>
/*
 * Ends the current session if any
 */
endSession: () => Promise<void>
/*
 * Pause/resume/toggle the recording of rolls in your world
 * Sessions and encounters will still be registered while paused
 */
togglePause: (paused?: boolean) => Promise<void>
/*
 * Clear rolls, sessions and encounters from your world
 * Everything older than 'days' will be removed if provided
 * If no 'days' argument, a popup will ask you to provide a date
 */
deleteRecords: (days?: number) => Promise<void>
⚠️ **GitHub.com Fallback** ⚠️