Updated to document the new 3d positional tags that are available for

[flightgear.git] / docs-mini / README.xmlsound

diff --git a/docs-mini/README.xmlsound b/docs-mini/README.xmlsound
index 165197768c9b7d07725024e11dd715a5ea3e0a1e..9307d64ef52045d0e119336faf59227e66d7d059 100644 (file)
--- a/docs-mini/README.xmlsound
+++ b/docs-mini/README.xmlsound
@@ -166,8 +166,6 @@ Configuration description:
        dt_play:        the number of seconds since the sound started playing.
 
        dt_stop:        the number of seconds after the sound has stopped.
-
-       random:         a random number between 0.0 and 1.0
  
      <type>
        Defines the function that should be used upon the property
@@ -211,6 +209,31 @@ Configuration description:
        This is usefull if sounds gets to loud. Anything higher will be
        truncated to this value.
 
+   <position>
+        Specify the position of the sounds source relative to the
+        pilot's ears.  The coordinate system used is a right hand
+        coordinate system where -X = left, +X = right, -Y = down, +Y =
+        up, -Z = forward, +Z = aft.  Distances are in meters.
+
+     <x>
+        X dimension offset
+
+     <y>
+        Y dimension offset
+
+     <z>
+        Z dimension offset
+
+   <reference-dist>
+        Set a reference distance of sound in meters.  This is the
+        distance where the gain/volume will be halved.  This can be
+        useful for limiting cockpit sounds to the cockpit.
+
+   <max-dist>
+        Set the maximum audible distance for the sound in meters.
+        This can be useful for limiting cockpit sounds to the cockpit.
+
+
 Creating a configrationfile:
 ---------------------------