Register

Variant Encumbrance + Midi

An Add-on Module for Foundry Virtual Tabletop

Author: 4535992 Project Source: Project URL Versions 11 - 12 (Verified 11) Last Updated 5 months ago

Variant Encumbrance

If you want to buy me a coffee alt-text

A visual modification to player character sheets to better display the effects of the Encumbrance variant ruleset in the PHB.

The effects of this module are currently purely visual, although restricting movement and applying the negative effects of encumbrance are applied with the new active effect mechanism.

For D&D5e 1.4.2 and newer the system supports a core implementation of this encumbrance rule. The module should be synchronized with the core functionality, but this module will permit more customised rules for your weight calculations/thresholds and the speed penalties are integrated with active effect.

tutorial

Installation

It's always easiest to install modules from the in game add-on browser.

To install this module manually:

  1. Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
  2. Click "Install Module"
  3. In the "Manifest URL" field, paste the following url:

https://raw.githubusercontent.com/p4535992/foundryvtt-variant-encumbrance-dnd5e/master/src/module.json

  1. Click 'Install' and wait for installation to complete
  2. Don't forget to enable the module in game using the "Manage Module" button

libWrapper

This module uses the libWrapper library for wrapping core methods. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

socketLib

This module uses the socketLib library for wrapping core methods. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

midi-qol

This module uses the midi-qol. It is a optional dependency but it is recommended for the best experience and compatibility with other modules.

NOTE: If "midiqol" is deactivated or not present, the active effects will apply only the speed reduction without the variations of advantage and disadvantage typical of the rule

 

Compatibility

Character Sheets Compatibility

Other Modules Compatibility

I highly recommend avoiding module Inventory + in favor of the module Item Collection/Item Containers

Hooks

From version 0.14.X you can add your own code for customize the item weight.

I will check on my side these keys on the options object:

NOTE: Is not a async function

NOTE: typeOfWeight indicate the type of weight used for standard weight the value is veweight for bulk is bulk

Hooks.on("variant-encumbrance-dnd5e.customizeItemWeight", (actor, item, itemWeight, typeOfWeight, options) => {
  if(typeOfWeight === "veweight") {
    let newWeight = // DO SOMETHING
    setProperty(options, `veweight`, newWeight); // NOTE : 'weight' value must be a number or it will be ignored
  }
  if(typeOfWeight === "bulk") {
    let newBulk = // DO SOMETHING
    setProperty(options, `bulk`, newBulk); // NOTE : 'bulk' value must be a number or it will be ignored
  }
});
 

Features

Redesigned weight bar

green orange red yellowblack

The default character weight bar has received a lick of paint, giving labels for all four weight thresholds. These thresholds are also reconfigurable in the settings, and will update the bar to display the new proportions.

Effect-based Speed Reduction with Active Effects

ae

ae2

Your encumbrance status is automatically used to provide a modified speed value, taking your default character speed and modifying it by -10 and -20 for encumbered and heavily encumbered, and reducing to 0 when over encumbered. (For 0.1.5, the speed value must be separated by a space from its units).

Character Size & Powerful Build (Optional)

Powerful Build Feature: You count as one size larger when determining your carrying capacity and the weight you can push, drag, or lift.

Enabled by default, the module will modify your maximum carry weight according to your character's size, and whether you have the powerful build special trait. This feature can be disabled in the module settings. (Credit to Eruestani for implementing this).

Item Weight Multipliers (Optional)

In the module settings, custom multipliers are available for unequipped, equipped, and proficiently equipped items. This was mainly added for my house rules, where equipped proficient items get a small weight reduction due to experience handling them, but this lends some flexibility to the system for anyone to use.

Buttons header sheet for enable/disable the features of Variant Encumbrance (Weight Calculation and Active Effects) actor by actor

Add new buttons on the header sheet of the actors for choose when to avoid to add the Active Effect or weight calculation. To much bad feed back on the automatization of the AE, i hope with this to help the community to find the best solution for the single individual

