Changes between Version 1 and Version 2 of code/howto/ConfigFile

Timestamp:

Oct 8, 2008, 1:49:50 AM (16 years ago)

Author:

landauf

Comment:

—

code/howto/ConfigFile

@@ -1 +1 @@
 = HowTo: Config-File =
 [[TracNav(TracNav/TOC_Development)]]
+[[TOC]]
 
 The config-file is usually located in {{{bin/orxonox.ini}}}.
@@ -55 +56 @@
 }}}
 This will only change the value in all existing instances, but not changing the config-file. Therefore the change will be lost if you restart Orxonox.
+
+== Formatting of special types ==
+Until now we denoted the new value just as ''newvalue''. For primitive types like {{{int}}} or {{{float}}} it's really that easy. But there exist more complex formattings for non-primitive types:
+ * std::string: " my text with trailing spaces "
+  * Put strings into quotes if you don't want trailing spaces to be striped
+
+ * Vector2: (10, 20)
+ * Vector3: (10, 20, 50)
+ * Vector4: (10, 20, 50, 100)
+ * Quaternion: (1, 2, 3, 4)
+ * ColourValue: (0.1, 0.2, 0.3, 1.0)
+
+ * bool: true and false (or just 1 and 0 as usual)
+
+== Comments ==
+It's possible to add comments into the config-file. They will be kept even if the file changes.
+
+Comments are introduces by one of the following symbols:
+ 1. '''#'''comment in script-language style
+ 1. '''%'''comment in matlab style
+ 1. ''';'''comment in unreal tournament config-file style
+ 1. '''//'''comment in code style
+
+== Whitespaces ==
+If you add whitespaces to your config-file, for example like this:
+{{{
+[Sectionname]
+
+varname = value
+}}}
+instead of
+{{{
+[Sectionname]
+varname=value
+}}}
+this will have no effect, but if the file gets saved, Orxonox will strip the whitespaces.