(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / effectvehicle_func.h
blob5c1d7b99f816e2d6d74d54dfe2f024ffe50146fb
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD 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, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /** @file effectvehicle_func.h Functions related to effect vehicles. */
12 #ifndef EFFECTVEHICLE_FUNC_H
13 #define EFFECTVEHICLE_FUNC_H
15 #include "vehicle_type.h"
17 /** Effect vehicle types */
18 enum EffectVehicleType {
19 EV_CHIMNEY_SMOKE = 0, ///< Smoke of power plant (industry).
20 EV_STEAM_SMOKE = 1, ///< Smoke of steam engines.
21 EV_DIESEL_SMOKE = 2, ///< Smoke of diesel engines.
22 EV_ELECTRIC_SPARK = 3, ///< Sparcs of electric engines.
23 EV_CRASH_SMOKE = 4, ///< Smoke of disasters.
24 EV_EXPLOSION_LARGE = 5, ///< Various explosions.
25 EV_BREAKDOWN_SMOKE = 6, ///< Smoke of broken vehicles except aircraft.
26 EV_EXPLOSION_SMALL = 7, ///< Various explosions.
27 EV_BULLDOZER = 8, ///< Bulldozer at roadworks.
28 EV_BUBBLE = 9, ///< Bubble of bubble generator (industry).
29 EV_BREAKDOWN_SMOKE_AIRCRAFT = 10, ///< Smoke of broken aircraft.
30 EV_COPPER_MINE_SMOKE = 11, ///< Smoke at copper mine.
31 EV_END
34 EffectVehicle *CreateEffectVehicle(int x, int y, int z, EffectVehicleType type);
35 EffectVehicle *CreateEffectVehicleAbove(int x, int y, int z, EffectVehicleType type);
36 EffectVehicle *CreateEffectVehicleRel(const Vehicle *v, int x, int y, int z, EffectVehicleType type);
38 #endif /* EFFECTVEHICLE_FUNC_H */