Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/docking/DockToShip.h @ 11071

Last change on this file since 11071 was 11071, checked in by landauf, 8 years ago

merged branch cpp11_v3 back to trunk

  • Property svn:eol-style set to native
File size: 2.0 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 DockToShip.h
31    @brief DockingEffect which transfers control from spaceship to docked ship ASDF
32    @ingroup Docking
33*/
34
35#ifndef _DockToShip_H__
36#define _DockToShip_H__
37
38#include "DockingPrereqs.h"
39#include "DockToShip.h"
40
41#include "worldentities/ControllableEntity.h"
42
43
44namespace orxonox
45{
46
47    /**
48    @brief
49        Allows players to dock onto a ship
50
51    @author
52        Sven Stucki
53
54    @ingroup Docking
55    */
56    class _DockingExport DockToShip : public DockingEffect
57    {
58        public:
59            DockToShip(Context* context);
60            virtual ~DockToShip();
61
62            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;
63            void setTargetId(const std::string& str);
64            const std::string& getTargetId() const;
65
66            virtual bool docking(PlayerInfo* player) override; //!< Called when docking starts
67            virtual bool release(PlayerInfo* player) override; //!< Called when player wants undock
68        private:
69            std::string target_;
70    };
71
72}
73
74#endif /* _DockToShip_H__ */
Note: See TracBrowser for help on using the repository browser.