New API Keys

1622747119

Edited 1622747539

Roll20 Team

Permalink Quote

Hello API developers and enthusiasts! We have a number of exciting updates to the API for you to go over. These additional keys have been long requested: Token Bar Location - ‘bar_location’ Bar Styling - ‘compact_bar’ Page   Play on Load - ‘jukeboxtrigger’ For Updated Dynamic Lighting, we have added support for the following: Token Light Multiplier - ‘light_sensitivity_multiplier’, Night Vision Effect - ‘night_vision_effect’ The following two keys are the same from the Legacy Lighting API but we thought it was worth mentioning again:  Page Update on Token Drop - ‘lightupdatedrop‘ GM Darkness Opacity - ‘fog_opacity’ And we made a lot of under the hood changes to UDL over the past few months so tokens should be able to update their light renders without the need to restart the page or use the key we added a few months back. So this is a notice that we will be deprecating the key ‘force_lighting_refresh’ in the upcoming months.. We’ve updated all of our Help Center articles to reflect these changes, so you can use those pages for reference. Cheers!

1622747481

Forum Champion

Marketplace Creator

API Scripter

Permalink Quote

That is awesome and very welcome news!

1622747872

Roll20 Production Team

API Scripter

Permalink Quote

The token properties are now supported in TokenMod!   <a href="https://app.roll20.net/forum/post/4225825/script-update-tokenmod-an-interface-to-adjusting-properties-of-a-token-from-a-macro-or-the-chat-area/?pageforid=10136003#post-10136003" rel="nofollow">https://app.roll20.net/forum/post/4225825/script-update-tokenmod-an-interface-to-adjusting-properties-of-a-token-from-a-macro-or-the-chat-area/?pageforid=10136003#post-10136003</a> Also of note, the setdefaulttokens() API function now preserves all the above settings.

1622748517

Forum Champion

Sheet Author

API Scripter

Compendium Curator

Permalink Quote

Woot! looking forward to using this!

1622749915

Forum Champion

Permalink Quote

Looking forward to using the API scripts that make use of this (For starters, I make regular use of TokenMod to configure Monster Tokens and PC tokens according to my standard desired settings, being able to switch a whole group of monster tokens to Compact Bar, Underneath & Overlapping style, will be great.) Thanks Roll20 & those who script Community API Scripts, snippits & the one-click.

1622751078

Pro

API Scripter

Permalink Quote

Particularly excited about the bar location and style! Thank you!

1622752404

Pro

Permalink Quote

Thank you! It looks like my suggestion can be closed!

1622892695

Permalink Quote

Super :) When do we get api access to the style/placement of the token bubbles? :)

1623250609

Permalink Quote

Really, REALLY happy to see all of these but especially the light_sensitivity_multiplier! I have a neat lighting effect combining low light sensitivity and night vision that makes for great temporary obscured vision (like thick fog). Using between 1-10% sensitivity with 15/15 light sources gives them a minor halo effect (like it's piercing the fog) but the rest of the area stays obscured. It makes navigating easier for the player as they can keep a point of reference but can still blindly bump into walls and other obstacles. I was going to have to either set this by hand each time for each token or keep a second set of player tokens ready on the gm layer and switch out, but now I can add this to the API command that makes all the other changes and finish it out. Thanks guys! Looking forward to using it in the next session this week!

1623251435

Roll20 Production Team

API Scripter

Permalink Quote

That sounds like a cool project!  One thing to be aware of: light sensitivity is computed for the full view of a player, so if they have one token with 15% and one with 100%, the view will be as if all of them have 15%.   Also, there's a minor bug right now where if you remove a token with a light sensitivity setting, it doesn't recalculate the sensitivity multiplier.  you need to either set it back to 100% before deleting it, refresh the page, or set a different value on another token (or set it and set it back).

1623252802

Edited 1623252981

Permalink Quote

Thanks for the heads up! I'll definitely keep that second one in mind. But yeah, I've noticed a few quirks like that since I test with a dummy account that has vision through all the player's tokens. In practice though, each player only uses one each and I've been using force_lighting_refresh as a precaution for the time being. Hopefully that's enough to satisfy the pink kraken. :-) The only thing left to complete the illusion would be the ability to change the page's darkness color, like you can the background. Shifting it to white or a light gray would sell the "fog" feeling much more. But I won't get greedy, and be happy with this. :-D

1623253278

Edited 1623253350

Roll20 Production Team

API Scripter

Permalink Quote

force_lighting_refresh doesn't actually do anything now, and probably will get removed as a property.  (Corey posted that somewhere, I think.  Edit: Here ) You could create a Path object and fill it with a transparent color like #ffffff99 to "white out" the scene.  Just put it on the map layer sized for the area to affect and pulled to the front.

1623254445

Edited 1623254966

Permalink Quote

You can display paths over "darkness"? The only trick I know for doing something like that is giving the player control over a token and granting it vision to trick Roll20 into rendering it over everything else but use with a 0deg range, so it can't actually see (actually I think you're the one that suggested that to me a while back, it helped a lot! :-D) But then you have to use the object layer for vision to count and end up with the awkward situation where they can accidently select and move it. It works fine for temporary things that quickly get removed anyways (like message boxes or spell effects), but I learned not to use it for anything meant to be more permanent, like map decorations. Edit: Also, holy crap! I never knew you could add alpha values to the colors. That... opens a lot of doors for me... :-D

