Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/dockingsystem2/src/modules/docking/Dock.h @ 8946

Last change on this file since 8946 was 8493, checked in by sven, 14 years ago

Added docking animations, skeletton for DockingController..

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