Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/weapons/weaponmodes/HsW01.h @ 9017

Last change on this file since 9017 was 8855, checked in by dafrick, 13 years ago

Cleaning up game immersion. Roughly documenting weapons module.

  • Property svn:eol-style set to native
File size: 2.5 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 *      Hagen Seifert
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file HsW01.h
31    @brief Definition of the HsW01 class.
32*/
33
34#ifndef _HsW01_H__
35#define _HsW01_H__
36
37#include "weapons/WeaponsPrereqs.h"
38
39#include "tools/Timer.h"
40#include "weaponsystem/WeaponMode.h"
41
42namespace orxonox
43{
44
45    /**
46    @brief
47        Shoots laser beams.
48    @author
49        Hagen Seifert
50    @ingroup WeaponsWeaponModes
51    */
52    class _WeaponsExport HsW01 : public WeaponMode
53    {
54        public:
55            HsW01(BaseObject* creator);
56            virtual ~HsW01();
57
58            virtual void fire();
59            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
60
61        private:
62            /**
63            @brief Set the material.
64            @param material The material name.
65            */
66            void setMaterial(const std::string& material)
67                { this->material_ = material; }
68            /**
69            @brief Get the material.
70            @return Returns the material name.
71            */
72            const std::string& getMaterial() const
73                { return this->material_; }
74
75            void setDelay(float delay);
76            /**
77            @brief Get the firing delay.
78            @return Returns the firing delay in seconds.
79            */
80            float getDelay() const
81                { return this->delay_; }
82
83            void shot();
84            void muzzleflash();
85
86            std::string material_; //!< The material.
87            float speed_; //!< The speed of the fired projectile.
88            float delay_; //!< The firing delay.
89            Timer delayTimer_; //!< A timer to delay the firing.
90    };
91}
92
93#endif /* _HsW01_H__ */
Note: See TracBrowser for help on using the repository browser.