Symbol Button Header Sheet Description
weight-hanging-solid If you want to have the Varian Encumbrance Active Effects and Weight calculation features on your actor make sure to have the "weight" symbol on the header sheet (this is the default)
balance-scale-right-solid If you don't want to have the Varian Encumbrance Active Effects feature on your actor make sure to have the "balance" symbol on the header sheet. ATTENTION the weight calculation feature is still active
feather-solid If you don't want to have the Variant Encumbrance Active Effects and Weight calculation features on your actor make sure to have the "feather" symbol on the header sheet. The weight is not calculated anymore and remain frozen (unless the setting 'Use standard calculation weight of the dnd5e system' is set to true in that case the weight calculation rollback to the standard weight calculation of the system dnd5e)

Some preview:

img1

img2

img3

img4

img5

img6

NOTE: from 0.6.11 the button are colored !!!

Fake the metric system calculation, but we using the imperial one

This feature is enabled with the module setitng 'Fake the metric system calculation, but we using the imperial one'

Use this only with the system setting 'Use Metric Weight Units' checked. because that setting doesn't update the value in lbs. to kg. of the item so the calculation is 'visually wrong', with this setting set to true we use the same imperial encumbrance costants, and avoid the problem, but this is a patch not a solution, this is why there it was this module in the past https://github.com/HadaIonut/Foundry-mgl

The calculation should be correct, the metric values ​​2.5, 5, 7.5 are the official ones of the dnd5e system, the problem is that checking the metric system checkbox does not consequently update the item values ​​as we would expect 1lb = 0.45kg but remains 1lb = 1kg therefore an object that weighs 6lb will result in weighing 6kg and this gives the illusion of displacing the weight, the description clearly says so Replaces all reference to lbs with kgs and updates the encumbrance calculations to use metric weight units. where with reference we mean the label 'lbs' in 'kg' not the value .... this is done on purpose to avoid a massive update of the items, consequently it does not update the weight on the objects, you can also check with the module deactivated. However, I attach an image for clarity.

img

Integration with System Bulk based on the rules from Giffyglyph

An active inventory manages items using inventory slots (storage capacity) and object bulk (carrying effort).

Inventory slots

Inventory slots describe storage capacity—how much can a thing carry without being overwhelmed? One slot holds one small object—a potion bottle, a dagger, a loaf of bread, etc.

Anything that can hold, carry, or contain objects can make use of inventory slots—for example:

Your Inventory

Your inventory capacity depends on your creature size and strength modifier—the bigger and stronger you are, the more inventory slots you have.

As your size increases, so too does your bulk—a larger creature takes more effort to carry. Your bulk equals the larger of either a) your minimum bulk or b) the total bulk of everything in your inventory.

Creature Inventory

Creature Size Inventory Slots Minimum Bulk
Tiny 6 + STR 5
Small 14 + STR 10
Medium 18 + STR 20
Large 22 + [ STR x 2 ] 40
Huge 30 + [ STR x 4 ] 80
Gargantuan 46 + [ STR x 8 ] 160

Here we see three characters calculate their inventory:

More details about the calculation can be found here

Bulk

Objects use bulk to describe how many inventory slots they fill—the bulkier the object, the more slots occupied.

Bulk represents the effort needed by a medium-sized creature to carry an object based on its size, weight, and shape—the more awkward or uncomfortable it is to hold an object, the higher its bulk.

Automatic suggested bulk

By default when the Bulk feature is enabled a little label "Suggested Bulk" show up on the item sheet preview for give a suggestion for the convertion lb/g to bulk based on the below giffyglyph table:

Category Bulk Size Weight
Tiny 0.2 Tiny: Smaller than the palm of your hand. You can hold many of these in one hand. Negligible: A negligible or trivial weight.
Small 1 Short: Up to a handspan / 9 inches. Can be held comfortably with one hand. Light: Up to 2 lbs. The weight of a loaf of bread or a bag of sugar.
Medium 2 Medium: Up to an arms-length / 2 feet long. Can be held with one hand. Medium: Up to 5 lbs. About as heavy as a few big bags of sugar.
Large 3 Long: Longer than an arm. Usually can be held with one hand, but us most comfortable with two. Heavy: Up to 10 lbs. About as heavy as a cat or a sack of potatoes.
X-Large 6 Extra-long: Longer than the height of an average person. Requires two hands to hold. Extra-heavy: Up to 35 lbs. About a quarter of the weight of an average person.
XX-Large 9 Extensive: Longer than the height of two people. Requires two hands to hold. Leaden: Up to 70 lbs. About half as heavy as an average person.

