Difference between revisions of "Script:KABOOM"
From Roll20 Wiki
Andreas J. (Talk | contribs) m |
Andreas J. (Talk | contribs) (Command example, embedded video) |
||
| Line 5: | Line 5: | ||
|dependencies={{api repository link|PathMath}}, {{api repository link|Vector Math}}, {{api repository link|MatrixMath}} | |dependencies={{api repository link|PathMath}}, {{api repository link|Vector Math}}, {{api repository link|MatrixMath}} | ||
|lastmodified=2017-02-17}} | |lastmodified=2017-02-17}} | ||
| + | {{main|API:Script Index}} | ||
| − | A script that displaces tokens based on their size | + | A script that displaces [[tokens]] based on their size & distance from an explosion or implosion effect. KABOOM is primarily triggered through chat messages, although it also exposes a function so other scripts may use it in automated events, or as a part of some other effect chain. |
| + | |||
| + | ==General== | ||
| + | The basic chat command follows this format: | ||
| + | <pre style="overflow:auto;white-space:pre-wrap;">!KABOOM effect-power [ effect-radius [ options [ --default-options]]] !KABOOM -15 50 no scatter --blood</pre> | ||
| + | {{#evp:youtube|4E-NtcoJt2A|Making Things Explode with the KABOOM! API|right|430}} | ||
| + | Help Command: | ||
| + | <pre style="overflow:auto;white-space:pre-wrap;">!KABOOM --help</pre> | ||
| + | |||
| + | When you use KABOOM as a chat command, you need to have a token selected. ONLY <code>effect-power</code> is required. Everything else is optional. | ||
| + | |||
| + | '''Full documentation: {{repo|Roll20/roll20-api-scripts/blob/master/KABOOM/README.md README.md}}''' | ||
| + | |||
| + | * '''Parameters''' | ||
| + | ** <code>effect-power</code> is the strength of the force moving tokens away or towards from the explosion point. It is measured in the same units listed on the page. Effect-power can be negative if you want to pull things towards the object instead of pushing away. | ||
| + | |||
| + | ** <code>effect-radius</code> is the maximum distance that the script search for objects to manipulate. If something is beyond this point, it will not move. Defaults to effect-power * explosion_ratio. This is always parsed as positive. | ||
| + | |||
| + | ** <code>options</code> are either 'vfx', 'no vfx', 'no-vfx', 'invisible', 'invis' to change whether an explosion effect appears, or 'scatter' and 'no scatter' if you want to scatter tokens away from the explosion/implosion point more randomly. | ||
| − | |||
| − | |||
| − | |||
==See Also== | ==See Also== | ||
* [[API:Script Index]] (partial) list of other APIs | * [[API:Script Index]] (partial) list of other APIs | ||
| + | ** [[Script:It's a Trap]] can be used with KABOOM | ||
<br> | <br> | ||
<br> | <br> | ||
Revision as of 16:26, 20 September 2021
API ScriptAuthor: PaprikaCC
Version: 1.2
Last Modified: 2017-02-17
Code: KABOOM
Dependencies: PathMath, Vector Math, MatrixMath
Conflicts: None
Version: 1.2
Last Modified: 2017-02-17
Code: KABOOM
Dependencies: PathMath, Vector Math, MatrixMath
Conflicts: None
Main Page: API:Script Index
A script that displaces tokens based on their size & distance from an explosion or implosion effect. KABOOM is primarily triggered through chat messages, although it also exposes a function so other scripts may use it in automated events, or as a part of some other effect chain.
General
The basic chat command follows this format:
!KABOOM effect-power [ effect-radius [ options [ --default-options]]] !KABOOM -15 50 no scatter --blood
Making Things Explode with the KABOOM! API
Help Command:
!KABOOM --help
When you use KABOOM as a chat command, you need to have a token selected. ONLY effect-power is required. Everything else is optional.
Full documentation: README.md
- Parameters
-
effect-poweris the strength of the force moving tokens away or towards from the explosion point. It is measured in the same units listed on the page. Effect-power can be negative if you want to pull things towards the object instead of pushing away.
-
-
effect-radiusis the maximum distance that the script search for objects to manipulate. If something is beyond this point, it will not move. Defaults to effect-power * explosion_ratio. This is always parsed as positive.
-
-
optionsare either 'vfx', 'no vfx', 'no-vfx', 'invisible', 'invis' to change whether an explosion effect appears, or 'scatter' and 'no scatter' if you want to scatter tokens away from the explosion/implosion point more randomly.
-
See Also
- API:Script Index (partial) list of other APIs
- Script:It's a Trap can be used with KABOOM