1623255795

Forum Champion

Sheet Author

Translator

Permalink Quote

updated the references on the wiki, where all the api keys are on a single page: <a href="https://wiki.roll20.net/API:Objects" rel="nofollow">https://wiki.roll20.net/API:Objects</a>

1623257784

Forum Champion

Marketplace Creator

API Scripter

Permalink Quote

Andreas J. said: updated the references on the wiki, where all the api keys are on a single page: <a href="https://wiki.roll20.net/API:Objects" rel="nofollow">https://wiki.roll20.net/API:Objects</a> Thank you!

1623274879

Pro

API Scripter

Permalink Quote

The token properties are now also supported in Fetch, making them available in the chat input line of any other script. Usage parameters here: <a href="https://app.roll20.net/forum/permalink/10151776/" rel="nofollow">https://app.roll20.net/forum/permalink/10151776/</a>

1624075269

Pro

API Scripter

Permalink Quote

The Aaron said: force_lighting_refresh doesn't actually do anything now, and probably will get removed as a property.  (Corey posted that somewhere, I think.  Edit: Here ) You could create a Path object and fill it with a transparent color like #ffffff99 to "white out" the scene.  Just put it on the map layer sized for the area to affect and pulled to the front. I have a partially working version of just such a thing...  <a href="https://app.roll20.net/forum/post/9631549/slug%7D" rel="nofollow">https://app.roll20.net/forum/post/9631549/slug%7D</a>

1624204976

Plus

Permalink Quote

Can the turn tracker window be given the option of being moved as an independent window - outside the map window?

1624216530

Forum Champion

Marketplace Creator

API Scripter

Permalink Quote

Not to my knowledge, though you can double click on the header to minimize it.

1627080885

Roll20 Team

Permalink Quote

Hi All,  Wanted to follow up and mention two things that affect the API from the release this week: The first was the introduction of the ' lightColor ' key. This Graphic key will allow a color to be added to bright and dim light for a token. It takes strings with hex color codes like "#0000FF".  The second  change we unshackled the dynamic lighting keys that were primarily only updating through controlled tokens. This means on object creation and updating values on the fly for lighting should just work in many cases. We have a few more key to fold in as David M. mentioned in the main bug thread here  like the directional and bright light keys. So we'll keep you posted when we get those addressed.  Have a good weekend!

1632145427

Forum Champion

Sheet Author

Translator

Permalink Quote

The Sept. 8th changelog mentions: Added Pro API support for removed cards. Is this a new function or a bugfix to existing stuff? Was the documentation update? I see several API pages where edited Sept.1st...

1632240192

Roll20 Team

Permalink Quote

Hi @Andreas J.  There were some new keys added to the 'deck' objects Key Default Value removedcardsmode 'choosefronts' removedcards 'none' And related we also added to the 'card' object Key Default Value is_removed false The is_removed flag marks them as "removed" which makes them not get recalled in the deck or show up in the discard pile, instead they show up in a "Removed Cards" section Andreas J. said: The Sept. 8th changelog mentions: Added Pro API support for removed cards. Is this a new function or a bugfix to existing stuff? Was the documentation update? I see several API pages where edited Sept.1st...

1632479220

Permalink Quote

That's nice thanks.

1632755735

Forum Champion

Sheet Author

Translator

Permalink Quote

September 1, 2021 You can now change the the brightness of Dynamic Lighting Daylight Mode  Adjust Dynamic Lighting Daylight Mode brightness with the Pro API What's the key & values for this?

1632758505

Forum Champion

Marketplace Creator

API Scripter

Permalink Quote

daylightModeOpacity, with a value from 0 to 1. per this thread .

1632760496

Forum Champion

Sheet Author

Translator

Permalink Quote

lol missed that I've already added it to the docs

1633837453

Permalink Quote

Thank you, that's amazing :D

1639506363

Forum Champion

Sheet Author

Translator

Permalink Quote

(comment to avoid thread being archived)

1640623874

Permalink Quote

Hey, hi everybody ! \o Someone can tell me how long PowerCards will stay OFF plz?

1640626739

Edited 1640626747

Forum Champion

