Difference between revisions of "Mod Scripts Major Update 2024"
From Roll20 Wiki
Andreas J. (Talk | contribs) (Page for big update) |
Andreas J. (Talk | contribs) m |
||
(2 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
{{revdate}} | {{revdate}} | ||
{{pro only}} | {{pro only}} | ||
− | {{mod}}{{stub}} | + | {{mod}}{{stub}}{{beta}} |
{{apibox}} | {{apibox}} | ||
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. | 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. | ||
− | + | <br> | |
The update was made available as opt-in on a per-game basis on April 25th.{{source|https://app.roll20.net/forum/permalink/11877142/}} | The update was made available as opt-in on a per-game basis on April 25th.{{source|https://app.roll20.net/forum/permalink/11877142/}} | ||
− | + | ==Access== | |
# 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. | # 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. | ||
# Switch it from "Default" to "Experimental". | # Switch it from "Default" to "Experimental". | ||
See [https://app.roll20.net/forum/permalink/11877142/ these comments] for additional info on the experimental version. | See [https://app.roll20.net/forum/permalink/11877142/ these comments] for additional info on the experimental version. | ||
+ | |||
+ | ==Features== | ||
+ | {{fpl|11810153/ full list of changes}} | ||
+ | |||
+ | 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 {{c|$20}}, like it's used in [[character sheets]] | ||
+ | * [[API:Function_documentation|Functions]]: | ||
+ | ** new function: {{c|toAbove(obj,target)}}, {{c|toBelow(obj,target)}} (to place object just above/below other object) | ||
+ | ** faster: {{c|toFront(obj)}}, {{c|toBack(obj)}} | ||
+ | ** updated: {{c|findObjs(properties, options)}} | ||
+ | ** bugfix: spawnFxBetweenPoints(point1, point2, type, pageid) | ||
+ | * [[API:Objects|Objects]]: | ||
+ | ** Individual Roll20 Objects now have more capabilities. | ||
+ | ** now support a property of {{c|.type}}, similar to existing {{c|.id}}. | ||
+ | ** new objects: {{c|pageFolder}} | ||
+ | ** objects with new properties and/or new functions: {{c|campaign}}, {{c|page}}, {{c|graphic}}, {{c|character}}, {{c|handout}}, {{c|card}}, {{c|rollabletable}}, {{c|path}}, {{c|text}} | ||
==Links== | ==Links== |
Latest revision as of 10:40, 7 May 2024
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. |
Beta⚗️ This feature is in Early Access, available users as opt-in. |
Roll20 Mod
Use Mods
- Use & Install
- Mod:Script Index & Suggestions
- Short Community Scripts
- Meta Scripts
- User Documentation
- Mod Scripts(Forum)
- Mod Update 2024🆕
- Macro Guide
Mod Development
Reference
- Objects
- Events
- Chat Events & Functions
- Utility Functions
- Function
- Roll20 object
- Token Markers
- Sandbox Model
- Debugging
Cookbook
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.
[edit] Access
- 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.
- Switch it from "Default" to "Experimental".
See these comments for additional info on the experimental version.
[edit] 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
- Mods can now access it via
- 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)
- new function:
- 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
[edit] 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