Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/towerdefenseFabien/src/modules/weapons/weaponmodes/SplitGun.h @ 10594

Last change on this file since 10594 was 10594, checked in by fvultier, 5 years ago

improved documentation

File size: 2.8 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabien Vultier
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file SplitGun.h
31    @brief Definition of the SplitGun class.
32*/
33
34#ifndef _SplitGun_H__
35#define _SplitGun_H__
36
37#include "weapons/WeaponsPrereqs.h"
38#include "weaponsystem/WeaponMode.h"
39
40namespace orxonox
41{
42
43    /**
44    @brief
45        A slow ball of lightning.
46    @author
47        Fabien Vultier
48    @ingroup WeaponsWeaponModes
49    */
50    class _WeaponsExport SplitGun : public WeaponMode
51    {
52        public:
53            SplitGun(Context* context);
54            virtual ~SplitGun();
55
56            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
57            virtual void fire();
58
59            inline void setNumberOfSplits(int numberOfSplits)
60                { this->numberOfSplits_ = numberOfSplits; }
61            inline int getNumberOfSplits() const
62                { return this->numberOfSplits_; }
63            inline void setNumberOfChilds(int numberOfChilds)
64                { this->numberOfChilds_ = numberOfChilds; }
65            inline int getNumberOfChilds() const
66                { return this->numberOfChilds_; }
67            inline void setSplitTime(float splitTime)
68                { this->splitTime_ = splitTime; }
69            inline float getSplitTime() const
70                { return this->splitTime_; }
71            inline void setSpread(float spread)
72                { this->spread_ = spread; }
73            inline float getSpread() const
74                { return this->spread_; }
75
76       private:
77            float speed_; //The speed of the fired projectile.
78            int numberOfSplits_; //The number of times the projectile will split into child projectiles
79            int numberOfChilds_; //The number of child projectiles that are created if the projectile splits
80            float splitTime_; //The time between creation of the projectile and the split of the projectile
81            float spread_; //Low spread means that the child projectiles are concentrated in a small area
82    };
83}
84
85#endif /* _SplitGun_H__ */
Note: See TracBrowser for help on using the repository browser.