Changes between Version 1 and Version 2 of Exposed_ConfigDB_Functions

Timestamp:

Sep 29, 2013, 7:48:37 PM (11 years ago)

Author:

Yves

Comment:

Changes according to #2172

Exposed_ConfigDB_Functions

@@ -1 @@
-The Javascript API is accessible via the g_ConfigDB global JS object. The three namespaces '''system''', '''mod''' and '''user''' exist as properties of the g_ConfigDB global object. Config variables can therefore be modified/accessed using eg '''g_ConfigDB.system!["sound.mastergain"]'''. Each namespace exports a couple of functions.
+The Javascript API is accessible via global functions.
+You call them like Engine.ConfigDB_FunctionName().
 
-== setFile ==
- * useVFS: true if the path is to be interpreted as a VFS path, false if it's a real FS path
- * path: the path
- * Returns nothing
+For example
+{{{
+Engine.ConfigDB_CreateValue("user", "sound.mastergain", 0.8);
+}}}
+
+== !CreateValue ==
+ * configNamespace: One of "default", "system", "user" or "mod"
+ * valueName: The name of the value to create or change
+ * value: The value to set
+ * Returns true if successful
+
+Create or change a value in the given configuration context.
+
+== !GetValue ==
+ * configNamespace: One of "default", "system", "user" or "mod"
+ * valueName: The name of the value to get
+ * Returns the value
+
+Gets a value from the given configuration context.
+
+== !SetFile ==
+ * configNamespace: One of "default", "system", "user" or "mod"
+ * path: the VFS path to the file
+ * Returns true if successful
 
 Set the file name to be used by the configuration namespace. Note that this doesn't automatically reload configuration values.
 
-== reload ==
- * No arguments
+== Reload ==
+ * configNamespace: One of "default", "system", "user" or "mod"
  * Returns true if successful
 
-Reload configuration from the file last set by setFile. Deletes all config values previously set, when successful. If an error occurs, the configuration is unchanged
+Reload configuration from the file last set by setFile for the given configuration namespace. Deletes all config values previously set, when successful. If an error occurs, the configuration is unchanged
 
-== writeFile ==
- * useVFS: true if the path is to be interpreted as a VFS path, false if it's a real FS path
- * path: the path
+== !WriteFile ==
+ * configNamespace: One of "default", "system", "user" or "mod"
+ * path: the VFS path to the file
  * Returns true if successful