Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/docking/DockingEffect.h @ 12209

Last change on this file since 12209 was 11099, checked in by muemart, 9 years ago

Fix loads of doxygen warnings and other documentation issues

  • Property svn:eol-style set to native
File size: 2.1 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 *      Sven Stucki
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file DockingEffect.h
31    @brief Definition of the DockingEffect class.
32    @ingroup Docking
33*/
34
35#ifndef _DockingEffect_H__
36#define _DockingEffect_H__
37
38#include "core/XMLPort.h"
39
40#include "infos/PlayerInfo.h"
41
42#include "DockingPrereqs.h"
43#include "DockingTarget.h"
44
45#include <list>
46#include "core/BaseObject.h"
47
48namespace orxonox
49{
50
51    /**
52    @brief
53        Handles DockingEffects for @ref orxonox::Dock "Docks".
54
55    @author
56        Sven Stucki
57
58    @ingroup Docking
59    */
60    class _DockingExport DockingEffect : public BaseObject
61    {
62        public:
63            DockingEffect(Context* context);
64            virtual ~DockingEffect();
65
66            virtual bool docking(PlayerInfo* player) = 0; //!< Called when player docked
67            virtual bool release(PlayerInfo* player) = 0; //!< Called when player wants to undock
68
69            static bool invokeEffect(bool dock, PlayerInfo* player, std::list<DockingEffect*> & effects); //!< Invokes the event specific method of all DockingEffects in the list
70            static DockingTarget *findTarget(std::string name); //!< Iterates through all DockingTarget objects to find the one with name=target
71    };
72
73}
74
75#endif /* _DockingEffect_H__ */
Note: See TracBrowser for help on using the repository browser.