]> git.mxchange.org Git - flightgear.git/blob - docs-mini/README.submodels
Merge branch 'ehofman/atc-sound' into next
[flightgear.git] / docs-mini / README.submodels
1 <?xml version="1.0"?>
2
3 <!--  Submodels are objects which can be dropped or launched from the user
4       aircraft. The trigger is a boolean property, which you define, which when
5       "true" causes the submodel to be released/launched.
6
7       A submodel will create an AIBallistic object which will follow a ballistic
8       path. By default one submodel will be released when the corresponding 
9       trigger is "true".
10
11       The initial conditions (IC) define the object's starting point (relative
12       to the user aircraft's "reported position"), and its initial speed and
13       direction (relative to the user aircraft).  If you want to release many
14       similar objects with similar IC, then you may use the <repeat>, <delay>
15       and <count> properties to define this.  The allowed properties are:
16
17       <name>         The name of the submodel.
18       <model>        The path to the visual model.
19       <trigger>      The property which will act as the trigger. 
20       <speed>        Initial speed, in feet/sec, relative to user aircraft.
21       <repeat>       Set "true" if you want multiple releases of this submodel.
22       <delay>        Time, in seconds, between repeated releases.
23       <count>        Number of submodels available for multiple release.
24                      -1 defines an unlimited number.
25       <slaved>       Not used yet.
26       <x-offset>     Submodel's initial fore/aft position relative to user
27                      aircraft.   Fore is positive.
28       <y-offset>     Submodel's initial left/right position relative to user
29                      aircraft.   Right is positive.
30       <z-offset>     Submodel's initial up/down position relative to user
31                      aircraft.   Up is positive.
32       <yaw-offset>   Submodel's initial azimuth, in degrees, relative to user
33                      aircraft'snose.   Right is positive.
34       <pitch-offset> Submodel's initial elevation, in degrees, relative to user
35                      aircraft's pitch.    Up is positive.
36       <life>         Life span in seconds.  Default is 900.0.
37       <buoyancy>     In ft/sec/sec.  Works opposite acceleration of gravity.
38                      For example, if set to 32 the submodel will feel no 
39                      gravity. If greater than 32 the object will rise.
40                      Default is 0.
41       <wind>         Set to true if you want the submodel to react to the wind.
42                      Default is "false". 
43           <cd>           The Coeffient of Drag. Varies with submodel shape - 0.295 for a bullet, 
44                          0.045 for an airfoil. Enter an appropriate value. Defaults to 0.295.
45           <eda>          Effective drag area (sq ft). Usually the cross-sectional area of the
46                          submodel normal to the airflow.
47       <weight>       The weight of the submodel (lbs). NOT set to 0 on submodel release.You 
48                          may wish to set this value to 0 by means of key bindings or Nasal script.
49                                          Defaults to 0.25.
50           <contents>     The path to the contents of a submodel. The contents must be in lbs.
51                                          Intended for use with drop tanks. The property value will be set 
52                                          to 0 on release of the submodel: do not also set to 0 elsewhere e.g.
53                                          in key bindings. Defaults to 0.
54 -->  
55  
56 <PropertyList>
57
58   <submodel>
59     <name>left gun</name>
60     <model>Models/Geometry/tracer.ac</model>
61     <trigger>ai/submodels/submodel[0]/trigger</trigger>
62     <speed>2750.0</speed>
63     <repeat>true</repeat>
64     <delay>0.25</delay>
65     <count>100</count>
66     <x-offset>1.0</x-offset>
67     <y-offset>-7.0</y-offset>
68     <z-offset>-2.0</z-offset>
69     <yaw-offset>0.4</yaw-offset>
70     <pitch-offset>1.8</pitch-offset>
71     <life>2.0</life>
72   </submodel>
73
74   <submodel>
75     <name>right gun</name>
76     <model>Models/Geometry/tracer.ac</model>
77     <trigger>ai/submodels/submodel[0]/trigger</trigger>
78     <speed>2750.0</speed>
79     <repeat>true</repeat>
80     <delay>0.25</delay>
81     <count>100</count>
82     <x-offset>1.0</x-offset>
83     <y-offset>7.0</y-offset>
84     <z-offset>-2.0</z-offset>
85     <yaw-offset>-0.4</yaw-offset>
86     <pitch-offset>1.8</pitch-offset>
87     <life>2.0</life>
88   </submodel>
89   
90   <submodel> 
91       <name>droptank-l</name>
92       <model>Aircraft/Hunter/Models/droptank-100gal.ac</model>
93       <trigger>controls/armament/station[0]/jettison-all</trigger>
94       <speed>0</speed>
95       <repeat>false</repeat>
96       <count>1</count>
97       <x-offset>0.820</x-offset>
98       <y-offset>-9.61</y-offset>
99       <z-offset>-2.39</z-offset>
100       <yaw-offset>0</yaw-offset>
101       <pitch-offset>0</pitch-offset>
102       <wind>false</wind>
103       <eda>2.11348887</eda>
104           <weight>170</weight>
105           <cd>0.045</cd>
106           <contents>consumables/fuel/tank[2]/level-lbs</contents>
107     </submodel>
108         
109     <submodel> 
110       <name>droptank-r</name>
111       <model>Aircraft/Hunter/Models/droptank-100gal.ac</model>
112       <trigger>controls/armament/station[1]/jettison-all</trigger>
113       <speed>0</speed>
114       <repeat>false</repeat>
115       <count>1</count>
116       <x-offset>0.820</x-offset>
117       <y-offset>9.61</y-offset>
118       <z-offset>-2.39</z-offset>
119       <yaw-offset>0</yaw-offset>
120       <pitch-offset>0</pitch-offset>
121       <wind>false</wind>
122           <eda>2.11348887</eda>
123           <weight>170</weight>
124           <cd>0.045</cd>
125           <contents>consumables/fuel/tank[3]/level-lbs</contents>
126     </submodel>
127
128 </PropertyList>