5160727e4d53c77471c450abfc1245cca7c439bb
[shipsimu.git] / application / ship-simu / templates / game / ship / base_ship.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!--
3 A general ship template.
4
5 @author         Roland Haeder <webmaster@ship-simu.org>
6 @version        0.0.0
7 @copyright      Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
8 @license        GNU GPL 3.0 or any newer version
9 @link           http://www.ship-simu.org
10
11 This program is free software: you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation, either version 3 of the License, or
14 (at your option) any later version.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>
23 //-->
24 <ship>
25         <!-- Some general data about this ship. Some may not be required for the
26              simulation at the moment. //-->
27         <general-data>
28                 <id>{?id?}</id>
29                 <name><![CDATA[{?name?}]]></name>
30                 <type>{?type?}</type>
31                 <ship-propeller>{?propeller?}</ship-propeller>
32                 <total-weight>{?weight?}</total-weight>
33                 <total-displacement>{?displacement?}</total-displacement>
34                 <!-- Some data about the construction phase, like company, contract. //-->
35                 <construction>
36                         <!-- The construction company of this ship. //-->
37                         <construction-company>{?construction_id?}</construction-company>
38                         <!-- The signed construction contract for this ship. //-->
39                         <construction-contract>{?construction_contract_id?}</construction-contract>
40                         <!-- When the construction has started. //-->
41                         <construction-started>{?construction_started?}</construction-started>
42                         <!-- And when the ship was constructed. //-->
43                         <construction-finished>{?construction_finished?</construction-finished>
44                 </construction>
45         </general-data>
46         <!-- A list of shipping companies who owned this ship. //-->
47         <shipping-company-list>
48                 <!-- A single company who owned this ship for a tme span. //-->
49                 <shipping-company>
50                         <id>{?company_id?}</id>
51                         <!-- A time span when the company owned this ship. //-->
52                         <holder-timespan>
53                                 <started>{?holder_started?}</started>
54                                 <ended>{?holder_ended?}</ended>
55                         </hoolder-timespan>
56                         <!-- A contract signed for changing ownership. //-->
57                         <contract id="{?contract_id?}" />
58                 </shipping-company>
59         </shipping-company-list>
60         <!-- A list of structures to build this ship. If you need more than of a
61              structure type just specify the neccessary amount. //-->
62         <ship-structure-list>
63                 <!-- A single ship structure. This can be anything from the wheel house
64                      to theatre or little ships, decks and cabins. //-->
65                 <ship-structure extends="{?structure_template?}">
66                         <id>{?structure_id?}</id>
67                         <amount>{?structure_amount?}</amount>
68                         <type>{?structure_type?}</type>
69                 </ship-structure>
70         </ship-structure-list>
71         <!-- All ships require an engine, even when or 'engine' is a sail, to move
72              around. //-->
73         <engine extends="{?engine_template?}">
74                 <id>{?engine_id?{</id>
75                 <type>{?engine_type?}</type>
76         </engine>
77         <!-- A list of what this ship transportates. //-->
78         <transportation-list>
79                 <!-- @TODO This section is not complete. //-->
80         </transportation-list>
81         <!-- A ship may require one or more of these system to operate. //-->
82         <ship-systems>
83                 <!-- The electric system of latest ships has becom the most important
84                      on a ship. It powers all other systems and provides electrical
85                      power to all kind of commercials and cabins including interior and
86                      exterior lights. So you should be adviced to provide emergency
87                      systems and redudancy for this system. //-->
88                 <electric-system>
89                         <!-- @TODO This section is not complete. //-->
90                 </electric-system>
91                 <!-- On latest ships you require to have a hydric system to operate
92                      heavy bulkheads which seperates sections on low-level decks. On
93                      passenger ships the hydraulic system have to operate front and/or
94                      rear doors to let drive vehicles in. //-->
95                 <hydraulic-system>
96                         <!-- @TODO This section is not complete. //-->
97                 </hydraulic-system>
98                 <!-- Nearly all ships will have a navigation system. //-->
99                 <navigation-system>
100                         <!-- @TODO This section is not complete. //-->
101                 </navigation-system>
102                 <!-- A guidance system which every ship should have... //-->
103                 <guidance-system>
104                         <!-- @TODO This section is not complete. //-->
105                 </guidance-system>
106                 <!-- A fire reporting and fighting system. //-->
107                 <fire-system>
108                         <!-- @TODO This section is not complete. //-->
109                 </fire-system>
110         </ship-systems>
111         <!-- Ships depend on several technologies and maybe research proposals. //-->
112         <dependencies>
113                 <!-- A list of technology dependencies for this ship. //-->
114                 <technology-dependency-list>
115                         <!-- A single technology dependencies for this ship. //-->
116                         <technology-dependency>
117                                 <id>{?technology_id?}</id>
118                                 <name>{?technology_name?}</name>
119                                 <level>{?technology_level?}</level>
120                         </technology-dependency>
121                 </technology-dependency-list>
122                 <!-- A list of research proposals dependencies for this ship. //-->
123                 <research-dependency-list>
124                         <!-- A single research proposals  dependencies for this ship. //-->
125                         <research-dependency>
126                                 <id>{?research_id?}</id>
127                                 <name>{?research_name?}</name>
128                                 <level>{?research_level?}</level>
129                         </research-dependency>
130                 </research-dependency-list>
131         </dependencies>
132 </ship>