Under the Hood – Enhancing the Exhaustion Condition

Compatibility warning

This article was published for an older version of Foundry VTT and does not work for Foundry versions greater than 0.8.x.

Under the Hood is a new series that focuses on technical aspects in Foundry VTT and its modules to teach and show a new trick or two. The first article of this series is from Malakan and explains how you can use automate the Exhaustion Condition in the Dungeon and Dragons 5e system using Combat Utility Belt (CUB) in conjunction with a few more modules (see Required Modules).

Provided with CUB is a prebuilt conditions mapping for DND5e that uses status icons for Exhaustion levels 1-5. As seen in the image, the token can easily become cluttered with exhaustion icons. Each unique exhaustion level can be conveyed by the color of the icon, rendering multiple icons unnecessary.


In the image above you can see the macro in full effect. Once you change the exhaustion level a macro will execute and remove the any other Exhaustion Condition present on the target, but that is not all it will apply effects to the token like giving disadvantage to ability checks and others depending on the level of exhaustion. So in order to achieve this you have to follow these five steps:

  1. Within the CUBPuter settings of Combat Utility Belt you need to enable enhanced conditions.

  2. Head over to the Conditions Lab and import the pre-build dnd5e-extended.json.
    This file can be found within the CUB module under the folder conditions-map. This will overwrite the current mapping with a preset for the DND5e conditions. The default path looks like this:

    ~/FoundryVTT/foundrydata/Data/modules/combat-utility-belt/condition-maps

    If you are not sure where to find this folder on your system, please go to the Application Configuration article on the Foundry VTT main site.

  3. After you have loaded the preset navigate to the different Exhaustion Conditions. Next to each of them you can find the Active Effect Config button. Click it and navigate to the Effects tab.


  4. For each exhaustion level you need to add the effects listed in the table below. Remember each exhaustion level must include the previous levels’ condition effects, e.g. Exhaustion 2 must also include the disadvantage for ability checks from Exhaustion 1. As another example you can look at the image of Exhaustion 5 at the end of the article where you can see that it includes all the attribute keys of the previous exhaustion levels.

    Make sure to save the conditions mapping at the end of this step and in between the addition of each effect.

    Note: Later we will be making a macro called CUB-Exhausted, if you decide to use a different name for it, please make sure that the name matches the inputs in this step.

  5. Lastly create a new script type macro and check that it is run as GM. Make sure the name you have used in the Conditions Lab matches the name of the macro (case sensitive), in this case CUB-Exhausted.
Status EffectAttribute KeyChange ModeEffect Value
Exhaustion 1flags.midi-qol.disadvantage.ability.check.allOverride1
macro.executeCustomCUB-Exhausted
Exhaustion 2data.attributes.movement.walkMultiply0.5
data.attributes.movement.swimMultiply0.5
data.attributes.movement.burrowMultiply0.5
data.attributes.movement.flyMultiply0.5
Exhaustion 3flags.midi-qol.disadvantage.attack.allOverride1
flags.midi-qol.disadvantage.ability.save.allOverride1
Exhaustion 4data.attributes.hp.maxMultiply0.5
Exhaustion 5data.attributes.movement.walkOverride0
data.attributes.movement.swimOverride0
data.attributes.movement.burrowOverride0
data.attributes.movement.flyOverride0
Breakdown of the new effects bestowed upon each Exhaustion level

With the macro in place, you can now click on your current exhaustion level and it will auto remove other exhaustion states so that only one exhaustion icon appears at a time with the associated effects. Although this modification will achieve only a small effect in your game, it helps show some of the customization possible in Foundry VTT.

// CUB-Exhausted macro if (args[0] == "on") { var exNew = args[1].efData.label const levels = ["Exhaustion 1","Exhaustion 2","Exhaustion 3","Exhaustion 4","Exhaustion 5"] for(const ex of levels){ if ((ex != exNew) && (game.cub.hasCondition(ex))){ await game.cub.removeCondition(ex) } } }
Code language: JavaScript (javascript)

Special thanks to Kandashi and Crymic on the Foundry VTT discord for their help with the macro, and to Mr. Weaver for their YouTube guide that provided the Active Effect configurations.

Share This Post
Subscribe
Notify of
8 Comments
Inline Feedbacks
View all comments
thewintrywyvern
6 months ago

This is great! Might I ask, how do you lengthen the conditions menu horizontally? it looks great :O

Blakintime
6 months ago

Hmm I followed all of these instructions, have all of those modules set, and yet it doesn’t seem to work for me. The conditions still stack.

Macro is set, executing as DM, all of the condition effects are in place. Yet when I drag an actor in the scene and apply the conditions one after the other its the typical stacking behavior. No in-game errors thrown, but I am getting the following in the console:

foundry.js:44970 Uncaught (in promise) TypeError: Cannot read property ‘icon’ of undefined
at Token.toggleEffect (foundry.js:44970)
at Token._updateHealthOverlay (main.js:180)
at main.js:189
at Function._call (foundry.js:2496)
at Function.callAll (foundry.js:2456)
at Function._handleUpdateEmbeddedEntity (foundry.js:30047)
at Function._handleUpdateEmbeddedEntity (foundry.js:34301)
at Scene.updateEmbeddedEntity (foundry.js:30015)
at async Token.update (foundry.js:11475)
at async Token.toggleEffect (foundry.js:44983)

JDW
Admin
JDW
6 months ago
Reply to  Malakan

You can send a private message from the user profile, yes.

Joe
Joe
5 months ago

You should add an image of the import icon, it took me…too long to realize. I’m sure others will forget as well.

sdenec
1 month ago

Just to let you know: This still works in 0.8.8

rocuonji
1 month ago

This is very helpful, thanks! Quick question, how do you make your status icons show up vertically in the tokens? It looks cleaner.

8
0
Would love your thoughts, please comment.x
()
x