Advertisement Create a free account

[Script] PageFX

1460820217

Edited 1538057406
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
This script allows GMs to create atmospheric effects for their maps. With it, you can produce immersive environments with bubbling magma, torrential rain, sparking electronic corridors, etc. Just create a PageFX object to set up the effect and its area, and the script will begin automatically creating the fx for you. It even supports multiple PageFX objects on a single map. v1.2: * Support for beam-like saved custom FX. * You can specify random directions for beam-like FX by putting "random" for the bar 2 value. v1.1: The script now supports custom FX and the ability for users to specify NullFX areas where PageFX won't spawn in. Demo: v1.2 Now available on One-Click Roadmap: Support rectangular spawn tokens. Support rotated spawn tokens.
1460834599
Gold
Forum Champion
Thanks for putting this together. I plan to try it once it arrives in the community API repository.   Does this combine a token with the animated special FX of Roll20? Asking because in the graphic demo it looks like you might be using one of Gabriel's fire tokens (from the right side Library) and adding some of the moving special-effects, and being able to configure the FX settings in the Edit Token stats because of the way this script works.
1460840557

Edited 1460840582
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
Yes, it uses a token to specify the FX, their area, and their other parameters. In the demo, they are placed on the GM layer so that the tokens themselves and their auras are not visible to the players, but the players will see the FX that they are generating.
1460840985
The Aaron
Forum Champion
API Scripter
That is pretty neat. =D
1460845402
Are there any dependencies? it crashed the API on my game as soon as I saved it. "Unexpected Token"
1460845676

Edited 1460846647
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
No, this script has no dependencies. Is anyone else getting this error on start-up?
Its very neat, too bad I can't use it for say, Mists and such, I can use this however for buffs and torch effects :)
1460907200

Edited 1460907211
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
Once the API for producing custom effects rolls out onto the production servers in a couple weeks, I will be updating the script to allow custom effects. Then you will be able to produce effects for mists and such. ;)
1460983414

Edited 1461025532
The Aaron
Forum Champion
API Scripter
al e. said: Are there any dependencies? it crashed the API on my game as soon as I saved it. "Unexpected Token" Are you using this on the Dev server or a Production server?  Can you post the full error message?
1460983431
Ravenknight
KS Backer
This is awesome! Great work!
1461024831
The Aaron said: al e. said: Are there any dependencies? it crashed the API on my game as soon as I saved it. "Unexpected Token" ARe you using this on the Dev server or a Production server?  Can you post the full error message? Production server, I will reinstall and see if there is more. When I tried it I only got "unexpected token".
1461025519
The Aaron
Forum Champion
API Scripter
Ok. &nbsp;This feature is still on Dev for the time being. &nbsp;Riley mentioned an estimated timeline of a week or two before it reaches production. &nbsp;Here's the original topic:&nbsp; <a href="https://app.roll20.net/forum/permalink/3242097/" rel="nofollow">https://app.roll20.net/forum/permalink/3242097/</a>
1461077057
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
The Aaron said: Ok. &nbsp;This feature is still on Dev for the time being. &nbsp;Riley mentioned an estimated timeline of a week or two before it reaches production. &nbsp;Here's the original topic:&nbsp; <a href="https://app.roll20.net/forum/permalink/3242097/" rel="nofollow">https://app.roll20.net/forum/permalink/3242097/</a> Yes, I will enable support for this feature in the script once it becomes available on the Production servers.
One request for this script, is a method to turn them off? Since I had to delete the token in question to fully turn it off :&lt;
1461528801
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
Yes. Just set the PageFX token with the "interdiction" status marker. (The one that looks like this: <a href="http://game-icons.net/lorc/originals/interdiction.html" rel="nofollow">http://game-icons.net/lorc/originals/interdiction.html</a>)
Ah! Alright! Derp, thanks sweet. :)
I have another partial request for this, if that is possible. Can "PageFX" be apart of the GMnotes instead of a tokens name? I like to use the special effects on players to represent bless, and haste etc in my 5E game but id rather not have to use a carry token script to make it work? Is this at all feasible?
1461936387
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
I had plans to use the GM notes for setting up custom FX defintions once that feature becomes stable on production. I could allow "PageFX" to alternatively be specified in one of the unused bar fields though.
Ah yes that would be a good temporary solution. &nbsp;Thanks. I think I'm able to do that myself... shouldnt be too hard find the reference in the script.
1462289802
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
Update: v1.1 is now available. This update allows custom FX and NullFX areas.
1466546365
Is anyone else having an issue with this script in that the FX token will get stuck with a fire effect no matter what is listed for it? ie, Trying to setup a token to show a Explosion-Fire effect, but instead all it will do is a Burn-Fire effect. Tried to change it to a water effect, but it still gives the Burn-Fire effect. Even tried removing all effects from it, and still the same thing. This has happen with a number tokens, fought with it for a wile, and was able to get a water effect to go with one token, but the rest still give only the Burn effect. No errors are being thrown, but the resaults are wrong.
1466547850

Edited 1466548127
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
Explosion-fire doesn't work. You have to use explode-fire. Explode-fire is the canonical name. I'll see about converting alternate names to their canonical names in the next update.&nbsp; For now, all the canonical built-in FX names are listed here:&nbsp;<a href="https://wiki.roll20.net/Custom_FX" rel="nofollow">https://wiki.roll20.net/Custom_FX</a>
1466623378
Stephen L. said: Explosion-fire doesn't work. You have to use explode-fire. Explode-fire is the canonical name. I'll see about converting alternate names to their canonical names in the next update.&nbsp; For now, all the canonical built-in FX names are listed here:&nbsp; <a href="https://wiki.roll20.net/Custom_FX" rel="nofollow">https://wiki.roll20.net/Custom_FX</a> Okay I got it to work, but something to note, what is listed in the GM Notes for the token is case sensitive, in that it requires it to be written in all lower case. If you use cap's it will ignore what you have there and do it's own thing. This ends up being an intense Burn-Fire effect that makes the correct one look like a candle.
1466781100

Edited 1466792538
Stephen L.
Pro
Marketplace Creator
Sheet Author
API Scripter
I'm aware of that issue too. That'll also be fixed in the next update. Edit: This is now fixed in PageFX 1.2. <a href="https://github.com/Cazra/roll20-api-scripts/blob/StatusFX/PageFX/1.2/PageFX.js" rel="nofollow">https://github.com/Cazra/roll20-api-scripts/blob/StatusFX/PageFX/1.2/PageFX.js</a> In 1.2, you can also specify "random" for the bar2 value to make beam-like FX be fired in a random direction.