Default icons for actors and items. (#141)

* Add a Hook that executes after an actor is imported.

* Apply default icons for Items on imported actors.

* Implement entity creation hooks to set themed default icons.

* Unify default image selection and apply to the parser and embedded entities.

* Add placeholder spell image.

* Only assign an image for actors/items with no existing image.

Author: mooped

module/actor-sheet.js

@@ -1,6 +1,7 @@
 /* global ActorSheet, CONFIG, duplicate, Dialog, game, mergeObject, expandObject, $, ENTITY_PERMISSIONS */
 
 import DCCActorConfig from './actor-config.js'
+import EntityImages from './entity-images.js'
 
 /**
  * Extend the basic ActorSheet
@@ -688,6 +689,7 @@ class DCCActorSheet extends ActorSheet {
     // Prepare the item object.
     const itemData = {
       name: name,
+      img: EntityImages.imageForItem(type),
       type: type,
       data: data
     }

module/config.js

@@ -360,4 +360,18 @@ DCC.mercurialMagicTable = null
 // List of available disapproval tables for the cleric sheet, generated from disapprovalPacks
 DCC.disapprovalTables = {}
 
+// Default actor images
+DCC.defaultActorImages = {
+  default: 'systems/dcc/styles/images/actor.webp'
+}
+
+// Default item tokens
+DCC.defaultItemImages = {
+  default: 'systems/dcc/styles/images/item.webp',
+  armor: 'systems/dcc/styles/images/armor.webp',
+  spell: 'systems/dcc/styles/images/spell.webp',
+  treasure: 'systems/dcc/styles/images/coins.webp',
+  weapon: 'systems/dcc/styles/images/weapon.webp'
+}
+
 export default DCC

module/dcc.js

@@ -15,6 +15,7 @@ import * as migrations from './migrations.js'
 import DiceChain from './dice-chain.js'
 import parser from './parser.js'
 import TablePackManager from './tablePackManager.js'
+import EntityImages from './entity-images.js'
 
 import { registerSystemSettings } from './settings.js'
 
@@ -223,6 +224,31 @@ Hooks.on('dcc.setMercurialMagicTable', (value, fromSystemSetting = false) => {
   }
 })
 
+// Entity creation hook
+Hooks.on('createActor', (entity, options, userId) => {
+  if (!game.user.isGM || entity.data.img) { return }
+
+  // Assign an appropriate DCC actor image
+  const img = EntityImages.imageForActor(entity.type)
+  if (img) {
+    entity.update({
+      img
+    })
+  }
+})
+
+Hooks.on('createItem', (entity, options, userId) => {
+  if (!game.user.isGM || entity.data.img) { return }
+
+  // Assign an appropriate DCC item image
+  const img = EntityImages.imageForItem(entity.type)
+  if (img) {
+    entity.update({
+      img
+    })
+  }
+})
+
 /* -------------------------------------------- */
 /*  Hotbar Macros                               */
 /* -------------------------------------------- */

module/entity-images.js

@@ -0,0 +1,41 @@
+/* global CONFIG */
+
+class EntityImages {
+  /**
+   * Select an appropriate image from a map
+   * @param {Object}  map     The map of entity types (or default) to image paths
+   * @param {String}  type    The entity type
+   * @returns {String}        The image to use
+   */
+  static _selectImage (map, type) {
+    // Grab the default image if available
+    let img = map.default
+
+    // Check for a more specialised image based on actor type
+    if (map[type]) {
+      img = map[type]
+    }
+
+    return img
+  }
+
+  /**
+   * Select an appropriate image for an actor
+   * @param {String}  type    The actor type
+   * @returns {String}        The image to use
+   */
+  static imageForActor (type) {
+    return this._selectImage(CONFIG.DCC.defaultActorImages, type)
+  }
+
+  /**
+   * Select an appropriate image for an item
+   * @param {String}  type    The item type
+   * @returns {String}        The image to use
+   */
+  static imageForItem (type) {
+    return this._selectImage(CONFIG.DCC.defaultItemImages, type)
+  }
+}
+
+export default EntityImages

module/parser.js

@@ -1,4 +1,4 @@
-/* global CONFIG, FormApplication, game, expandObject ui, $ */
+/* global CONFIG, expandObject, FormApplication, game, Hooks, ui, $ */
 
 import DCCActor from './actor.js'
 import parsePCs from './pc-parser.js'
@@ -126,6 +126,9 @@ async function createActors (type, folderId, actorData) {
     }
 
     actors.push(actor)
+
+    // Call a hook for postprocessing of actors
+    Hooks.callAll('dcc.postActorImport', { actor })
   }
 
   return actors

module/pc-parser.js

@@ -1,5 +1,7 @@
 /* global game, ui */
 
+import EntityImages from './entity-images.js'
+
 /**
  *  Parses Player Stat Blocks (e.g. from Purple Sorceror) into an NPC sheet
  *
@@ -136,28 +138,32 @@ function _parseJSONPCs (pcObject) {
         notes = notes + '  ' + pcObject.equipment + '<br/>'
         pc.items.push({
           name: pcObject.equipment,
-          type: 'equipment'
+          type: 'equipment',
+          img: EntityImages.imageForItem('equipment')
         })
       }
       if (pcObject.equipment2) {
         notes = notes + '  ' + pcObject.equipment2 + '<br/>'
         pc.items.push({
           name: pcObject.equipment2,
-          type: 'equipment'
+          type: 'equipment',
+          img: EntityImages.imageForItem('equipment')
         })
       }
       if (pcObject.equipment3) {
         notes = notes + '  ' + pcObject.equipment3 + '<br/>'
         pc.items.push({
           name: pcObject.equipment3,
-          type: 'equipment'
+          type: 'equipment',
+          img: EntityImages.imageForItem('equipment')
         })
       }
       if (pcObject.tradeGood) {
         notes = notes + '  ' + pcObject.tradeGood + ' (' + game.i18n.localize('DCC.TradeGoods') + ')<br/>'
         pc.items.push({
           name: pcObject.tradeGood,
-          type: 'equipment'
+          type: 'equipment',
+          img: EntityImages.imageForItem('equipment')
         })
       }
       notes = notes + '<br/>'
@@ -184,6 +190,7 @@ function _parseJSONPCs (pcObject) {
         notes = notes + spell.level + ') ' + spell.name + '<br/>'
         pc.items.push({
           name: spell.name,
+          img: EntityImages.imageForItem('spell'),
           type: 'spell',
           data: {
             level: spell.level,
@@ -422,6 +429,7 @@ function _parseWeapon (weaponString) {
     const name = weaponData[1].replace(/\s+melee/, '').replace(/\s+ranged/, '')
     return {
       name: name,
+      img: 'systems/dcc/styles/images/weapon.webp',
       attackMod: weaponData[2],
       attackDamage: damage,
       melee: melee
@@ -438,6 +446,7 @@ function _parseArmor (armorString) {
     return {
       name: armorFields[1],
       type: 'armor',
+      img: EntityImages.imageForItem('armor'),
       data: {
         acBonus: armorFields[2],
         checkPenalty: armorFields[3],
@@ -458,6 +467,7 @@ function _parseStartingFunds (startingFundsString) {
   return {
     name: 'Coins',
     type: 'treasure',
+    img: EntityImages.imageForItem('treasure'),
     data: {
       value: {
         pp,