Changeset 8493 for code/branches/dockingsystem2/src/modules/docking/Dock.h

Timestamp:

May 16, 2011, 6:21:05 PM (14 years ago)

Author:

sven

Message:

Added docking animations, skeletton for DockingController..

File:

• code/branches/dockingsystem2/src/modules/docking/Dock.h (modified) (3 diffs)

code/branches/dockingsystem2/src/modules/docking/Dock.h

@@ -46 +46 @@
 
 #include "DockingEffect.h"
+#include "DockingAnimation.h"
 #include "DockingPrereqs.h"
 
@@ -58 +59 @@
         virtual ~Dock();
 
+        // Trigger interface
+        bool execute(bool bTriggered, BaseObject* trigger);
+
+        // XML interface
         virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
         virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
 
-        bool execute(bool bTriggered, BaseObject* trigger);
-
+        // XML functions
         bool addEffect(DockingEffect* effect); //!< Add a DockingEffect to the Dock.
         const DockingEffect* getEffect(unsigned int index) const; //!< Get the DockingEffect at a given index.
+        bool addAnimation(DockingAnimation* animation); //!< Add a DockingAnimation to the Dock.
+        const DockingAnimation* getAnimation(unsigned int index) const; //!< Get the DockingAnimation at a given index.
 
+        // Docking/undocking logic, checks conditions and invokes the DockingAnimations
         bool dock(PlayerInfo* player); //!< Returns true if given player docked successfully (player must be a candidate)
         bool undock(PlayerInfo* player); //!< Undocks a player (player must be docked)
 
+        // Animation logic
+        bool dockingAnimationFinished(PlayerInfo* player); //!< Called when a docking animation finished
+        bool undockingAnimationFinished(PlayerInfo* player); //!< Called when a undocking animation finished
+
+        // LUA interface
         void dock() { this->dock(HumanController::getLocalControllerSingleton()->getPlayer()); } // tolua_export
         static unsigned int getNumberOfActiveDocks(); // tolua_export
         static Dock* getActiveDockAtIndex(unsigned int index); // tolua_export
 
+        // Console commands
         static void cmdDock();
         static void cmdUndock();
@@ -79 +92 @@
         std::set<PlayerInfo*> candidates; //!< A set of all players which are allowed to dock using the console command.
         std::set<PlayerInfo*> docked; //!< A set of all docked players
+
         std::list<DockingEffect*> effects; //!< The list of DockingEffects to be executed when a player docks.
+        std::list<DockingAnimation*> animations; //!< The list of DockingAnimations to be executed before a player docks
     }; // tolua_export
 } // tolua_export