add addToActor and removeFromActor triggers

Author: FurtherV

README.md

@@ -11,25 +11,37 @@ Clicking this button opens an overview where you can edit that item's scripts.
 
 A script receives the following arguments (very similar to a normal Foundry macro!) when run:
 
-- `this` is a copy of the Script itself
-- `item` the item containing the script
-- `speaker` speaker data of the item's actor or the currently selected token or user's character
-- `actor` actor from the speaker data, usually the item's owner
-- `token` token from the speaker data
-- `character` the current user's character or null
-- `trigger` the trigger of the script, such as a button press or on item use.
+- `this` - is a copy of the Script itself
+- `item` - the item containing the script
+- `speaker` - speaker data of the item's Actor or the currently selected token or user's character
+- `actor` - actor from the speaker data, usually the item's owner
+- `token` - token from the speaker data
+- `character` - the current user's character or null
+- `trigger` - the trigger of the script, such as a button press or on item use.
   Is equal to `debug` when ran from the script's config sheet.
-- `message` the chat message which triggered the script (only `trigger === "button"`)
+- `optional` - an object containing additional, optional arguments
+  - `optional.message` - The chat message containing the clicked button (if `trigger === "button"` is true)
 
 Available triggers are currently:
 
-- When using the item (`dnd5e.preUseItem`)
+- `preUseItem` - When using the item (Hook is `dnd5e.preUseItem`)
   - If you want to also have normal item usage, you can return `true` from the script
   - If you want to use `item.use()` inside the script, you can use `item.use({}, {skipScripts: true})`
-- A button in the item's chat card
+- `button` A button in the item's chat card that triggers the script when clicked
+- `addToActor` When the item is added to an actor
+- `removeFromActor` When the item is removed from an actor
 
 ## Changelog
 
+### 0.2.0
+
+- Improved README
+- Improved localization
+- Refactored optional script arguments into an object
+- Added script triggers `addToActor` and `removeFromActor` which will execute the given script when the item is added
+  or removed from an actor
+- Added a module setting to toggle the visibility of the header button label
+
 ### 0.1.2
 
 - Added a module setting to show the header button only to users with the specified minimum role

lang/en.json

@@ -2,7 +2,9 @@
   "SCRIPTABLE-ITEMS": {
     "Trigger": {
       "button": "On Button Click",
-      "preUseItem": "On Pre Use Item"
+      "preUseItem": "On Pre Use Item",
+      "addToActor": "When Added to Actor",
+      "removeFromActor": "When Removed from Actor"
     },
     "Script": {
       "Label": "Script",
@@ -12,7 +14,11 @@
     "Setting": {
       "headerButtonPermission": {
         "Name": "Button Permission Level",
-        "Hint": "The 'Scriptable Items' button in item sheets will be hidden for any user with a role less than the chosen role."
+        "Hint": "The minimum role required to see the 'Scriptable Items' button in the header of item sheets."
+      },
+      "showHeaderButtonLabel": {
+        "Name": "Display Button Label",
+        "Hint": "If checked, the button's label is displayed."
       }
     },
     "Dialog": {

scripts/constants.mjs

@@ -7,6 +7,8 @@ const FLAG = {
 const TRIGGER = {
   BUTTON: "button",
   PRE_USE: "preUseItem",
+  ADD_TO_ACTOR: "addToActor",
+  REMOVE_FROM_ACTOR: "removeFromActor",
 };
 const SETTING = {
   HEADER_BUTTON_PERMISSION: "headerButtonPermission",

scripts/data/script-model.mjs

@@ -131,6 +131,7 @@ export class ScriptModel extends foundry.abstract.DataModel {
       "token",
       "character",
       "trigger",
+      "optional",
       ...argNames,
       `{${this.command}\n}`,
     );
@@ -145,12 +146,14 @@ export class ScriptModel extends foundry.abstract.DataModel {
         token,
         character,
         trigger,
+        { ...scope },
         ...argValues,
       );
     } catch (err) {
       ui.notifications.error(
         "There was an error in your script syntax. See the console (F12) for details.",
       );
+      console.error(err);
     }
   }
 

scripts/scriptable-items.mjs

@@ -94,3 +94,41 @@ Hooks.on("dnd5e.renderChatMessage", (message, html) => {
     });
   });
 });
+
+Hooks.on("createItem", async (item, options, userId) => {
+  if (game.user.id !== userId) return;
+  if (item.actor == null) return;
+
+  const scripts = ScriptModel.getAll(item).filter((x) =>
+    x.triggers.has(TRIGGER.ADD_TO_ACTOR),
+  );
+  if (!scripts.length) return;
+
+  let script = scripts[0];
+  if (script.length > 1) {
+    const chosenScriptId = await ScriptChoiceDialog.create(scripts);
+    if (chosenScriptId == null) return;
+    script = scripts.find((x) => x.id === chosenScriptId);
+  }
+
+  await script.executeScript({ trigger: TRIGGER.ADD_TO_ACTOR });
+});
+
+Hooks.on("deleteItem", async (item, options, userId) => {
+  if (game.user.id !== userId) return;
+  if (item.actor == null) return;
+
+  const scripts = ScriptModel.getAll(item).filter((x) =>
+    x.triggers.has(TRIGGER.REMOVE_FROM_ACTOR),
+  );
+  if (!scripts.length) return;
+
+  let script = scripts[0];
+  if (script.length > 1) {
+    const chosenScriptId = await ScriptChoiceDialog.create(scripts);
+    if (chosenScriptId == null) return;
+    script = scripts.find((x) => x.id === chosenScriptId);
+  }
+
+  await script.executeScript({ trigger: TRIGGER.REMOVE_FROM_ACTOR });
+});