- This is the event separator. The text inside the brackets
- can be anything. Bit it is advised to give it a meaningful name
- like: crank, engine, rumble, gear, squeal, flap, wind or stall
+ This is the event separator. The text inside the brackets
+ can be anything. Bit it is advised to give it a meaningful name
+ like: crank, engine, rumble, gear, squeal, flap, wind or stall
- The value can be defined multiple times, thus anything which is
- related may have the same name (grouping them together).
+ The value can be defined multiple times, thus anything which is
+ related may have the same name (grouping them together).
- This defines the name of the event. This name is used internally
- and, although it can me defined multiple times in the same file,
- should normally have an unique value.
+ This defines the name of the event. This name is used internally
+ and, although it can me defined multiple times in the same file,
+ should normally have an unique value.
- Multiple definitions of the same name will allow multiple sections
- to interfere in the starting and stopping of the sample.
-
- This method can't be used to control the pitch or volume of the
- sample, but instead multiple volume or pitch section should be
- included inside the same event.
-
- The types "raise" and "fall" will stop the playback of the sample
- regardless of any other event. This means that when the type "raise"
- is supplied, sample playback will stop when the event turns false.
- Using the type "fall" will stop playback when the event turns true.
-
- IMPORTANT:
- If the trigger is used for anything else but stopping the sound
- at a certain event, all sections with the same name *should* have
- exactly the same sections for everything but property and type.
-
- In the case of just stopping the sample at a certain event, the
- sections for path, volume and pitch may be omitted.
-
+ Multiple definitions of the same name will allow multiple sections
+ to interfere in the starting and stopping of the sample.
+
+ This method can't be used to control the pitch or volume of the
+ sample, but instead multiple volume or pitch section should be
+ included inside the same event.
+
+ The types "raise" and "fall" will stop the playback of the sample
+ regardless of any other event. This means that when the type "raise"
+ is supplied, sample playback will stop when the event turns false.
+ Using the type "fall" will stop playback when the event turns true.
+
+ IMPORTANT:
+ If the trigger is used for anything else but stopping the sound
+ at a certain event, all sections with the same name *should* have
+ exactly the same sections for everything but property and type.
+
+ In the case of just stopping the sample at a certain event, the
+ sections for path, volume and pitch may be omitted.
+
- This defined th path to the sound file. The path is relative to the
- FlightGear root directory but could be specified absolute.
+ This defined th path to the sound file. The path is relative to the
+ FlightGear root directory but could be specified absolute.
- Define a condition that triggers the event.
- For a complete description of the FlightGear conditions,
- please read docs-mini/README.conditions
+ Define a condition that triggers the event.
+ For a complete description of the FlightGear conditions,
+ please read docs-mini/README.conditions
- Define which property triggers the event, and refers to a node
- in the FlightGear property tree. Action is taken when the property
- is non zero.
+ Define which property triggers the event, and refers to a node
+ in the FlightGear property tree. Action is taken when the property
+ is non zero.
- looped: the sample plays continuesly,
- until the event turns false.
+ looped: the sample plays continuously,
+ until the event turns false.
- in-transit: the sample plays continuesly,
- while the property is changing its value.
+ in-transit: the sample plays continuously,
+ while the property is changing its value.
- Volume or Pitch definition. Currently there may be up to 5
- volume and up to 5 pitch definitions defined within one sound
- event. Normally all offset values are added together and the
- results after property calculations will be multiplied.
- A special condition occurs when the value of factor is negative,
- in which case the offset doesn't get added to the other offset values
- but instead will be used in the multiplication section.
+ Volume or Pitch definition. Currently there may be up to 5
+ volume and up to 5 pitch definitions defined within one sound
+ event. Normally all offset values are added together and the
+ results after property calculations will be multiplied.
+ A special condition occurs when the value of factor is negative,
+ in which case the offset doesn't get added to the other offset values
+ but instead will be used in the multiplication section.
- Defines which property supplies the value for the calculation.
- Either a <property> or an <internal> should be defined.
- The value is threated as a floating point number.
+ Defines which property supplies the value for the calculation.
+ Either a <property> or an <internal> should be defined.
+ The value is treated as a floating point number.
- Defines which internal variable should be used for the calculation.
- The value is threated as a floating point number.
- The following internals are available at this time:
+ Defines which internal variable should be used for the calculation.
+ The value is treated as a floating point number.
+ The following internals are available at this time:
- Defines the function that should be used upon the property
- before it is used for calculating the net result:
+ Defines the function that should be used upon the property
+ before it is used for calculating the net result:
- ln: convert the absolute property value to a natural
- logarithmic value before scaling it.
- Anything below 1 will return zero.
-
- log: convert the absolute property value to a true
- logarithmic value before scaling it.
- Anything below 1 will return zero.
+ ln: convert the property value to a natural logarithmic
+ value before scaling it. Anything below 1 will return
+ zero.
+
+ log: convert the property value to a true logarithmic
+ value before scaling it. Anything below 1 will return
+ zero.
- Defines the multiplication factor for the property value.
- A special condition is when scale is defined as a negative
- value. In this case the result of |<scale>| * <property) will be
- subtracted from <default>
+ Defines the multiplication factor for the property value.
+ A special condition is when scale is defined as a negative
+ value. In this case the result of |<scale>| * <property) will be
+ subtracted from <default>
- The initial value for this sound. This value is also used as an
- offset value for calculating the end result.
+ The initial value for this sound. This value is also used as an
+ offset value for calculating the end result.
- 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.
+ aircraft center. The coordinate system used is a left hand
+ coordinate system where +Y = left, -Y = right, -Z = down, +Z =
+ up, -X = forward, +X = aft. Distances are in meters.
+ The volume calculation due to distance and orientation of the
+ sounds source ONLY work on mono samples!
Specify the orientation of the sounds source.
The zero vector is default, indicating that a Source is not directional.
Specify the orientation of the sounds source.
The zero vector is default, indicating that a Source is not directional.
To make things easy, there is a default value for most entries to allow a
sane configuration when a certain entry is omitted.
Default values are:
To make things easy, there is a default value for most entries to allow a
sane configuration when a certain entry is omitted.
Default values are: