Changeset 8700 for code/branches/presentation/src/modules/docking/Dock.h

Timestamp:

Jun 6, 2011, 8:15:38 AM (13 years ago)

Author:

dafrick

Message:

Adherence to styleguide.

File:

• code/branches/presentation/src/modules/docking/Dock.h (modified) (1 diff)

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

@@ -55 +55 @@
         : public StaticEntity
     { // tolua_export
-    public:
-        Dock(BaseObject* creator);
-        virtual ~Dock();
+        public:
+            Dock(BaseObject* creator);
+            virtual ~Dock();
 
-        // Trigger interface
-        bool execute(bool bTriggered, BaseObject* trigger);
+            // 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);
+            // XML interface
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
 
-        // 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.
+            // 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)
+            // 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
+            // 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
+            // LUA interface
+            // tolua_begin
+            void dock()
+                { this->dock(HumanController::getLocalControllerSingleton()->getPlayer()); }
+            static unsigned int getNumberOfActiveDocks();
+            static Dock* getActiveDockAtIndex(unsigned int index);
+            // tolua_end
 
-        // Console commands
-        static void cmdDock();
-        static void cmdUndock();
+            // Console commands
+            static void cmdDock();
+            static void cmdUndock();
 
-    private:
-        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
+        private:
+            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
+            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