v0.6.15

- Exposed the "outcomes" of rolls performed via the Pirate Borg API to allow for better integration with other modules and/or macros.

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.6.15
+
+- Exposed the "outcomes" of rolls performed via the Pirate Borg API to allow for better integration with other modules and/or macros.
+
 # v0.6.14
 
 - Updated Rapscallion class. Changes made to:

how-to-use-this-system.md

@@ -95,3 +95,30 @@ This is an implementation of the PIRATE BORG rules, with limited adaptations to
   - Allowed classes: edit the classes in the character generator.
   - Apply overcapacity Penalty: +2 STR/AGI DR when carrying more than STR+8 items.
   - Track ammo: Select and auto-decrement ammo for ranged weapons.
+
+## API
+
+- An API is exposed at `game.pirateborg.api` for developers and GMs to use.
+
+The following are some examples provided by `Ashendar` on the Discord server.
+- An example of how to use the API to roll a character's attack is:
+  ```javascript
+  const outcome = game.pirateborg.api.characterAttackAction(actor, weapon);
+  ```
+- An example of how to roll a character strength check and test the outcome against a DR 18 is:
+  ```javascript
+  const outcome = await game.pirateborg.api.actions.actorRollAbilityAction(actor, "strength", ["Mining DR18"]);
+  return outcome.roll.total >= 18;
+  ```
+- An example of combining this with the multiple [landings feature](https://github.com/ironmonk88/monks-module-wiki/wiki/MATT-Landing) of [Monk's Active Tile Triggers](https://foundryvtt.com/packages/monks-active-tiles) is:
+  ```javascript
+  const outcome = await game.pirateborg.api.actions.actorRollAbilityAction(actor, "strength", ["Mining DR18"]);
+  let goto = [];
+  if (outcome.roll.total >= 18) {
+    goto.push({ tokens: arguments[0].tokens, tag: "Success" });
+  } else {
+    goto.push({ tokens: arguments[0].tokens, tag: "Fail" });
+  }
+  goto = goto.filter(g => g.tokens.length > 0);
+  return {goto: goto};
+  ```

module/api/action/actor/actor-initiative-action.js

@@ -3,7 +3,7 @@ import { createInitiativeOutcome } from "../../outcome/actor/initiative-outcome.
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const actorInitiativeAction = async (actor) => {
   const outcome = await createInitiativeOutcome({ actor });
@@ -20,4 +20,6 @@ export const actorInitiativeAction = async (actor) => {
       combatant.update({ initiative: outcome.roll.total });
     }
   }
+
+  return outcome;
 };

module/api/action/actor/actor-party-initiative-action.js

@@ -2,7 +2,7 @@ import { showGenericCard } from "../../../chat-message/generic-card.js";
 import { createPartyInitiativeOutcome } from "../../outcome/actor/party-initiative-outcome.js";
 
 /**
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const actorPartyInitiativeAction = async () => {
   const outcome = await createPartyInitiativeOutcome();
@@ -15,4 +15,6 @@ export const actorPartyInitiativeAction = async () => {
   if (game.combats && game.combat) {
     await game.combat.setPartyInitiative(outcome.roll.total);
   }
+
+  return outcome;
 };

module/api/action/actor/actor-roll-ability-action.js

@@ -5,7 +5,7 @@ import { createTestAbilityOutcome } from "../../outcome/actor/test-ability-outco
  * @param {PBActor} actor
  * @param {String} ability
  * @param {Array.<String>} drModifiers
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const actorRollAbilityAction = async (actor, ability, drModifiers = []) => {
   const outcome = await createTestAbilityOutcome({ actor, ability });
@@ -16,6 +16,8 @@ export const actorRollAbilityAction = async (actor, ability, drModifiers = []) =
     actor,
     outcomes: [outcome],
   });
+
+  return outcome;
 };
 
 /**

module/api/action/character/character-broken-action.js

@@ -3,7 +3,7 @@ import { createBrokenOutcome } from "../../outcome/character/broken-outcome.js";
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<ChatMessage>}
+ * @returns {Promise<Object>}
  */
 export const characterBrokenAction = async (actor) => {
   const outcome = await createBrokenOutcome({ actor });
@@ -13,4 +13,6 @@ export const characterBrokenAction = async (actor) => {
     actor,
     outcomes: [outcome],
   });
+
+  return outcome;
 };

module/api/action/character/character-defend-action.js

