Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/docking/Dock.h @ 9133

Last change on this file since 9133 was 8706, checked in by dafrick, 13 years ago

Merging presentation branch back into trunk.
There are many new features and also a lot of other changes and bugfixes, if you want to know, digg through the svn log.
Not everything is yet working as it should, but it should be fairly stable. If you habe any bug reports, just send me an email.

  • Property svn:eol-style set to native
File size: 3.9 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 Dock.h
31    @brief Definition of Dock class
32    @ingroup Docking
33*/
34
35#ifndef _Dock_H__
36#define _Dock_H__
37
38#include "DockingPrereqs.h"
39
40#include <set>
41
42#include "core/CoreIncludes.h"
43#include "core/EventIncludes.h"
44#include "core/XMLPort.h"
45
46#include "controllers/HumanController.h"
47
48#include "DockingAnimation.h"
49#include "DockingEffect.h"
50
51#include "worldentities/StaticEntity.h"
52
53namespace orxonox // tolua_export
54{  // tolua_export
55
56    class _DockingExport Dock  // tolua_export
57        : public StaticEntity
58    { // tolua_export
59        public:
60            Dock(BaseObject* creator);
61            virtual ~Dock();
62
63            // Trigger interface
64            bool execute(bool bTriggered, BaseObject* trigger);
65
66            // XML interface
67            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
68            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
69
70            // XML functions
71            bool addEffect(DockingEffect* effect); //!< Add a DockingEffect to the Dock.
72            const DockingEffect* getEffect(unsigned int index) const; //!< Get the DockingEffect at a given index.
73            bool addAnimation(DockingAnimation* animation); //!< Add a DockingAnimation to the Dock.
74            const DockingAnimation* getAnimation(unsigned int index) const; //!< Get the DockingAnimation at a given index.
75
76            // Docking/undocking logic, checks conditions and invokes the DockingAnimations
77            bool dock(PlayerInfo* player); //!< Returns true if given player docked successfully (player must be a candidate)
78            bool undock(PlayerInfo* player); //!< Undocks a player (player must be docked)
79
80            // Animation logic
81            bool dockingAnimationFinished(PlayerInfo* player); //!< Called when a docking animation finished
82            bool undockingAnimationFinished(PlayerInfo* player); //!< Called when a undocking animation finished
83
84            // LUA interface
85            // tolua_begin
86            void dock()
87                { this->dock(HumanController::getLocalControllerSingleton()->getPlayer()); }
88            static unsigned int getNumberOfActiveDocks();
89            static Dock* getActiveDockAtIndex(unsigned int index);
90            // tolua_end
91
92            // Console commands
93            static void cmdDock();
94            static void cmdUndock();
95
96            // Network functions
97            void showDockingDialogHelper(PlayerInfo* player);
98            static void showDockingDialog();
99
100        private:
101            std::set<PlayerInfo*> candidates_; //!< A set of all players which are allowed to dock using the console command.
102            std::set<PlayerInfo*> docked_; //!< A set of all docked players
103
104            std::list<DockingEffect*> effects_; //!< The list of DockingEffects to be executed when a player docks.
105            std::list<DockingAnimation*> animations_; //!< The list of DockingAnimations to be executed before a player docks
106    }; // tolua_export
107} // tolua_export
108
109#endif /* _Dock_H__ */
Note: See TracBrowser for help on using the repository browser.