Page Updated:   2024-05-07

This is about a Roll20 feature exclusive to Pro-subscribers (and often to players in a Game created by a Pro-subscriber). If you'd like to use this feature, consider upgrading your account.

This is related to Roll20 Mods, which require Pro info from the game's creator. (formerly known as API "Scripts") Main Page: Mod:Use Guide

This article is a stub. You can help the Roll20 Community Wiki by expanding it.

The Mod Scripts Major Update 2024 was a large update to Mod Scripts sprearheaded by The Aaron, giving more access for mods to different parts of Roll20, along with improving their performance.

Access

1. Go to a game's "Mod Script"-page, and scroll down until you see API Sandbox Version( or "Mod Sandbox Version"), and a dropdown menu.
2. Switch it from "Default" to "Experimental".

See these comments for additional info on the experimental version.

Features

full list of changes^(Forum)

Summary of the changes:

• Better Mod Output Console messages
  • Whenever possible, output messages will now list one or more context objects.
• jQuery access
  • Mods can now access it via $20, like it's used in character sheets
• Functions:
  • new function: toAbove(obj,target), toBelow(obj,target) (to place object just above/below other object)
  • faster: toFront(obj), toBack(obj)
  • updated: findObjs(properties, options)
  • bugfix: spawnFxBetweenPoints(point1, point2, type, pageid)
• Objects:
  • Individual Roll20 Objects now have more capabilities.
  • now support a property of .type, similar to existing .id.
  • new objects: pageFolder
  • objects with new properties and/or new functions: campaign, page, graphic, character, handout, card, rollabletable, path, text

Links

• Roll20 Mod Scripts Set for Major Improvements in March^(Blog) - short summary - Feb 22, 2024
• Major Updates to Mod Scripts Coming in March^(Forum) - full details on changes - Feb 26th, 2024

Category:Feature(Beta)