example.md

Todo

• Set up module
• Add summon type to DND5E.itemActionType config object
• Modify item sheets with summon action type to show summon list built from flags
• Make summons list respond to dropped actors, name changes, and deletions
• Display "Summon" button on chat message
• Add summon checkbox and dropdown in item consumption message
• Summon actor using Warp Gate upon casting or when summon button is clicked
• Store summoning item's roll data in summoned actor's flags
• Insert static summoner roll data into summoned creature's roll data
• Implement interface for configuring summoned actors
• Add ability to configure item modifications on summons
• Modify summoned actor's data based on summoning item's roll data
• Add summons type selection UI if no type is selected during roll or modifier key is pressed when summons is clicked
• Ensure everything is properly localizable
• Add easy AC & HP change formula fields
• Fix bug caused by using ability templates & summons at the same time
• Add ability to summon more than one creature, specified in summons list

Summoned Actor Configuration Data

This data is stored within the flags of an actor to be summoned and contains information on how the actor should be modified when summoned. The formulas here use the summoning actor's roll data.

{
  "flags": {
    "arbron-summoner": {
      "config": {
        "version": 1,
        "matchProficiency": true,
        "matchToHit": true,
        "matchSaveDCs": true,
        "acFormula": "11 + @item.level",
        "hpFormula": "40 + 10 * (@item.level - 4)",
        "actorChanges": [],
        "itemChanges": []
      },
      "summonerData": {
        "actorUuid": "abcd",
        "itemId": "",
        "rollData": {}
      }
    }
  }
}

Summoned Actor Roll Data

The roll data for the summoned actor will be modified to include a summoner field that will contained a copy of the data from the actor that summoned them. This will be a copy of the summoner's roll data, and so it will not be updated after the summon has occurred even if the summoner's stats change.

System Integration

Adds a new itemActionType for summon which can be set on spells or features. When set, this gives the ability to link one or more summonable actors to that item. When the item is used, the consume window pops up allow to choose whether the summon and actor and which one of the variants to summon. This requires create token permissions.

When the summon is created, the module takes the item data, makes changes based on what is stored in the arbron-summoner flags on the actor, and then creates an unlinked token wherever the player clicks.

{
  "flags": {
    "arbron-summoner": {
      "summons": [
        {
          "name": "Clay",
          "uuid": "Actor.zaNtK6iPI3ttIglY"
        },
        {
          "name": "Metal",
          "uuid": "Actor.XcnIjNcost9kG92P"
        },
        {
          "name": "Stone",
          "uuid": "Actor.B7DyafZAdI40tEWs"
        }
      ]
    }
  }
}