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 "Mod:Gobalconfig"

From Roll20 Wiki

Jump to: navigation, search
(move page here from old one.)
 
m (api navbar)
Line 1: Line 1:
 +
{{apibox}}
 
== API - globalconfig ==
 
== API - globalconfig ==
 
+
{{stub}}
'''''This is a stub and is incomplete.'''''
+
  
 
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.  
 
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.  
Line 17: Line 17:
  
 
More info in the forums:
 
More info in the forums:
[https://app.roll20.net/forum/post/3162220/slug%7D]
+
* https://app.roll20.net/forum/post/3162220/slug%7D
[https://app.roll20.net/forum/post/3289777/slug%7D]
+
* https://app.roll20.net/forum/post/3289777/slug%7D
[https://app.roll20.net/forum/post/4019465/slug%7D]
+
* https://app.roll20.net/forum/post/4019465/slug%7D
  
 
[[Category:API]]
 
[[Category:API]]

Revision as of 19:58, 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: