API: Adjust Exhaustion Config

[kgar]

#86 added custom exhaustion, which can be controlled from the config settings interface or Foundry API in the console, but it would also be nice to have a robust API function for setting exhaustion config that is resistant to any internal changes or data structure changed in TIdy settings.

This post is to discuss a structure for the API function(s) for setting exhaustion.

Use Cases / Ideas

• An exhaustion automation module sets up some effects and custom levels of exhaustion. After the user configures this automation, the module calls to the Tidy 5e API to make it match what the user selected in the automation module.

Draft of API Call

Exhaustion configuration is saved as config settings in the Tidy 5e module's config settings. So, each call to the API to adjust exhaustion will update the associated config setting. That means, it doesn't need to be called on init/ready each time, just when needed.

// Setting specific levels
game
  .modules
  .get('tidy5e-sheet')
  ?.api
  ?.configureExhaustion({ 
    type: 'specific', 
    levels: 3, 
    hints: [
      'You are tired', 
      'You are a bit more tired', 
      'YOU ARE DEAD 💀']});

// Setting to a numeric input
game
  .modules
  .get('tidy5e-sheet')
  ?.api
  ?.configureExhaustion({ 
    type: 'open'
  });

Questions

• Should we somehow delineate in the API when you're dealing with temp runtime state versus updating config settings and similarly hard

Documentation and Type Definitions

When the API comes together, I will be working on publishing type definitions as a standalone NPM/etc. package and providing generated API documentation on this repo.

Reference

https://discord.com/channels/732325252788387980/1116078321067892796/1179169966512156842

Wasp — Today at 3:20 PM
Neat! Will the exhaustion levels be adjustable with an API down the line?

[kgar]

Someone on the Tidy discord suggested that exhaustion automation modules could do things like update the level count and tooltips based on choices made in exhaustion automation menus.
@fantasycalendar (... is this Wasp?), what kinds of uses will this API call get?