@@ -4,7 +4,7 @@ import { createDefendOutcome } from "../../outcome/character/defend-outcome.js";
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const characterDefendAction = async (actor) => {
   const { defendArmor, defendDR, incomingAttack, targetToken } = await showDefendDialog({ actor });
@@ -24,4 +24,6 @@ export const characterDefendAction = async (actor) => {
     items: [actor.equippedArmor, actor.equippedHat].filter((item) => item),
     target: targetToken,
   });
+
+  return outcome;
 };

module/api/action/character/character-get-better-action.js

@@ -8,7 +8,7 @@ import { outcome } from "../../outcome/outcome.js";
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<void>}
+ * @returns {Promise<Object[]>}
  */
 export const characterGetBetterAction = async (actor) => {
   const outcomes = [
@@ -29,6 +29,8 @@ export const characterGetBetterAction = async (actor) => {
   });
 
   await invokeGettingBetterMacro(actor);
+
+  return outcomes;
 };
 
 /**

module/api/action/character/character-invoke-extra-resource-action.js

@@ -31,4 +31,6 @@ export const characterInvokeExtraResourceAction = async (actor, item) => {
   });
 
   await characterUseItemAction(actor, item, outcome, chatMessage);
+
+  return outcome;
 };

module/api/action/character/character-invoke-relic-action.js

@@ -5,7 +5,7 @@ import { characterUseItemAction } from "./character-use-item-action.js";
 /**
  * @param {PBActor} actor
  * @param {PBItem} item
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const characterInvokeRelicAction = async (actor, item) => {
   const outcome = await createInvokeRelicOutcome({ actor });
@@ -18,4 +18,6 @@ export const characterInvokeRelicAction = async (actor, item) => {
   });
 
   await characterUseItemAction(actor, item, outcome, chatMessage);
+
+  return outcome;
 };

module/api/action/character/character-invoke-ritual-action.js

@@ -5,7 +5,7 @@ import { characterUseItemAction } from "./character-use-item-action.js";
 /**
  * @param {PBActor} actor
  * @param {PBItem} item
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const characterInvokeRitualAction = async (actor, item) => {
   if (actor.rituals.value < 1) {
@@ -27,4 +27,6 @@ export const characterInvokeRitualAction = async (actor, item) => {
   });
 
   await characterUseItemAction(actor, item, outcome, chatMessage);
+
+  return outcome;
 };

module/api/action/character/character-luck-per-day-action.js

@@ -5,7 +5,7 @@ import { createLuckPerDayOutcome } from "../../outcome/character/luck-per-day-ou
  * @param {PBActor} actor
  * @param {Object} options
  * @param {Boolean} options.silent
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const characterLuckPerDayAction = async (actor, { silent = false } = {}) => {
   const outcome = await createLuckPerDayOutcome({ actor });

module/api/action/character/character-reload-action.js

@@ -4,6 +4,7 @@ import { createReloadingOutcome } from "../../outcome/character/reloading-outcom
 /**
  * @param {PBActor} actor
  * @param {PBItem} item
+ * @returns {Promise<Object>}
  */
 export const characterReloadAction = async (actor, item) => {
   const reloadTime = item.reloadTime || 1;
@@ -27,4 +28,6 @@ export const characterReloadAction = async (actor, item) => {
     }),
     outcomes: [outcome],
   });
+
+  return outcome;
 };

module/api/action/character/character-rest-action.js