Buttons header sheet for enable/disable the features of Bulk (Weight Bulk Calculation and Active Effects Bulk) actor by actor

Add new buttons on the header sheet of the actors for choose when to avoid to add the Active Effect or weight calculation. To much bad feed back on the automatization of the AE, i hope with this to help the community to find the best solution for the single individual

Symbol Button Header Sheet Description
bold-solid If you want to have the Varian Encumbrance Active Effects and Weight calculation features on your actor make sure to have the "bold" symbol on the header sheet (this is the default)
balance-scale-left-solid If you don't want to have the Varian Encumbrance Active Effects feature on your actor make sure to have the "balance" symbol on the header sheet. ATTENTION the weight calculation feature is still active
feather-alt-solid If you don't want to have the Variant Encumbrance Active Effects and Weight calculation features on your actor make sure to have the "feather" symbol on the header sheet. The weight is not calculated anymore and remain frozen (unless the setting 'Use standard calculation weight of the dnd5e system' is set to true in that case the weight calculation rollback to the standard weight calculation of the system dnd5e)

Homebrew rules from the community !!!

Feature: Do Not increase weight by quantity for no ammunition item: This is a homebrew rule, for non-ammunition items don't increase weight by quantity (so 5 potions = 1 item weight for example

Feature: Equipped Armor Weight Multiplier: This is a homebrew rule, for equipped Armor types, if the weight is set to -1 is not applied, this will override the setting from 'Equipped Item Weight Multiplier'NOTE: The specific armor calculation setting 'Feature: Equipped Armor Weight Multiplier for 'XXX Armor' will be override this setting ONLY IF THE VALUE IS EQUAL TO 0.

Feature: Equipped Armor Weight Multiplier for 'Clothing Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'clothing', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Armor Weight Multiplier for 'Light Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'light', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Armor Weight Multiplier for 'Medium Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'medium', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Armor Weight Multiplier for 'Heavy Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'heavy', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Armor Weight Multiplier for 'Natural Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'natural', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Container/Backpack Weight Multiplier: This is a homebrew rule, for equipped container/backpack types, if the weight is set to -1 is not applied, this will override the setting from 'Equipped Item Weight Multiplier'.

Feature: Use STR flat value instead STR MOD on Bulk: This is a homebrew rule, ONLY FOR BULK calculation. Currently there is no way to adjust the maximum bulk for a creature, which is tied to size and STR MOD, now you can use the flat value of force to handle it.

Variant Encumbrance Flag

Should you wish to integrate some of Variant Encumbrance's calculations into your own modules, there is now a flag which stores the actor's encumbrance tier, weight, and modified speed. Encumbrance tier is presented as 0, 1, 2, 3, as Unencumbered, Encumbered, Heavily Encumbered, Over Encumbered, respectively.

FLAGS ON ACTOR DOCUMENT

variant-encumbrance-dnd5e:
{
  burrow: 0,
  climb: 0,
  fly: 0,
  swim: 0,
  walk: 30,
  data: {
    totalWeight: 0,
    totalWeightToDisplay: 0,
    lightMax: 50,
    mediumMax: 100,
    heavyMax: 150,
    encumbranceTier: 0,
    speedDecrease: 0,
    unit: 'lbs',
    encumbrance: {
        value: 150,
        max: 100,
        pct: 200,
        encumbered: true,
    },
mapItemEncumbrance: { [index: string]: number }
}, bulk: { totalWeight: 0, totalWeightToDisplay: 0, lightMax: 50, mediumMax: 100, heavyMax: 150, encumbranceTier: 0, speedDecrease: 0, unit: 'bulk', encumbrance: { value: 150, max: 100, pct: 200, encumbered: true, },
mapItemEncumbrance: { [index: string]: number }, inventorySlot: 60, minimumBulk: 2   }, enabledae: true, enabledwe: true, enabledaebulk: false, enabledwebulk: true }

FLAGS ON ITEM DOCUMENT

variant-encumbrance-dnd5e:
{
  bulk: 0
}

Settings

Name Hint Default Value More Details
Use Variant Encumbrance with specific type of actor Use for example the following type of actors (e.g. character, npc, ecc. separate by character ','), remember is case sensitive. character,vehicle A list of actor type where the module is enabled, if empty is like disable the module
Fake the metric system calculation, but we using the imperial one Use this only with the system setting 'Use Metric Weight Units' checked. Because that setting doesn't update the value in lbs. to kg. of the item the calculation is 'visually wrong', with this setting set to true we use the same imperial encumbrance constants, and avoid the problem, but this is a patch not a solution, this is why there it was this module in the past https://github.com/HadaIonut/Foundry-mgl false THIS WILL MADE IGNORE THE FOLLOWING MODULE SETTINGS 'Unencumbered Strength Multiplier (Metric System)', 'Encumbered Strength Multiplier (Metric System)' and 'Heavily Encumbered (old Strength Multiplier) (Metric System)'
Unencumbered Strength Multiplier Multiplier used to calculate maximum carrying weight before being encumbered from the strength ability score. 5  
Unencumbered Strength Multiplier (Metric System) Multiplier used to calculate maximum carrying weight before being encumbered from the strength ability score (Metric System). 2.5  
Encumbered Strength Multiplier Multiplier used to calculate maximum carrying weight before being heavily encumbered from the strength ability score. 10  
Encumbered Strength Multiplier (Metric System) Multiplier used to calculate maximum carrying weight before being heavily encumbered from the strength ability score (Metric System). 5  
Heavily Encumbered (old Strength Multiplier) Multiplier used to calculate maximum carrying weight from the strength ability score. 15  
Heavily Encumbered (old Strength Multiplier) (Metric System) Multiplier used to calculate maximum carrying weight from the strength ability score (Metric System). 7.5  
Enable or disable the strength multiplier feature Enable or disable the strength multiplier feature. false I DON'T RECOMMENDED it, this will multiply the carriage value with CONFIG.DND5E.encumbrance.strMultiplier.imperial/CONFIG.DND5E.encumbrance.strMultiplier.metric value, USUALLY YOU DON'T NEED THIS because the module already do this with the setting "Heavily Encumbered" multiplier
Strength Multiplier Work only with strength multiplier feature enabled. Multiplier used to calculate maximum carrying weight from the strength ability score. 15 Usually you never need this except for some homebrew rule
Strength Multiplier (Metric System) Multiplier used to calculate maximum carrying weight from the strength ability score (Metric System). 7.5 Usually you never need this except for some homebrew rule
Variant Encumbrance Speed Penalties Enable automatic speed penalties from carry weight. true  
Unequipped Item Weight Multiplier Multiplier for items when not equipped. 1  
Equipped Item Weight Multiplier Multiplier for items when equipped, can be used to reduce effective weight for armour and weapons. 1  
Proficient Equipped Item Weight Multiplier Multiplier for proficient items when equipped, can be used to reduce effective weight for armour and weapons. 1  
Currency Per Weight Unit Define the number of coins required to equal 1 unit of weight. 50  
Currency Per Weight Unit (Metric System) Define the number of coins required to equal 1 unit of weight (Metric System). 110  
Vehicle weights Weight Multiplier, lbs in an imperial ton Vehicle weights are an order of magnitude greater, Multiplier for vehicles. 2000  
Vehicle weights Weight Multiplier, kg in a metric ton (Metric System) Vehicle weights are an order of magnitude greater, Multiplier for vehicles (Metric System). 1000  
Variant Encumbrance Size Modifiers Enable multipliers from creature size. true  
Weight Units Units displayed in the encumbrance bar (just graphics). lbs.  
Weight Units (Metric System) Units displayed in the encumbrance bar (just graphics) (Metric System). kg.  
Lightly Encumbered Speed Decrease The number of speed units subtracted when lightly encumbered, default is 10. 10  
Lightly Encumbered Speed Decrease (Metric System) The number of speed units subtracted when lightly encumbered, default is 3. 3  
Encumbered Speed Decrease The number of speed units subtracted when heavily encumbered, default is 20. 20  
Encumbered Speed Decrease (Metric System) The number of speed units subtracted when heavily encumbered, default is 6. 6  
Enable pre check encumbrance tier I DON'T RECOMMENDED it, but does anyone seem to use this strange rule? If true the add/remove of the AE is launched only when there is a change on the value level of the tier so the refresh is ignored when add/remove/update item false  
Enable/Disable the feature for applying the variant encumbrance active effects for specific actor If true add on the header sheet of the actor a button visible only to GM for enable/disable the active effects feature, by default the feature is disabled (the flag is false) for performance issues true  
Remove label from buttons on the header character sheet Remove label from buttons on the header character sheet, Useful for little screen and mobile, by default is true true  
Use standard calculation weight of the dnd5e system I DON'T RECOMMENDED it, but some people seem to lose their mind for 2s instead of 1s on the calculation weight ???, you will lose all the benefit from the others feature like Equipped, Unequipped, Proficient Equipped, Inventory +, Item container, ecc., but hey !! you got the 1 sec you miss. false  
Use equipped/unequipped feature of the ItemCollection/Item Container module for the backpack I DON'T RECOMMENDED it, the only difference (only for item container) is "Item container" module set 0 if unequipped, the "variant encumbrance" get the value from the module setting by default 1 if unequipped, and now i remember the calculation not make sense for some people because there are two behaviour for the equipped and unequipped items if they are item container or standard item. Bags can be unequipped by players or GM, so that their reported weight drops to 0 in your inventory (only bags with a capacity other than 0 can be unequipped) false This make sense only with Item Collection/Item Containers installed and active
Enable DAE integration If enabled, this setting will apply the value recovered by the DAE effects to the 'system.attributes.encumbrance.max' and 'system.attributes.capacity.cargo' attributes IF the 'DAE' module is present and active. true  
Do not show customized weight on item sheet If this setting module is enabled, it will hide the display of the custom weight (the one with the red text) from all non-gm users. By default, the value is true. true  
Replace standard displayed weight value on Actor Sheet If enabled, this setting will replace the standard weight displayed on the actor inventory list value with the 'modified value' from this module true  
Enable Bulk system Enable integration with the Bulk System explained here: https://www.giffyglyph.com/darkerdungeons/grimoire/4.0.0/en/active_inventory.html false  
Weight Units (Bulk System) Units displayed in the encumbrance bar (just graphics) (Bulk System). Default is 'bulk' bulk  
Encumbered Speed Decrease (Bulk System) The number of speed units multiply when heavily encumbered (Bulk System), default is '0.5'. 0.5  
Automatic apply suggested bulk WARNING: THIS IS DANGEROUS, IT WILL UPDATE THE BULK DATA ON EVERY ITEM BEEN RENDERED IF THE BULK VALUE IS 0. This is usually save time if you don't want to manually set every item (the advisable way) false  
Currency Per Bulk Unit (Bulk System) This parameter allows for the weight of coins to be taken into account in the Bulk system. If you do not like it you can disable it by setting it to 0, the default value provided is 100, so the calculation formula will be 'number of coins / 100' for example 'Krazak finds a rotting chest that holds 1,900 assorted copper coins (19 bulk carried)' 100  
Remove standard encumbrance bar from the character sheet If enabled it will hide the standard bar of encumbrance, is useful only for people using the bulk bar and do not want to see two graphic bars false  
Feature: Do Not increase weight by quantity for no ammunition item This is a homebrew rule, for non-ammunition items don't increase weight by quantity (so 5 potions = 1 item weight for example). ATTENTION: If the module 'Variant Encumbrance' is present and active this feature is disabled by default if the module settings 'Feature: Integration with Variant Encumbrance' is enabled. false  
Feature: Equipped Armor Weight Multiplier This is a homebrew rule, for equipped Armor types, if the weight is set to -1 is not applied, this will override the setting from 'Equipped Item Weight Multiplier'NOTE: The specific armor calculation setting 'Feature: Equipped Armor Weight Multiplier for 'XXX Armor' will be override this setting ONLY IF THE VALUE IS EQUAL TO 0. -1  
Feature: Equipped Armor Weight Multiplier for 'Clothing Armor' This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'clothing', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0. 0  
Feature: Equipped Armor Weight Multiplier for 'Light Armor' This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'light', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0. 0  
Feature: Equipped Armor Weight Multiplier for 'Medium Armor' This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'medium', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0. 0  
Feature: Equipped Armor Weight Multiplier for 'Heavy Armor' This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'heavy', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0. 0  
Feature: Equipped Armor Weight Multiplier for 'Natural Armor' This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'natural', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0. 0  
Feature: Equipped Container/Backpack Weight Multiplier: This is a homebrew rule, for equipped container/backpack types, if the weight is set to -1 is not applied, this will override the setting from 'Equipped Item Weight Multiplier'. -1  
Feature: Use STR flat value instead STR MOD, ONLY FOR BULK calculation This is a homebrew rule, ONLY FOR BULK calculation. Currently there is no way to adjust the maximum bulk for a creature, which is tied to size and STR MOD, now you can use the flat value of force to handle it. false  
Debug Enable debug messages useful for check issues false  

