Roll20 uses cookies to improve your experience on our site. Cookies enable you to enjoy certain features, social sharing functionality, and tailor message and display ads to your interests on our site and others. They also help us understand how our site is being used. By continuing to use our site, you consent to our use of cookies. Update your cookie preferences .
×
Create a free account

Mod (API) Server release - Apr 9th, 2025

1744236576

Edited 1744240720
The Aaron
Roll20 Production Team
API Scripter
Hi all, I've just pushed an update to the Default Mod (API) Server.    Experimental will be receiving the update shortly.   Experimental is now deployed! New Features Foreground layer support has been added!  This includes a flag on the Campaign object for player visibility of the layer, as well as the appropriate settings for each of Graphic, Text, PathV2, and Path objects.  Note  that the Foreground layer is only on Jumpgate, so these properties will be ignored on the Classic VTT. campaign Campaign has one new property. Property Default Note foregroundLayerVisible true When true , players will see objects on the foreground layer.  When false , they will not.  Note: this is a global setting that affects all pages. graphic Graphic has four new properties: Property Default Note fadeOnOverlap true When true , the overlapping of a object layer graphic's inner bound with the foreground layer object will cause its opacity to become the value in fadeOpacity .  When false , it will remain at its set baseOpacity  regardless of overlap. fadeOpacity 0.3 This value dictates the opacity of the object when it is overlapped by a graphic on the object layer, and fadeOnOverlap  is set to true . renderAsScenery false When true , this object will be obscured by dynamic lighting and the Hide/Reveal Mask. baseOpacity 1.0 This value dictates the initial opacity of graphics.  Note: It is active on any layer, not just the Foreground layer. text | path | pathv2 Text, Path, and PathV2 have three new properties.  They are all the same and behave the same: Property Default Note fadeOnOverlap true When  true , the overlapping of a object layer graphic's inner bound with the foreground layer object will cause its opacity to become the value in  fadeOpacity .  When  false , it will remain at its set  baseOpacity  regardless of overlap. fadeOpacity 0.3 This value dictates the opacity of the object when it is overlapped by a graphic on the object layer, and  fadeOnOverlap  is set to  true . renderAsScenery false When  true , this object will be obscured by dynamic lighting and the Hide/Reveal Mask. New Layer Value You can now set the layer to foreground in addition to "map", "objects", "gmlayer", and "walls" with the effect of moving that object to the Foreground Layer. We'll be following pretty quickly with the update to the Experimental API server, but you can start writing scripts against this interface on the Default server right now!  Experimental is now deployed! Please let me know if you experience any issues with the API, or have any questions about the above!   
1744307477
Ulti
Pro
Sheet Author
API Scripter
Excellent!
1744335011
Isabella
Roll20 Production Team
My API since the new release just will not work, I havent changed any settings at all, the second I spin up a new sandbox it just detects a possible infinite loop and shuts down. Not sure what is causing this. My game does use both the 2014 5e sheet and the 2024 5e sheet if that helps with diagnosing this.
1744351183
The Aaron
Roll20 Production Team
API Scripter
Hmm. If you want to PM me an invite and GM me, I can look at your scripts and see what the issue is. 
If we wanted to send something to the foreground layer with token mod, would we be about to do so?
1744487606
The Aaron
Roll20 Production Team
API Scripter
David Gallaher said: If we wanted to send something to the foreground layer with token mod, would we be about to do so? Yup! !token-mod --set layer|foreground
Thank you