Page Updated:   2024-06-09

Mod - globalconfig

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

The globalconfig variable is available for use in Mod/API scripts and it is related to the state variable. Unlike state, globalconfig does not persist and gets reset anytime the sandbox restarts.

globalconfig contains key/value properties of 1-click user options.

Here's a code example from the `StatusFx` script:

 // Get the FX configurations from the useroptions.
   var useroptions = (globalconfig && 
       (globalconfig.StatusFX || globalconfig.statusfx)) ||
       { 'red': 'splatter-blood [1,-1]', 'green': 'bubbling-acid', 'custom': 'sleep: glow-holy|stars: beam-fire [2,3]', 'interval': 500};

More info in the forums:

• New API config system^(Forum) March 2016
• API one-click useroptions^(Forum) April 2016
• [Help[Script] How do I test 'one click' scripts?]^(Forum) Sep. 2017