API

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActorFromId(actorIdOrName:string, ignoreCurrency:boolean) ⇒ EncumbranceData

Calculate the weight on the actor with all the filters applied.

ReturnsEncumbranceData - A EncumbranceData object

Param Type Description Default
actorIdOrName string The actor reference by id or name undefined

Examplegame.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActorFromId('Pippo')

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnTokenFromId(tokenIdOrName:string, ignoreCurrency:boolean) ⇒ EncumbranceData

Calculate the weight on the actor with all the filters applied.

ReturnsEncumbranceData - A EncumbranceData object

Param Type Description Default
tokenIdOrName string The token reference by id or name undefined

Examplegame.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnTokenFromId('Pippo')

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActor(actor:Actor, ignoreCurrency:boolean):EncumbranceData ⇒ EncumbranceData

Calculate the weight on the actor with all the filters applied.

ReturnsEncumbranceData - A EncumbranceData object

Param Type Description Default
actor Actor The actor object undefined

Examplegame.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActor(actor)

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActorFromId(actorIdOrName:string, ignoreCurrency:boolean) ⇒ EncumbranceData

Calculate the bulk on the actor with all the filters applied.

ReturnsEncumbranceData - A EncumbranceData object

Param Type Description Default
actorIdOrName string The actor reference by id or name undefined