@@ -51,7 +51,7 @@ const canRest = (foodAndDrink, infected) => ![REST_FOOD_AND_DRINK.STARVE, REST_F
  */
 const shortRest = async (actor, foodAndDrink, infected) => {
   const isResting = canRest(foodAndDrink, infected);
-  await showGenericCard({
+  return showGenericCard({
     actor,
     title: game.i18n.localize("PB.Rest"),
     description: !isResting ? game.i18n.localize("PB.NoEffect") : "",
@@ -92,7 +92,7 @@ const longRest = async (actor, foodAndDrink, infected) => {
     outcomes.push(await characterLuckPerDayAction(actor, { silent: true }));
   }
 
-  await showGenericCard({
+  return showGenericCard({
     actor,
     title: game.i18n.localize("PB.Rest"),
     outcomes,

module/api/action/creature/creature-morale-action.js

@@ -3,7 +3,7 @@ import { createMoraleOutcome } from "../../outcome/creature/morale-outcome.js";
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const creatureMoraleAction = async (actor) => {
   if (!actor.attributes.morale || actor.attributes.morale === "-") {
@@ -18,4 +18,6 @@ export const creatureMoraleAction = async (actor) => {
     actor,
     outcomes: [outcome],
   });
+
+  return outcome;
 };

module/api/action/creature/creature-reaction-action.js

@@ -3,7 +3,7 @@ import { createReactionOutcome } from "../../outcome/creature/reaction-outcome.j
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<ChatMessage>}
+ * @returns {Promise<Object>}
  */
 export const creatureReactionAction = async (actor) => {
   const outcome = await createReactionOutcome();
@@ -13,4 +13,6 @@ export const creatureReactionAction = async (actor) => {
     actor,
     outcomes: [outcome],
   });
+
+  return outcome;
 };

module/api/action/ship/ship-broadsides-action.js

@@ -5,7 +5,7 @@ import { showGenericCard } from "../../../chat-message/generic-card.js";
 /**
  * @param {PBActor} actor
  * @param {Boolean} isPCAction
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipBroadsidesAction = async (actor, isPCAction) => {
   const { selectedActor, selectedDR, selectedArmor, targetToken } = await showCrewActionDialog({

module/api/action/ship/ship-come-about-action.js

@@ -5,7 +5,7 @@ import { createComeAboutOutcome } from "../../outcome/ship/ship-come-about-outco
 /**
  * @param {PBActor} actor
  * @param {Boolean} isPCAction
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipComeAboutAction = async (actor, isPCAction) => {
   const { selectedActor, selectedDR } = await showCrewActionDialog({

module/api/action/ship/ship-full-sail-action.js

@@ -5,7 +5,7 @@ import { showGenericCard } from "../../../chat-message/generic-card.js";
 /**
  * @param {PBActor} actor
  * @param {Boolean} isPCAction
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipFullSailAction = async (actor, isPCAction) => {
   const { selectedActor, selectedDR } = await showCrewActionDialog({

module/api/action/ship/ship-invoke-shanty-action.js

@@ -4,7 +4,7 @@ import { createInvokeShantyOutcome } from "../../outcome/ship/ship-invoke-shanty
 /**
  * @param {PBActor} actor
  * @param {PBItem} item
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipInvokeShantyAction = async (actor, item) => {
   if (actor.shanties.value < 1) {
@@ -22,5 +22,6 @@ export const shipInvokeShantyAction = async (actor, item) => {
     description: item.getData().description,
     outcomes: [outcome],
   });
-  // await this.useActionMacro(item.id);
+
+  return outcome;
 };

module/api/action/ship/ship-ram-action.js

@@ -6,7 +6,7 @@ import { createRamOutcome } from "../../outcome/ship/ship-ram-outcome.js";
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipRamAction = async (actor) => {
   const { selectedArmor, selectedMovement, targetToken } = await showCrewActionDialog({

module/api/action/ship/ship-repair-action.js

@@ -5,7 +5,7 @@ import { showGenericCard } from "../../../chat-message/generic-card.js";
 /**
  * @param {PBActor} actor
  * @param {Boolean} isPCAction
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipRepairAction = async (actor, isPCAction) => {
   const { selectedActor, selectedDR } = await showCrewActionDialog({

module/api/action/ship/ship-shanties-per-day-action.js

@@ -3,7 +3,7 @@ import { createShantiesPerDayOutcome } from "../../outcome/ship/ship-shanties-pe
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipShantiesPerDayAction = async (actor) => {
   const captain = game.actors.get(actor.captain);
@@ -17,4 +17,6 @@ export const shipShantiesPerDayAction = async (actor) => {
     title: game.i18n.localize("PB.ShipMysticShanties"),
     outcomes: [outcome],
   });
+
+  return outcome;
 };

module/api/action/ship/ship-sink-action.js

@@ -3,7 +3,7 @@ import { createSinkingOutcome } from "../../outcome/ship/ship-sinking-outcome.js
 
 /**
  * @param {PBActor} actor
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipSinkAction = async (actor) => {
   const outcome = await createSinkingOutcome({ actor });
@@ -14,4 +14,6 @@ export const shipSinkAction = async (actor) => {
     actor,
     outcomes: [outcome],
   });
+
+  return outcome;
 };

module/api/action/ship/ship-small-arms-action.js

@@ -5,7 +5,7 @@ import { showGenericCard } from "../../../chat-message/generic-card.js";
 /**
  * @param {PBActor} actor
  * @param {Boolean} isPCAction
- * @returns {Promise.<void>}
+ * @returns {Promise<Object>}
  */
 export const shipSmallArmsAction = async (actor, isPCAction) => {
   const { selectedActor, selectedDR, selectedArmor, targetToken } = await showCrewActionDialog({
@@ -33,4 +33,6 @@ export const shipSmallArmsAction = async (actor, isPCAction) => {
     outcomes: [outcome],
     target: targetToken,
   });
+
+  return outcome;
 };