Marketplace Creator

API Scripter

Permalink Quote

This is a thread about new API keys being added to the API library. PowerCard questions should be posted in the PowerCards Feedback thread . Note: You may be interested in investigating ScriptCards , its "spiritual successor".

1646246676

Roll20 Team

Permalink Quote

Hi Scripters, Moments ago we added a new key to give you the ability to lock a Graphic object in place. The feature can be found in the context menu when selecting a token/map on the VTT. Key Value lockMovement Boolean Warm Regards, Corey J

1646257806

Forum Champion

Marketplace Creator

API Scripter

Permalink Quote

Thanks Corey!

1646283432

Permalink Quote

How long before Tokenmod gets this is the real question!

1646285439

Forum Champion

Marketplace Creator

API Scripter

Permalink Quote

The Aaron added it today. You can grab it at his git for a manual install, or wait till next Tuesday for the weekly merge. Details are in the Great Big TokenMod Thread.

1646290114

Pro

Permalink Quote

Corey J. said: Hi Scripters, Moments ago we added a new key to give you the ability to lock a Graphic object in place. The feature can be found in the context menu when selecting a token/map on the VTT. Key Value lockMovement Boolean Warm Regards, Corey J This is a great addition! Thank you! If I could make another suggestion - this would be a great action to have as a hotkey, and my suggestion would be for it to be tied to the '.' key (as in period), so for the regular hotkey it would toggle on a ' Ctrl/Cmd+. ', and for the advanced hotkey it would be ' l . '

1646290149

Pro

Sheet Author

API Scripter

Permalink Quote

DM Eddie said: How long before Tokenmod gets this is the real question! And of course, it's added before anyone even asks about it. Aaron works fast!

1646290214

Pro

Sheet Author

API Scripter

Permalink Quote

Jarren said: Corey J. said: Hi Scripters, Moments ago we added a new key to give you the ability to lock a Graphic object in place. The feature can be found in the context menu when selecting a token/map on the VTT. Key Value lockMovement Boolean Warm Regards, Corey J This is a great addition! Thank you! If I could make another suggestion - this would be a great action to have as a hotkey, and my suggestion would be for it to be tied to the '.' key (as in period), so for the regular hotkey it would toggle on a ' Ctrl/Cmd+. ', and for the advanced hotkey it would be ' l . ' I agree, I've had quite a few problems lately with nudging things out of alignment and it is a feature that should be very accessible IMO.

1649889354

Roll20 Team

Permalink Quote

Hey Folx, With One way Dynamic Lighting lines out for use the API has also been updated. Lighting Lines now have a barrierType option that defaults to 'wall'. And if 'oneWay' is used as a value the key oneWayReversed is helpful in changing the direction the arrows are facing.  Key Value barrierType 'oneWay' or 'wall' oneWayReversed false or true Warm Regards, Corey J

1649892368

Roll20 Production Team

API Scripter

Permalink Quote

Nice!

1650327379

Permalink Quote

God I wish I was smart enough to do this stuff! 

1650378337

Roll20 Production Team

API Scripter

Permalink Quote

The Kingsley said: God I wish I was smart enough to do this stuff!  What would you write if you had the time and requisite knowledge already?

1650819822

Edited 1650820389

Hultz (Keeper of Secrets)

Pro

Permalink Quote

1) Most immediately I would write a script to lookup in a lookup table an image and then show it to the players. When the image is clicked on it would then post some text to chat. Specifically I would like to do a 5e Deck Of Many Things. When the table is rolled on it would show the graphic and when the graphic is clicked on it would show the text as per the DMG in the chat. I have tried to get the text into the tool-tip portion of a card deck but it won't take all of the text for some of the cards, (you, the Aaron, have touched on this in a recent Post). 2) Another script I would like is to somehow have a macro attached to a language in the skills section of the character sheet. The macro would whisper to all players that understand the given language language. 3) I would like to figure out how to send images directly to chat in a format that is large enough to see. Right now if I use a roll table with images in it they do show up in chat but they are so tiny I cant see really them.

1657485162

Permalink Quote

Ooo That'd be nice. bar locations can be a pain and a setting, if i'm reading this correctly, would be very nice.

1657485498

Permalink Quote

3) I would like to figure out how to send images directly to chat in a format that is large enough to see. Right now if I use a roll table with images in it they do show up in chat but they are so tiny I cant see really them. Actually, I make images in the library that I show the players... but It'd be nice to be able to display it to just one player.. the person who drew it and then the other players would have to venture a guess as to what happened to the player.lol...  But otherwise, I would lvove to see your suggestion too. :)

1657665218

Pro

Permalink Quote

Did this do something with token actions? because I don't see the token actions when I click on any of the tokens in any of my games now.

You must Login to your Roll20 Account to post a reply.