Examplegame.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActorFromId('Pippo')

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnTokenFromId(tokenIdOrName:string, ignoreCurrency:boolean) ⇒ EncumbranceData

Calculate the bulk on the actor with all the filters applied.

ReturnsEncumbranceData - A EncumbranceData object

Param Type Description Default
tokenIdOrName string The token reference by id or name undefined

Examplegame.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnTokenFromId('Pippo')

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActor(actor:Actor, ignoreCurrency:boolean):EncumbranceData ⇒ EncumbranceData

Calculate the bulk on the actor with all the filters applied.

ReturnsEncumbranceData - A EncumbranceData object

Param Type Description Default
actor Actor The actor object undefined

Examplegame.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActor(actor)

game.modules.get('variant-encumbrance-dnd5e').api.convertLbToBulk(weight: number):number ⇒ number

Convert weight to bulk

ReturnsEncumbranceData - A EncumbranceData object

Param Type Description Default
weight number The weight undefined

Examplegame.modules.get('variant-encumbrance-dnd5e').api.convertLbToBulk(weight)

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActorWithItems(actor: Actor, items:Item[]): EncumbranceData | undefined

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActorWithItems(actor: Actor, items:Item[]): EncumbranceBulkData | undefined

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActorWithItemsNoInventoryPlus(actor: Actor, items:Item[]): EncumbranceData | undefined

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActorWithItemsNoInventoryPlus(actor: Actor, items:Item[]): EncumbranceBulkData | undefined

Models

EncumbranceData

Here the EncumbranceData structure:

{
  totalWeight: number,
  totalWeightToDisplay: number,
  lightMax: number,
  mediumMax: number,
  heavyMax: number,
  encumbranceTier: number,
  speedDecrease: number,
  unit: string,
  encumbrance:EncumbranceDnd5e;
}

EncumbranceDnd5e

Here the EncumbranceDataDnd5e structure:

{
  value: number;
  max: number;
  pct: number;
  encumbered?: boolean; //Vehicle not have this
}

EncumbranceBulkData

Here the EncumbranceBulkData structure extends EncumbranceData:

{
  totalWeight: number,
  totalWeightToDisplay: number,
  lightMax: number,
  mediumMax: number,
  heavyMax: number,
  encumbranceTier: number,
  speedDecrease: number,
  unit: string,
  encumbrance:EncumbranceDnd5e;
  inventorySlot: number;
  minimumBulk: number;
}

 

