Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "API:Gobalconfig"

From Roll20 Wiki

Jump to: navigation, search
m (api navbar)
m
Line 9: Line 9:
 
Here's a code example from the `StatusFx` script:
 
Here's a code example from the `StatusFx` script:
  
```
+
<pre data-language="javascript" style="overflow:auto;">
 
  // Get the FX configurations from the useroptions.
 
  // Get the FX configurations from the useroptions.
 
   var useroptions = (globalconfig &&  
 
   var useroptions = (globalconfig &&  
 
       (globalconfig.StatusFX || globalconfig.statusfx)) ||
 
       (globalconfig.StatusFX || globalconfig.statusfx)) ||
 
       { 'red': 'splatter-blood [1,-1]', 'green': 'bubbling-acid', 'custom': 'sleep: glow-holy|stars: beam-fire [2,3]', 'interval': 500};
 
       { 'red': 'splatter-blood [1,-1]', 'green': 'bubbling-acid', 'custom': 'sleep: glow-holy|stars: beam-fire [2,3]', 'interval': 500};
```
+
</pre>
  
 
More info in the forums:
 
More info in the forums:

Revision as of 20:00, 25 March 2021

API - globalconfig


The `globalconfig` variable is available for use in 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: