forked from Vauryx/advancedspelleffects
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.bak
136 lines (110 loc) · 6.78 KB
/
README.bak
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# Advanced Spell Effects
## Usage Instructions
Spell effects can be called from a macro generally using the command:
```javascript
game.AdvancedSpellEffects.spellName(options)
```
"options" should be an object structured like this:
{version: "Version Name", arguments...}
### Possible versions are:
* "MIDI"
* "ItemMacro"
The arguments will depend on the spell and version you are using.
## Currently available spells
The currently available spells, their versions and how to call them are outlined below.
There is a compendium that includes MIDI versions of the spells pre-configured called "Advanced Spell Effects - MIDI Spells".
Each of the provided macro calls should be palced in the item's ItemMacro field regardless of whether the MIDI or Item Macro Only version is benig used.
List of currently avaiable spells:
### Darkness:
- In both cases for this spell, make sure to remove the range/target from the spell and to use "Utility/Other" for the "Action Type"
#### *MIDI*
```javascript
let options = {version: "MIDI", args: args};
game.AdvancedSpellEffects.darkness(options);
```
#### *Item Macro*
```javascript
let options = {version: "ItemMacro", itemId: item.id, tokenId: token.id};
game.AdvancedSpellEffects.darkness(options);
```
https://user-images.githubusercontent.com/32877348/134225849-22115c32-5a6e-47d5-93aa-5c429d3ee9a5.mp4
### Detect Magic:
- In both cases for this spell, make sure to remove the range/target from the spell and to use "Utility/Other" for the "Action Type"
- This spell uses the Tagger module to determine what is magical. Set the 'magical' tag on anything you want the spell to ping. Further Customization can be done by adding a magical school tag as well as a color tag.
- An optional 'waveColor' and 'auraColor' property can be set for the options object that can change the color of the wave/aura of detect magic respectively.
#### *MIDI*
```javascript
let options = {version: "MIDI", args: args, waveColor: "blue", auraColor: "blue"};
game.AdvancedSpellEffects.detectMagic(options);
```
#### *Item Macro*
```javascript
let options = {version: "ItemMacro", itemId: item.id, tokenId: token.id, waveColor: "blue", auraColor: "blue"};
game.AdvancedSpellEffects.detectMagic(options);
```
https://user-images.githubusercontent.com/32877348/134227634-627435b0-0c0b-4899-9125-5ee373aae4da.mp4
### Fog Cloud:
- Make sure to remove the range/target from the spell and to use "Utility/Other" for the "Action Type"
- "numberWalls" is how many walls to place down *per spell level*. This means that at 12, the spell will place 12 walls for a fog wall cast at 1st level. and 24 for one cast at second level. 12 is recommended, minimum 6 should be used.
#### *MIDI*
```javascript
let options = {version: "MIDI", args: args, "numberWalls": 12};
game.AdvancedSpellEffects.fogCloud(options);
```
https://user-images.githubusercontent.com/32877348/134228908-1d833634-2571-46ac-83aa-4373508612dd.mp4
### Steel Wind Strike:
- Make sure to remove the range/target from the spell and to use "Utility/Other" for the "Action Type"
- Also make sure to remove any damage forumla on the spell as the spell will roll an attack and damage for target as it goes through them.
- A "weapon" and "color" option must be set in the options object for this spell.
- The available weapon options are:
###### "sword","mace","greataxe","greatsword","handaxe","spear","dagger"
- The available colors are any colors for the selected weapon in the JB2A library.
#### *MIDI*
```javascript
let options = {version: "MIDI", args: args, weapon: "weapon", color: "color"};
game.AdvancedSpellEffects.steelWindStrike(options);
```
https://user-images.githubusercontent.com/32877348/134230307-a0d0ba98-59be-46bd-81ae-8e043db8166c.mp4
### Thunder Step:
- Make sure to remove the range/target from the spell and to use "Utility/Other" for the "Action Type"
- Also make sure to remove any damage forumla on the spell as the spell will roll an attack and damage for target as it goes through them.
#### *MIDI*
```javascript
let options = {version: "MIDI", args: args};
game.AdvancedSpellEffects.thunderStep(options);
```
https://user-images.githubusercontent.com/32877348/134231083-7f34c364-fa93-4e13-aaba-20c2bea9a925.mp4
### Call Lightning:
- Make sure to remove the range/target from the spell and to use "Utility/Other" for the "Action Type"
- Also make sure to remove any damage forumla on the spell as the spell will roll an attack and damage for target as it goes through them.
- An additional optional parameter 'boltStyle' can be set to change the lightning bolt effect.
- Possible bolt versions are
#### "chain", "strike"
#### *MIDI*
```javascript
let options = {version: "MIDI", args: args, boltStyle: "chain"};
game.AdvancedSpellEffects.callLightning(options);
```
https://user-images.githubusercontent.com/32877348/134980507-710b9c41-cf61-40f1-ab46-c725cdffa0dc.mp4
https://user-images.githubusercontent.com/32877348/134980564-7df4b15f-0f07-4086-85ff-024cff34d202.mp4
### Spiritual Weapon
- Make sure to remove the range/target from the spell and to use "Utility/Other" for the "Action Type"
- Also make sure to remove any damage forumla on the spell as the attack itself will be made through the summoned token
- Make sure to configre an actor in the game world like shown below - make sure the actor has an ability set up as a melee spell attack like shown as well
#### MIDI
```javascript
let options = {version: "MIDI", args: args, type: "Spiritual Weapon"};
game.AdvancedSpellEffects.summon(options);
```
https://user-images.githubusercontent.com/32877348/134981937-bdb3b361-d5e3-48f6-abce-4ccf6f8d141e.mp4
##### Contributions -
Special thanks to siliconsaint for contributing his spiritual weapon macro for this module