Merge pull request #4072 from foundryvtt/advancement/subclass-simple

[#1407] Add Subclass advancement & selection interface on sheet

icons/LICENSE

@@ -14,6 +14,7 @@ The dnd5e system for Foundry Virtual Tabletop includes icon artwork licensed fro
 /svg/original-class.svg - "Barbute" by Lorc under CC BY 3.0
 /svg/scale-value.svg - "Dice target" by Delapouite under CC BY 3.0
 /svg/size.svg - "Body height" by Delapouite under CC BY 3.0
+/svg/subclass.svg - "Elf helmet" by Kier Heyl under CC BY 3.0
 /svg/trait.svg - "Scroll unfurled" by Lorc under CC BY 3.0
 /svg/trait-armor-proficiencies.svg - "Leather armor" by Delapouite under CC BY 3.0
 /svg/trait-damage-immunities.svg - "Aura" by Lorc under CC BY 3.0

lang/en.json

@@ -264,6 +264,11 @@
       "Level": "Must be at least level {level} to take this feat.",
       "Type": "Only features with the \"feat\" type can be selected."
     }
+  },
+  "Subclass": {
+    "Title": "Subclass",
+    "Hint": "Specify what level this class receives its subclass.",
+    "FlowHint": "Select a subclass in the Features tab after level up has completed."
   }
 },
 
@@ -2436,6 +2441,7 @@
     "Hint": "Formula in GP that can be used in place of starting equipment."
   }
 },
+"DND5E.SubclassAdd": "Add Subclass",
 "DND5E.SubclassIdentifierHint": "This identifier should match the identifier on the parent class to ensure they are properly linked.",
 "DND5E.SubclassAssignmentError": "{class} already has a subclass. Remove the existing '{subclass}' subclass before adding a new one.",
 "DND5E.SubclassDuplicateError": "A subclass with the identifier {identifier} already exists on this actor.",

less/v2/actors.less

@@ -160,6 +160,14 @@
             bottom: 2px;
           }
         }
+
+        .subclass-icon {
+          display: flex;
+          align-items: center;
+          justify-content: center;
+          color: var(--dnd5e-color-card);
+          font-size: var(--font-size-20);
+        }
       }
 
       .name-stacked { flex: 1; }

module/applications/actor/character-sheet-2.mjs

@@ -1,6 +1,6 @@
 import CharacterData from "../../data/actor/character.mjs";
 import * as Trait from "../../documents/actor/trait.mjs";
-import { formatNumber, simplifyBonus } from "../../utils.mjs";
+import { formatNumber } from "../../utils.mjs";
 import CompendiumBrowser from "../compendium-browser.mjs";
 import ContextMenu5e from "../context-menu.mjs";
 import SheetConfig5e from "../sheet-config.mjs";
@@ -385,7 +385,9 @@ export default class ActorSheet5eCharacter2 extends ActorSheetV2Mixin(ActorSheet
   _onAction(event) {
     const target = event.currentTarget;
     switch ( target.dataset.action ) {
-      case "findItem": this._onFindItem(target.dataset.itemType); break;
+      case "findItem":
+        this._onFindItem(target.dataset.itemType, { classIdentifier: target.dataset.classIdentifier });
+        break;
       case "removeFavorite": this._onRemoveFavorite(event); break;
       case "spellcasting": this._onToggleSpellcasting(event); break;
       case "toggleInspiration": this._onToggleInspiration(); break;
@@ -419,11 +421,15 @@ export default class ActorSheet5eCharacter2 extends ActorSheetV2Mixin(ActorSheet
 
   /**
    * Show available items of a given type.
-   * @param {string} type  The item type.
+   * @param {string} type                       The item type.
+   * @param {object} [options={}]
+   * @param {string} [options.classIdentifier]  Identifier of the class when finding a subclass.
    * @protected
    */
-  async _onFindItem(type) {
-    const result = await CompendiumBrowser.selectOne({ filters: { locked: { types: new Set([type]) } } });
+  async _onFindItem(type, { classIdentifier }={}) {
+    const filters = { locked: { types: new Set([type]) } };
+    if ( classIdentifier ) filters.locked.additional = { class: { [classIdentifier]: 1 } };
+    const result = await CompendiumBrowser.selectOne({ filters });
     if ( result ) this._onDropItemCreate(await fromUuid(result));
   }
 

module/applications/actor/character-sheet.mjs

@@ -63,7 +63,7 @@ export default class ActorSheet5eCharacter extends ActorSheet5e {
 
     // Partition items by category
     let {items, spells, feats, races, backgrounds, classes, subclasses} = context.items.reduce((obj, item) => {
-      const {quantity, uses} = item.system;
+      const { quantity } = item.system;
 
       // Item details
       const ctx = context.itemContext[item.id] ??= {};
@@ -142,6 +142,10 @@ export default class ActorSheet5eCharacter extends ActorSheet5e {
       const identifier = cls.system.identifier || cls.name.slugify({strict: true});
       const subclass = subclasses.findSplice(s => s.system.classIdentifier === identifier);
       if ( subclass ) arr.push(subclass);
+      else {
+        const subclassAdvancement = cls.advancement.byType.Subclass?.[0];
+        if ( subclassAdvancement && (subclassAdvancement.level <= cls.system.levels) ) ctx.needsSubclass = true;
+      }
       return arr;
     }, []);
     for ( const subclass of subclasses ) {

module/applications/advancement/_module.mjs

@@ -17,5 +17,6 @@ export {default as ScaleValueConfig} from "./scale-value-config.mjs";
 export {default as ScaleValueFlow} from "./scale-value-flow.mjs";
 export {default as SizeConfig} from "./size-config.mjs";
 export {default as SizeFlow} from "./size-flow.mjs";
+export {default as SubclassFlow} from "./subclass-flow.mjs";
 export {default as TraitConfig} from "./trait-config.mjs";
 export {default as TraitFlow} from "./trait-flow.mjs";

module/applications/advancement/advancement-flow.mjs

@@ -92,6 +92,7 @@ export default class AdvancementFlow extends FormApplication {
       advancement: this.advancement,
       type: this.advancement.constructor.typeName,
       title: this.title,
+      hint: this.advancement.hint,
       summary: this.advancement.summaryForLevel(this.level),
       level: this.level
     };

module/applications/advancement/subclass-flow.mjs

@@ -0,0 +1,13 @@
+import AdvancementFlow from "./advancement-flow.mjs";
+
+/**
+ * Inline application that presents the player with the subclass hint.
+ */
+export default class SubclassFlow extends AdvancementFlow {
+  /** @inheritDoc */
+  async getData() {
+    return foundry.utils.mergeObject(super.getData(), {
+      hint: `${this.advancement.hint ?? ""} ${game.i18n.localize("DND5E.ADVANCEMENT.Subclass.FlowHint")}`
+    });
+  }
+}

module/config.mjs

@@ -3506,6 +3506,10 @@ DND5E.advancementTypes = {
     documentClass: advancement.SizeAdvancement,
     validItemTypes: new Set(["race"])
   },
+  Subclass: {
+    documentClass: advancement.SubclassAdvancement,
+    validItemTypes: new Set(["class"])
+  },
   Trait: {
     documentClass: advancement.TraitAdvancement,
     validItemTypes: new Set(_ALL_ITEM_TYPES)

module/documents/advancement/_module.mjs

@@ -6,4 +6,5 @@ export {default as ItemChoiceAdvancement} from "./item-choice.mjs";
 export {default as ItemGrantAdvancement} from "./item-grant.mjs";
 export {default as ScaleValueAdvancement} from "./scale-value.mjs";
 export {default as SizeAdvancement} from "./size.mjs";
+export {default as SubclassAdvancement} from "./subclass.mjs";
 export {default as TraitAdvancement} from "./trait.mjs";

module/documents/advancement/subclass.mjs

@@ -0,0 +1,42 @@
+import Advancement from "./advancement.mjs";
+import SubclassFlow from "../../applications/advancement/subclass-flow.mjs";
+
+/**
+ * Advancement that indicates when a class takes a subclass. Only allowed on class items and can only be taken once.
+ */
+export default class SubclassAdvancement extends Advancement {
+
+  /** @inheritDoc */
+  static get metadata() {
+    return foundry.utils.mergeObject(super.metadata, {
+      order: 70,
+      icon: "icons/skills/trades/mining-pickaxe-yellow-blue.webp",
+      typeIcon: "systems/dnd5e/icons/svg/subclass.svg",
+      title: game.i18n.localize("DND5E.ADVANCEMENT.Subclass.Title"),
+      hint: game.i18n.localize("DND5E.ADVANCEMENT.Subclass.Hint"),
+      apps: {
+        flow: SubclassFlow
+      }
+    });
+  }
+
+  /* -------------------------------------------- */
+  /*  Display Methods                             */
+  /* -------------------------------------------- */
+
+  /** @inheritDoc */
+  summaryforLevel(level, { configMode=false }={}) {
+    const subclass = this.item.subclass;
+    if ( configMode || !subclass ) return "";
+    return subclass.toAnchor().outerHTML;
+  }
+
+  /* -------------------------------------------- */
+  /*  Editing Methods                             */
+  /* -------------------------------------------- */
+
+  /** @inheritDoc */
+  static availableForItem(item) {
+    return !item.advancement.byType.Subclass?.length;
+  }
+}

packs/_source/classes/barbarian.json

@@ -522,6 +522,16 @@
         },
         "level": 19,
         "title": ""
+      },
+      {
+        "_id": "ok09058sgbpt0w6b",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 3,
+        "title": "Primal Path",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/bard.json

@@ -661,6 +661,16 @@
         },
         "level": 19,
         "title": ""
+      },
+      {
+        "_id": "wjdgb3r8pyeix83o",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 3,
+        "title": "Bard College",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/cleric.json

@@ -385,6 +385,16 @@
         },
         "level": 19,
         "title": ""
+      },
+      {
+        "_id": "8k7cukgzwwl67h6c",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 1,
+        "title": "Divine Domain",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/druid.json

@@ -463,6 +463,16 @@
         "value": {},
         "title": "Wild Shape Uses",
         "icon": null
+      },
+      {
+        "_id": "p9otj81aosxpn6wn",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 2,
+        "title": "Druid Circle",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/fighter.json

@@ -474,6 +474,16 @@
         },
         "level": 14,
         "title": ""
+      },
+      {
+        "_id": "aqampk2fc5jk5jqh",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 3,
+        "title": "Martial Archetype",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/monk.json

@@ -596,6 +596,16 @@
         },
         "level": 19,
         "title": ""
+      },
+      {
+        "_id": "0awj2yq115ev9u9o",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 3,
+        "title": "Monastic Tradition",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/paladin.json

@@ -488,6 +488,16 @@
         },
         "value": {},
         "title": "Aura Radius"
+      },
+      {
+        "_id": "n22j60yn24fqr3sy",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 3,
+        "title": "Sacred Oath",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/ranger.json

@@ -527,6 +527,16 @@
         },
         "level": 19,
         "title": ""
+      },
+      {
+        "_id": "gb53865sgbtx8xr2",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 3,
+        "title": "Ranger Archetype",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/rogue.json

@@ -645,6 +645,16 @@
         "level": 15,
         "title": "",
         "value": {}
+      },
+      {
+        "_id": "n0yoxbkyz32yd942",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 3,
+        "title": "Roguish Archetype",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/sorcerer.json

@@ -413,6 +413,16 @@
         },
         "level": 19,
         "title": ""
+      },
+      {
+        "_id": "f06tge0vsvdhb0sw",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 1,
+        "title": "Sorcerous Origin",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {

packs/_source/classes/warlock.json

@@ -624,6 +624,16 @@
         },
         "level": 19,
         "title": ""
+      },
+      {
+        "_id": "vibumq2vxjl9tmk4",
+        "type": "Subclass",
+        "configuration": {},
+        "value": {},
+        "level": 1,
+        "title": "Otherworldly Patron",
+        "icon": "",
+        "classRestriction": ""
       }
     ],
     "spellcasting": {