Supported Game Systems

  1. Dungeons & Dragons Fifth Edition

    Latest Version: Version 4.1.1 Last Updated 1 week, 2 days ago

Categories

Available Versions

  1. Version 0.16.1

    5 months ago
    Foundry Version 11 - 12 (Verified 11) Manifest URL Read Notes
  2. Version 0.16.0

    6 months ago
    Foundry Version 11 - 12 (Verified 11) Manifest URL Read Notes
  3. Version 0.15.6

    6 months, 1 week ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  4. Version 0.15.5

    7 months, 2 weeks ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  5. Version 0.15.4

    8 months, 3 weeks ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  6. Version 0.15.3

    8 months, 3 weeks ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  7. Version 0.15.2

    9 months ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  8. Version 0.15.1

    9 months ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  9. Version 0.15.0

    9 months, 3 weeks ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  10. Version 0.14.7

    9 months, 3 weeks ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  11. Version 0.14.4

    9 months, 3 weeks ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  12. Version 0.14.3

    9 months, 3 weeks ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  13. Version 0.14.2

    9 months, 3 weeks ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  14. Version 0.14.1

    10 months ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  15. Version 0.14.0

    10 months ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  16. Version 0.13.12

    10 months, 1 week ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  17. Version 0.13.11

    10 months, 1 week ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  18. Version 0.13.9

    10 months, 1 week ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  19. Version 0.13.8

    10 months, 1 week ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  20. Version 0.13.7

    1 year, 2 months ago
    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  21. Version 0.13.6

    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  22. Version 0.13.5

    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  23. Version 0.13.4

    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  24. Version 0.13.3

    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  25. Version 0.13.2

    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  26. Version 0.13.1

    Foundry Version 11 - 11 (Verified 11) Manifest URL Read Notes
  27. Version 0.12.9

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  28. Version 0.12.8

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  29. Version 0.12.7

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  30. Version 0.12.6

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  31. Version 0.12.5

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  32. Version 0.12.4

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  33. Version 0.12.3

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  34. Version 0.12.1

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  35. Version 0.12.0

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  36. Version 0.11.11

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  37. Version 0.11.10

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  38. Version 0.11.7

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  39. Version 0.11.6

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  40. Version 0.11.4

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  41. Version 0.11.3

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  42. Version 0.11.0

    Foundry Version 10 - 10 (Verified 10) Manifest URL Read Notes
  43. Version 0.10.1

    Foundry Version 9 - 9 (Verified 9) Manifest URL Read Notes
  44. Version 0.10.0

    Foundry Version 9 - 9 (Verified 9) Manifest URL Read Notes
  45. Version 0.9.14

    Foundry Version 9 - 9 (Verified 9) Manifest URL Read Notes
  46. Version 0.9.11

    Foundry Version 9 - 9 (Verified 9) Manifest URL Read Notes
  47. Version 0.9.3

    Foundry Version 9 - 9 (Verified 9) Manifest URL Read Notes
  48. Version 0.9.0

    Foundry Version 9 - 9 (Verified 9) Manifest URL Read Notes
  49. Version 0.8.4

    Foundry Version 9 - 9 (Verified 9) Manifest URL Read Notes
  50. Version 0.8.0

    Foundry Version 9 - 9 (Verified 9) Manifest URL Read Notes
  51. Version 0.7.2

    Foundry Version 0.8.9 - 9 (Verified 9) Manifest URL Read Notes
  52. Version 0.6.9

    Foundry Version 0.8.6 - 9 (Verified 0.8.9) Manifest URL Read Notes
  53. Version 0.5.21

    Foundry Version 0.8.6 - 9 (Verified 0.8.9) Manifest URL Read Notes
  54. Version 0.5.12

    Foundry Version 0.8.0 - 9 (Verified 0.8.9) Manifest URL Read Notes
  55. Version 0.5.1

    Foundry Version 0.8.0 - 9 (Verified 0.8.9) Manifest URL Read Notes
  56. Version 0.3.2

    Foundry Version 0.7.7 - 9 (Verified 0.7.9) Manifest URL Read Notes
  57. Version 0.1.5

    Foundry Version 0.7.5 - 9 (Verified 0.7.5) Manifest URL Read Notes