Renamed 'ship-simu' to 'shipsimu' + added 'core' and symlink to core/inc
[shipsimu.git] / application / shipsimu / templates / game / building / base_building.xml
diff --git a/application/shipsimu/templates/game/building/base_building.xml b/application/shipsimu/templates/game/building/base_building.xml
new file mode 100644 (file)
index 0000000..0949690
--- /dev/null
@@ -0,0 +1,169 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+A general building template.
+
+@author                Roland Haeder <webmaster@ship-simu.org>
+@version       0.0.0
+@copyright     Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
+@license       GNU GPL 3.0 or any newer version
+@link          http://www.ship-simu.org
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>
+//-->
+<building>
+       <!-- General building data //-->
+       <building-data>
+               <!-- Estimated dimensions of the building. //-->
+               <estimated-dimensions>
+                       <!-- Width of the building. //-->
+                       <width>{?width?}</width>
+                       <!-- Height of the building. //-->
+                       <height>{?height?}</height>
+                       <!-- Length of the building. //-->
+                       <length>{?length?}</length>
+               </estimated-dimensions>
+               <!--A summary for this building. //-->
+               <summary>
+                       <![CDATA[{?summary?}]]>
+               </summary>
+               <!-- A full description of this building. //-->
+               <description>
+                       <![CDATA[{?description?}]]>
+               </description>
+               <!-- General data, like short name, type, level and many more. //-->
+               <building-data>
+                       <id>{?id?}</id>
+                       <name>{?name?}</name>
+                       <type>{?type?}</type>
+                       <level>{?level?}</level>
+                       <max-floors>{?max_floors?}</max-floors>
+                       <!-- The owner of this building. //-->
+                       <owner id="{?owner_id?}" type="{?owner_type?}" owned-start="{?owner_start_timestamp?}" owned-end="{?owner_end_timestamp?}" />
+                       <!-- The occupant of this building. //-->
+                       <occupant id="{?occupant_id?}" type="{?occupant_type?}" owned-start="{?occupant_start_timestamp?}" owned-end="{?occupant_end_timestamp?}" />
+                       <!-- When this building was constructed. //-->
+                       <constructed>
+                               <!-- When construction has started. //-->
+                               <construction-started timestamp="{?construction_start_timestamp?}" />
+                               <!-- And when it was finished. //-->
+                               <construction-finished timestamp="{?construction_end_timestamp?}" />
+                       </constructed>
+                       <!-- When this building was destructed. //-->
+                       <destructed>
+                               <!-- When destruction has started. //-->
+                               <destruction-started timestamp="{?destruction_start_timestamp?}" />
+                               <!-- And when it was finished. //-->
+                               <destruction-finished timestamp="{?destruction_end_timestamp?}" />
+                               <!-- A short reason why this building must be destructed or
+                                    demolished. //-->
+                               <destruction-reason>
+                                       <![CDATA[{?destruction_reason?}]]>
+                               </destruction-reason>
+                       </deconstructed>
+               </building-data>
+       </building-data>
+       <!-- All sorts of costs for a building. //-->
+       <costs>
+               <!-- The land-price has to be payed to the simplified government. //-->
+               <land-price currency="{?land_currency?}" />
+               <!-- Construction costs may be empty when this building is bougth from
+                    an other user e.g. a broker //-->
+               <construction-costs>
+                       <currency>{?construction_currency?}</currency>
+                       <construction-company extends="{?construction_template?}">
+                               <!-- The construction company. //-->
+                               <company>
+                                       <company-id>{?construct_id?}</company-id>
+                                       <!-- A construction of a building requires personel. We
+                                            summary their salery here for simplicy. //-->
+                                       <personel-costs currency="{?personel_currency?}" />
+                                       <!-- A lot resources like steel and concrete are required
+                                            for new high buildings. Some older or futuristic may
+                                            require different resources. //-->
+                                       <resource-list extends="{?resources_template?}">
+                                               <!-- A single resource and its amount to construct this
+                                                    building. //-->
+                                               <resource>
+                                                       <resource-id>{?resource_id?}</resource-id>
+                                                       <amount>{?resource_amount?}</amount>
+                                                       <!-- The merchant dealing with this resource. //-->
+                                                       <resource-merchant extends="{?merchant_template?}">
+                                                               <merchant id="{?merchant_id?}" />
+                                                       </resource-merchant>
+                                               </resource>
+                                       </resource-list>
+                               </company>
+                               <!-- The construction contract for constructing this building. //-->
+                               <construction-contract extends="{?contract_template?}">
+                                       <construction-contract id="{?construct_contract_id?}" />
+                               </construction-contract>
+                       </construction-company>
+               </construction-costs>
+               <!-- Running costs are all costs that the owner/occupant has to pay for upkeeping
+                    it like house cleaning. simplified repair costs and in some way
+                    taxes. //-->
+               <running-costs>
+                       <!-- Taxes for the occupied lot. //-->
+                       <taxes currency="{?taxes_currency?}" />
+                       <!-- A building has mostly maintenance costs. //-->
+                       <maintenance>
+                               <!-- Almost all buildings needs to be cleaned. //-->
+                               <cleaning-costs>
+                                       <currency>{?cleaning_currency?}</currency>
+                                       <!-- The cleaning company. //-->
+                                       <cleaning-company id="{?cleaning_id?}" />
+                                       <!-- The contract for cleaning this building. //-->
+                                       <cleaning-contract contract_id="{?cleaning_contract_id?}" />
+                               </cleaning-costs>
+                               <repair-costs>
+                                       <currency>{?repair_currency?}</currency>
+                                       <repair contract_id="{?repair_contract_id?}" />
+                               </repair-costs>
+                       </maintenance>
+               </running-costs>
+               <!-- For constructing a building you sometimes need to take mortgage to
+                    fund the construction costs. //-->
+               <mortgage>
+                       <currency>{?mortgage_currency?}</currency>
+                       <!-- The bank paying the mortage, if not provided, the following
+                            mortage broker must be provided. //-->
+                       <bank id="{?bank_id?}" />
+                       <!-- A mortage broker who has payed the mortage. //-->
+                       <mortgage-broker id="{?broker_id?}" />
+                       <!-- The contract behind the mortage. //-->
+                       <contract id="{?mortage_id?}" />
+               </mortgage>
+       </costs>
+       <!-- We also have technology denpencies for a building. These must be
+            understand by construction companies who made contracts with the
+            shipping company to construct this building. //-->
+       <dependencies>
+               <!-- A list of required technology to construct this building. //-->
+               <technology-dependency-list technology-dependency-count="{?technology_dependency_count?}">
+                       <!-- A single required technology to construct this building. //-->
+                       <technology-dependency>
+                               <technology-id>{?technology_id?}</technology-id>
+                               <technology-name>{?technology_name?}</technology-name>
+                               <technology-type>{?technology_type?}</technology-type>
+                               <technology-level>{?technology_level?}</technology-level>
+                       </technology-dependency>
+               </technology-dependency-list>
+       </dependencies>
+       <!-- A list of floors this building has. //-->
+       <floor-list floor-count="{?floor_count?}">
+               <!-- A single floor where we can add rooms to. //-->
+               <floor>
+               </floor>
+       </floor-list>
+</building>