Skip to content

Commit

Permalink
Document Cast & Forward activities (#4661)
Browse files Browse the repository at this point in the history
  • Loading branch information
arbron authored Nov 8, 2024
1 parent a8b19d5 commit f8adcb5
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 0 deletions.
2 changes: 2 additions & 0 deletions wiki/Activities.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@ Clicking the plus button brings up the Create Activity dialog with a list of act

There are a variety of activity types offered by the DnD5e system, and modules can contribute their own custom types. More details on each type can be found on their own pages:
- [Attack](Activity-Type-Attack.md): Make an attack roll and roll damage
- [Cast](Activity-Type-Cast.md): Cast a spell through an item
- [Check](Activity-Type-Check.md): Perform an ability check
- [Damage](Activity-Type-Damage.md): Damage a creature without a check
- [Enchant](Activity-Type-Enchant.md): Apply an enchantment to an item
- [Forward](Activity-Type-Forward.md): Trigger another activity with different consumption & scaling
- [Heal](Activity-Type-Heal.md): Heal a creature
- [Save](Activity-Type-Save.md): Impose a saving throw roll and roll damage
- [Summon](Activity-Type-Summon.md): Summon a new creature to the scene
Expand Down
35 changes: 35 additions & 0 deletions wiki/Activity-Type-Cast.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
![Up to date as of 4.1.0](https://img.shields.io/static/v1?label=dnd5e&message=4.1.0&color=informational)

The Cast activity allows for casting a spell through an item.


## Spell Listing

When items that contain Cast activities are added to a character the spells they offer appear in a new section of the spell list called Item Spells. If an item requires attunement, then these spells will only be listed if the item is attuned.

![Cast Sheet - Identity Tab](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/activities/cast-spellbook.jpg)


## Casting Spells

There are two ways to cast spells offered by the Cast activity, either by activating the Cast activity on the item itself or by clicking the spell in the Item Spells section of the character sheet. Both of these method will behave the same, bringing up a dialog for any configuration required and handling spending any charges on the item.


## Configuring Casts

The Cast activity can be created using the standard Create Activity dialog, or by dragging a spell onto the activities tab of another item, which will create a new Cast activity with that spell already configured.

After creating the Cast activity the configuration sheet will open on the "Identity" tab. In addition to the standard activity options (see the [Activities Overview](Activities.md) for more details), Cast also includes the *Display in Spellbook* option to control whether the spell provided by this activity is listed in the Item Spells section of the spellbook. If unchecked, then players can still cast the spell directly from the item.

![Cast Sheet - Identity Tab](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/activities/cast-identity.jpg)

### Casting Details

The "Spell" tab contains the rest of the unique properties for the Cast activity, including what spell will be cast and how it will be cast.

![Cast Sheet - Spell Tab](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/activities/cast-effect.jpg)

The "Casting Details" section contains options that affect how casting will occur
- *Casting Level*: Sets the base level at which the spell is cast. Increasing it ensures the spell is always cast at at least that level, and any scaling will be on top of the casting level
- *Ignored Properties*: Properties on the spell that will be ignored when casting through this item. Removing "Concentration" property here is not enough to ensure the spell doesn't require concentration, the Duration in the "Activation" tab will also need to be overridden
- *Override Values*: If checked will display additional options to replace the attack bonus and save DC for the spell. By default spells will use the character's spell attack bonus and save DC, but certain items include fixed values which should be entered in the revealed fields
12 changes: 12 additions & 0 deletions wiki/Activity-Type-Forward.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
![Up to date as of 4.1.0](https://img.shields.io/static/v1?label=dnd5e&message=4.1.0&color=informational)

The Forward activity allows for triggering another activity on the same item with different consumption and scaling.


## Configuring Forward

After creating the Forward activity the configuration sheet will open on the "Identity" tab. The sheet for Forward is simplified compared to other activity sheets, not featuring any activation, duration, or targeting information. In the "Consumption" tab you can configure consumption, uses, and recovery like normal, and any scaling set up will affect the activity being used.

On the "Effect" tab there is only a single option that allows for selecting which activity will be triggered by the Forward activity when used.

![Forward Sheet - Effect Tab](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/activities/forward-effect.jpg)
2 changes: 2 additions & 0 deletions wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@
- [Activities Overview](Activities.md)
- Activity Types
- [Activity Type: Attack](Activity-Type-Attack.md)
- [Activity Type: Cast](Activity-Type-Cast.md)
- [Activity Type: Check](Activity-Type-Check.md)
- [Activity Type: Damage](Activity-Type-Damage.md)
- [Activity Type: Enchant](Activity-Type-Enchant.md)
- [Activity Type: Forward](Activity-Type-Forward.md)
- [Activity Type: Heal](Activity-Type-Heal.md)
- [Activity Type: Save](Activity-Type-Save.md)
- [Activity Type: Summon](Activity-Type-Summon.md)
Expand Down
Binary file modified wiki/images/activities/activity-creation.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/activities/cast-effect.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/activities/cast-identity.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/activities/cast-spellbook.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/activities/forward-effect.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f8adcb5

Please sign in to comment.