https://github.com/christopher-r-perkins/fabulaeffect
https://github.com/christopher-r-perkins/fabulaeffect
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/christopher-r-perkins/fabulaeffect
- Owner: Christopher-R-Perkins
- License: gpl-3.0
- Created: 2024-08-09T19:29:05.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-17T20:26:23.000Z (almost 2 years ago)
- Last Synced: 2025-03-03T08:45:02.140Z (over 1 year ago)
- Language: TypeScript
- Size: 824 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fabula Effect
This module is intended to extend the Effect formulas for the [Project FU](https://github.com/League-of-Fabulous-Developers/FoundryVTT-Fabula-Ultima) Foundry System. It requires libWrapper to function.
## Effect Subroutines
This module adds subroutines to value formulas. This allows you to reference values not directly associated with the item or actor the effect is attached to. This allows you to apply more complicated formulas.
To reference a subroutine in a effect value use this format:
```
$[arg1, arg2, arg3, ...]
```
For example, if you want to apply extra damage to your Volcano Spell at lvl 20 and lvl 40 as described in the corebook, your effect might look like this:
| Attribute Key | Change Mode | Effect Value | Apply Effect to Actor |
| ------------------------------ | ----------- | -------------------- | --------------------- |
| `system.rollInfo.damage.value` | `Add` | `$levelBonus[5, 10]` | Unchecked |
Formula subroutines are invoked and replaced before any other actions occur. They are invoked from left to right. Please note that formula subroutines cannot currently be nested.
### List of Subroutines
#### actorLevel
```
$actorLevel[id?]
```
The `actorLevel` subroutine returns the level of an actor and has one optional parameter `id?` which is the id of the actor you wish to retrieve the level of. If you are applying an effect directly to the actor whose level you want retrieve, just use `@system.level.value`. This is intended to be used on items that require the actors level they are attached to or to be attached to another actor.
If getting the level of an actor this effect is not attached to(an item used by the actor), this will not automatically update the effect when that actors level changes. You can update the actor manually by changing any value on the sheet, or reload.
**Core Rules This Applies To:**
- Faithful Companion (though its already integrated manually, this could be set up for automatic)
- 🤷
#### levelBonus
```
$levelBonus[lvl20Bonus, lvl40Bonus]
```
The `levelBonus` subroutine has two parameters `lvl20Bonus` and `lvl40Bonus`. The `lvl40Bonus` is returned when the character the item is attached to is level 40 or above. The `lvl20Bonus` is returned when the character the item is attached to is between level 20 and 39. `0` is returned when the character the items is attached to is under level 20.
**Core Rules This Applies To:**
- Dismissing an Arcanum (Extra damage)
- Alchemy with damage (Extra damage)
- Comet Heroic Skill (Extra damage)
- Extra HP Heroic Skill (Extra HP)
- Extra MP Heroic Skill (Extra MP)
- Powerful Shot Heroic Skill (Extra Damage)
- Powerful Spell Heroic Skill (Extra Damage)
- Powerful Strike Heroic Skill (Extra Damage)
- Volcano Heroic Skill (Extra Damage)
#### skillLevel
```
$skillLevel[skillName, actorId?]
```
The `skillLevel` subroutine returns the skill level value for `skillName` skill on the actor related to the effect (Either what its attached to or the parent of what it is attached to). `skillName` is case sensitive and requires spaces as needed. To get the Guardian skill **Defensive Mastery**'s level you would use `$skillLevel[Defensive Mastery]`.
If `actorId?` is present, uses the actor with `actorId` instead if it exists. This will not automatically update the effect when the specified actor does if the item is not attached, to force an update change any field on the attached actor or reload.
**Core Rules This Applies To:**
- Emergency Arcanum (reduces MP cost of summoned arcana - would be put on some summon spell item with base cost 40 mp...)
- Twin Sheilds (Extra damage)
- Companion (though its already integrated manually, this could be set up for automatic)
- Deep Pockets Heroic Skill (Less Inventory Points on items)
- Heroic Companion (Can act as a toggle for the extra HP)
#### classLevel
```
$classLevel[className, actorId?]
```
The `classLevel` subroutine returns the class level value for `className` class on the actor related to the effect (Either what its attached to or the parent of what it is attached to). `className` is case sensitive and requires spaces as needed. To get the Guardian class level you would use `$classLevel[Guardian]`.
If `actorId?` is present, uses the actor with `actorId` instead if it exists. This will not automatically update the effect when the specified actor does if the item is not attached, to force an update change any field on the attached actor or reload.
**Core Rules This Applies To:**
- 🤷
#### classesLevel
```
$classesLevel[actorId?]
```
The `classesLevel` subroutine returns the total combined level of all classes on the actor related to the effect (Either what its attached to or the parent of what it is attached to).
If `actorId?` is present, uses the actor with `actorId` instead if it exists. This will not automatically update the effect when the specified actor does if the item is not attached, to force an update change any field on the attached actor or reload.
**Core Rules This Applies To:**
- 🤷
#### totalClasses
```
$totalClasses[actorId?]
```
The `totalClasses` subroutine returns the total number of classes of the actor related to the effect. To create the item **Onion Ring**'s effect you would use `2*$totalClasses[]`.
If `actorId?` is present, uses the actor with `actorId` instead if it exists. This will not automatically update the effect when the specified actor does if the item is not attached, to force an update change any field on the attached actor or reload.
**Core Rules This Applies To:**
- Onion Ring