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
m (api navbar)
m (1223200 moved page API:Gobalconfig to Mod:Gobalconfig)
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
{{apibox}}
+
{{revdate}}{{apibox}}
== API - globalconfig ==
+
== Mod - globalconfig ==
 
{{stub}}
 
{{stub}}
  
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 {{c|globalconfig}} variable is available for use in Mod/API scripts and it is related to the {{c|state}} variable. Unlike {{c|state}}, {{c|globalconfig}} does not persist and gets reset anytime the [[Mod Sandbox|sandbox]] restarts.  
  
`globalconfig` contains key/value properties of 1-click user options.
+
{{c|globalconfig}} contains key/value properties of 1-click user options.
  
 
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:
* https://app.roll20.net/forum/post/3162220/slug%7D
+
* {{fpl|3162220 New API config system}} March 2016
* https://app.roll20.net/forum/post/3289777/slug%7D
+
* {{fpl|3289777 API one-click useroptions}} April 2016
* https://app.roll20.net/forum/post/4019465/slug%7D
+
* {{fpl|4019465 [Help][Script] How do I test 'one click' scripts?}} Sep. 2017
  
[[Category:API]]
+
[[Category:API Development]]

Latest revision as of 08:08, 9 June 2024

[edit] Mod - globalconfig


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: