PickupManager.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
*/

#ifndef _PickupManager_H__
#define _PickupManager_H__

#include "PickupPrereqs.h"

#include <map>
#include "core/object/WeakPtr.h"

#include "PickupRepresentation.h"

#include "util/Singleton.h"
#include "interfaces/PickupListener.h"

namespace orxonox // tolua_export
{ // tolua_export

    // tolua_begin
    struct PickupInventoryContainer
    {
        uint32_t pickup; 
        bool inUse; 
        bool pickedUp; 
        bool usable; 
        bool unusable; 
        std::string representationName; 
        uint32_t carrierPawnId; 
    };
    // tolua_end

    class _PickupExport PickupManager // tolua_export
        : public Singleton<PickupManager>, public PickupListener
    { // tolua_export
        friend class Singleton<PickupManager>;

        public:
            PickupManager(); 
            virtual ~PickupManager(); 

            static PickupManager& getInstance() { return Singleton<PickupManager>::getInstance(); } // tolua_export

            bool registerRepresentation(const std::string& name, PickupRepresentation* representation);
            bool unregisterRepresentation(const std::string& name);

            PickupRepresentation* getRepresentation(const std::string& name); // tolua_export

            virtual void pickupChangedUsed(Pickupable* pickup, bool used) override; 
            static void pickupChangedUsedNetwork(uint32_t pickup, bool inUse, bool usable, bool unusable); 
            virtual void pickupChangedPickedUp(Pickupable* pickup, bool pickedUp) override; 
            static void pickupChangedPickedUpNetwork(uint32_t pickup, bool usable, const std::string& representationName, bool pickedUp, uint32_t carrierPawnId); 

        // Methods to be used by the PickupInventory.
        public:
            // tolua_begin
            int getNumPickups(void); 

            const orxonox::PickupInventoryContainer* popPickup(void)
                { return (this->pickupsIterator_++)->second; }

            void dropPickup(uint32_t pickup); 
            void usePickup(uint32_t pickup, bool use); 

            bool isValidPickup(uint32_t pickup) const
                { return this->pickups_.find(pickup) != this->pickups_.end(); }
            // tolua_end

            static void dropPickupNetworked(uint32_t pickup); 
            static void usePickupNetworked(uint32_t pickup, bool use); 

        private:
            static PickupManager* singletonPtr_s;
            static const std::string guiName_s; 
            bool guiLoaded_; 
            uint32_t pickupHighestIndex_; 

            PickupRepresentation* defaultRepresentation_; 

            std::map<std::string, PickupRepresentation*> representations_; 

            std::map<uint32_t, PickupInventoryContainer*> pickupInventoryContainers_; 
            std::map<uint32_t, PickupInventoryContainer*>::iterator pickupsIterator_; 

            std::map<uint32_t, WeakPtr<Pickupable>> pickups_; 
            std::map<Pickupable*, uint32_t> indexes_;

            void updateGUI(void); 
            uint32_t getPickupIndex(void); 

    }; // tolua_export

} // tolua_export

#endif // _PickupManager_H__