Update hooks page to reflect new activity hooks (#4134)

foundryvtt · Sep 13, 2024 · 1e35297 · 1e35297
1 parent db6560b
commit 1e35297
Show file tree

Hide file tree

Showing 3 changed files with 298 additions and 74 deletions.
diff --git a/module/documents/activity/summon.mjs b/module/documents/activity/summon.mjs
@@ -182,7 +182,7 @@ export default class SummonActivity extends ActivityMixin(SummonActivityData) {
      * @memberof hookEvents
      * @param {SummonActivity} activity         The activity that is performing the summoning.
      * @param {SummonsProfile} profile          Profile used for summoning.
-     * @param {SummoningConfiguration} options  Additional summoning options.
+     * @param {SummoningConfiguration} options  Configuration data for summoning behavior.
      * @returns {boolean}                       Explicitly return `false` to prevent summoning.
      */
     if ( Hooks.call("dnd5e.preSummon", this, profile, options) === false ) return;
@@ -220,7 +220,7 @@ export default class SummonActivity extends ActivityMixin(SummonActivityData) {
          * @param {SummonActivity} activity         The activity that is performing the summoning.
          * @param {SummonsProfile} profile          Profile used for summoning.
          * @param {TokenUpdateData} config          Configuration for creating a modified token.
-         * @param {SummoningConfiguration} options  Additional summoning options.
+         * @param {SummoningConfiguration} options  Configuration data for summoning behavior.
          * @returns {boolean}                       Explicitly return `false` to prevent this token from being summoned.
          */
         if ( Hooks.call("dnd5e.preSummonToken", this, profile, tokenUpdateData, options) === false ) continue;
@@ -235,7 +235,7 @@ export default class SummonActivity extends ActivityMixin(SummonActivityData) {
          * @param {SummonActivity} activity         The activity that is performing the summoning.
          * @param {SummonsProfile} profile          Profile used for summoning.
          * @param {object} tokenData                Data for creating a token.
-         * @param {SummoningConfiguration} options  Additional summoning options.
+         * @param {SummoningConfiguration} options  Configuration data for summoning behavior.
          */
         Hooks.callAll("dnd5e.summonToken", this, profile, tokenData, options);
 

diff --git a/module/documents/activity/utility.mjs b/module/documents/activity/utility.mjs
@@ -94,7 +94,7 @@ export default class UtilityActivity extends ActivityMixin(UtilityActivityData)
     }, message);
 
     /**
-     * A hook event that fires before a formula is rolled for an Utility activity.
+     * A hook event that fires before a formula is rolled for a Utility activity.
      * @function dnd5e.preRollFormulaV2
      * @memberof hookEvents
      * @param {BasicRollProcessConfiguration} config   Configuration information for the roll.
@@ -121,7 +121,7 @@ export default class UtilityActivity extends ActivityMixin(UtilityActivityData)
     const rolls = await CONFIG.Dice.BasicRoll.build(rollConfig, dialogConfig, messageConfig);
 
     /**
-     * A hook event that fires after a hit die has been rolled for an Actor, but before updates have been performed.
+     * A hook event that fires after a formula has been rolled for a Utility activity.
      * @function dnd5e.rollFormulaV2
      * @memberof hookEvents
      * @param {BasicRoll[]} rolls              The resulting rolls.