Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7552


Ignore:
Timestamp:
Oct 17, 2010, 10:50:43 PM (14 years ago)
Author:
dafrick
Message:

Resolving some TODOs and doing some additional cleanup. Almost done now…

Location:
code/trunk
Files:
39 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/doc/api/Groups.dox

    r7551 r7552  
    333333    For a new @ref orxonox::Pickupable "Pickupable" you need to create a new class in <code>>modules/pickup/items</code>. Your class needs to be derived from another pickup class, normally this would either be @ref orxonox::Pickupable "Pickupable", @ref orxonox::CollectiblePickup "CollectiblePickup" or @ref orxonox::Pickup "Pickup". @ref orxonox::Pickupable "Pickupable" is (as mentioned earlier) the base class of all things that can be picked up, thus of all pickups. @ref orxonox::CollectiblePickup "CollectiblePickup" is a (directly) derived class of @ref orxonox::Pickupable  "Pickupable" and provides the additional functionality of enabling your pickup to be used in a @ref orxonox::PickupCollection "PickupCollection". However you are probably going to want to derive your class form @ref orxonox::Pickup "Pickup", because it is a @ref orxonox::CollectiblePickup "CollectiblePickup" and provides some useful methods. So have a look at @ref orxonox::Pickup "Pickup".
    334334    Once you have created your new pickup class you have to insert it in the <code>PickupPrereqs.h</code> file in the <code>modules/pickup</code> folder and in the <code>CMakeList.txt</code> file in the <code>modules/pickup/items</code> folder. Also have a look at other pickups to make sure you include all the necessary files in your class.
    335     Additionally you have to add your pickup as a friend of the @ref orxonox::PickupCarrier "PickupCarrier" class. To that end open <code>PickupCarrier.h</code> in the <code>orxonox/interfaces</code> folder and add your class under
    336     @code
    337     // Forward-declarations.
    338     @endcode
    339     and under
    340     @code
    341     // Friends
    342     @endcode
    343335
    344336    @subsection ChoosingTheCarriers Coosing the carriers
    … …  
    413405    @defgroup PickupItems Items
    414406    @ingroup Pickup
     407
     408    The actual pickups can be found here.
    415409*/
    416410

  • code/trunk/src/modules/notifications/Notification.h

    r7489 r7552  
    4949
    5050        A Notification is just a datastructure that is used internally by the Notifications module.
     51
    5152    @author
    5253        Damian 'Mozork' Frick
     54
     55    @ingroup Notifications
    5356    */
    5457    class _NotificationsExport Notification : public OrxonoxClass

  • code/trunk/src/modules/notifications/NotificationDispatcher.cc

    r7489 r7552  
    118118        else if(GameMode::isServer())
    119119        {
    120             //TODO: This may fail if the object has not been synchronized, yet.
    121120            callMemberNetworkFunction(NotificationDispatcher, dispatch, this->getObjectID(), clientId, clientId);
    122121        }

  • code/trunk/src/modules/notifications/NotificationDispatcher.h

    r7488 r7552  
    3939
    4040#include <string>
     41
    4142#include "core/BaseObject.h"
    4243#include "network/synchronisable/Synchronisable.h"
    … …  
    6263        @endcode
    6364        But keep in mind, that NotificationDispatcher is an abstract class and in this example @ref orxonox::PlayerTrigger "PlayerTrigger" stands for any event that is caused by a @ref orxonox::PlayerTrigger "PlayerTrigger", so instead of @ref orxonox::PlayerTrigger "PlayerTrigger", there could be a @ref orxonox::DistanceTrigger "DistanceTrigger", or a @ref orxonox::DistanceMultiTrigger "DistanceMutliTrigger", or even an @ref orxonox::EventListener "EventListener" that waits for an event coming from any kind of @ref orxonox::PlayerTrigger "PlayerTrigger".
     65
    6466    @author
    6567        Damian 'Mozork' Frick
     68
     69    @ingroup Notifications
    6670    */
    6771    class _NotificationsExport NotificationDispatcher : public BaseObject, public Synchronisable

  • code/trunk/src/modules/notifications/NotificationManager.cc

    r7504 r7552  
    149149        assert(notification);
    150150
    151         std::time_t time = std::time(0); //TODO: Doesn't this expire? //!< Get current time.
     151        std::time_t time = std::time(0); // Get current time.
    152152
    153153        // Add the Notification to the list that holds all Notifications.

  • code/trunk/src/modules/notifications/NotificationManager.h

    r7489 r7552  
    5353        It receives, organizes @ref orxonox::Notification "Notifications" and the redistributes them to the specific @ref orxonox::NotificationListener "NotificationListeners".
    5454        It also provides a static function to send @ref orxonox::Notification "Notifications" and works as a liaison between the @ref orxonox::NotificationQueue "NotificationQueues" and the GUI that displays notification, called NotificationLayer.
     55
    5556    @author
    5657        Damian 'Mozork' Frick
     58
     59    @ingroup Notifications
    5760    */
    5861    class _NotificationsExport NotificationManager // tolua_export

  • code/trunk/src/modules/notifications/NotificationQueue.h

    r7489 r7552  
    5151{ // tolua_export
    5252
    53     //! Container to allow easy handling.
     53    /**
     54    @brief
     55        Container to allow easy handling of the @ref orxonox::Notification "Notifications".
     56
     57    @ingroup Notifications
     58    */
    5459    struct NotificationContainer
    5560    {
    … …  
    5863    };
    5964
    60     //! Struct to allow ordering of @ref orxonox::NotificationContainer "NotificationContainers".
     65    /**
     66    @brief
     67        Struct to allow ordering of @ref orxonox::NotificationContainer "NotificationContainers".
     68
     69    @ingroup Notifications
     70    */
    6171    struct NotificationContainerCompare {
    6272        bool operator() (const NotificationContainer* const & a, const NotificationContainer* const & b) const
    … …  
    7686    @author
    7787        Damian 'Mozork' Frick
     88
     89    @ingroup Notifications
    7890    */
    7991    class _NotificationsExport NotificationQueue // tolua_export

  • code/trunk/src/modules/notifications/dispatchers/CommandNotification.h

    r7489 r7552  
    6060        Upon being triggered this would display the @ref orxonox::Notification "Notification" "Please press {the binding of the specified command} to do something".
    6161        For more information on what can be used for @code <PlayerTrigger /> @endcode see the @ref orxonox::NotificationDispatcher "NotificationDispatcher" documentation.
     62
    6263    @author
    6364        Damian 'Mozork' Frick
     65
     66    @ingroup NotificationDispatchers
    6467    */
    6568    class _NotificationsExport CommandNotification : public NotificationDispatcher

  • code/trunk/src/modules/notifications/dispatchers/SimpleNotification.h

    r7488 r7552  
    5858        @endcode
    5959        For more information on what can be used for @code <PlayerTrigger /> @endcode see the @ref orxonox::NotificationDispatcher "NotificationDispatcher" documentation.
     60
    6061    @author
    6162        Damian 'Mozork' Frick
     63
     64    @ingroup NotificationDispatchers
    6265    */
    6366    class _NotificationsExport SimpleNotification : public NotificationDispatcher

  • code/trunk/src/modules/questsystem/GlobalQuest.cc

    r7456 r7552  
    135135    @return
    136136        Returns true if the quest can be started, false if not.
    137     @throws
    138         Throws an exception if either isInactive() of isActive() throws one.
    139137    */
    140138    bool GlobalQuest::isStartable(const PlayerInfo* player) const
    … …  
    153151    @return
    154152        Returns true if the Quest can be failed, false if not.
    155     @throws
    156         Throws an Exception if isActive() throws one.
    157153    */
    158154    bool GlobalQuest::isFailable(const PlayerInfo* player) const
    … …  
    169165    @return
    170166        Returns true if the Quest can be completed, false if not.
    171     @throws
    172         Throws an Exception if isActive() throws one.
    173167    */
    174168    bool GlobalQuest::isCompletable(const PlayerInfo* player) const
    … …  
    182176    @param player
    183177        The player.
    184     @throws
    185         Throws an Exception if player is NULL.
    186178    */
    187179    QuestStatus::Value GlobalQuest::getStatus(const PlayerInfo* player) const
    188180    {
    189         //TODO: Replace with assert.
    190         if(player == NULL) // We don't want NULL-Pointers!
    191             ThrowException(Argument, "The input PlayerInfo* is NULL.");
     181        assert(player);
    192182
    193183        // Find the player.
    … …  
    212202    bool GlobalQuest::setStatus(PlayerInfo* player, const QuestStatus::Value & status)
    213203    {
    214         //TODO: Replace with assert.
    215         if(player == NULL) // We don't want NULL-Pointers!
    216             return false;
     204        assert(player);
    217205
    218206        // Find the player.
    … …  
    235223    bool GlobalQuest::addRewardEffect(QuestEffect* effect)
    236224    {
    237         //TODO: Replace with assert?
    238         if(effect == NULL) // We don't want NULL-Pointers!
    239         {
    240             COUT(2) << "The reward effect to be added to quest {" << this->getId() << "} was NULL." << std::endl;
    241             return false;
    242         }
     225        assert(effect);
    243226
    244227        this->rewards_.push_back(effect); // Add the QuestEffect to the list.

  • code/trunk/src/modules/questsystem/GlobalQuest.h

    r7456 r7552  
    4444namespace orxonox
    4545{
     46
    4647    /**
    4748    @brief
    … …  
    8081        </GlobalQuest>
    8182        @endcode
     83
    8284    @author
    8385        Damian 'Mozork' Frick
     86
     87    @ingroup Questsystem
    8488    */
    8589    class _QuestsystemExport GlobalQuest : public Quest

  • code/trunk/src/modules/questsystem/LocalQuest.cc

    r7456 r7552  
    125125    @return
    126126        Returns true if the Quest can be started, false if not.
    127     @throws
    128         Throws an exception if isInactive(PlayerInfo*) throws one.
    129127    */
    130128    bool LocalQuest::isStartable(const PlayerInfo* player) const
    … …  
    143141    @return
    144142        Returns true if the Quest can be failed, false if not.
    145     @throws
    146         Throws an exception if isActive(PlayerInfo*) throws one.
    147143    */
    148144    bool LocalQuest::isFailable(const PlayerInfo* player) const
    … …  
    158154    @return
    159155        Returns true if the Quest can be completed, false if not.
    160     @throws
    161         Throws an exception if isInactive(PlayerInfo*) throws one.
    162156    */
    163157    bool LocalQuest::isCompletable(const PlayerInfo* player) const
    … …  
    173167    @return
    174168        Returns the status of the Quest for the input player.
    175     @throws
    176         Throws an Exception if player is NULL.
    177169    */
    178170    QuestStatus::Value LocalQuest::getStatus(const PlayerInfo* player) const
    179171    {
    180         //TODO: Replace with assert.
    181         if(player == NULL) // No player has no defined status.
    182             ThrowException(Argument, "The input PlayerInfo* is NULL.");
     172        assert(player);
    183173
    184174        std::map<const PlayerInfo*, QuestStatus::Value>::const_iterator it = this->playerStatus_.find(player);
    … …  
    202192    bool LocalQuest::setStatus(PlayerInfo* player, const QuestStatus::Value & status)
    203193    {
    204         //TODO: Replace with assert.
    205         if(player == NULL) // We can't set a status for no player.
    206             return false;
     194        assert(player);
    207195
    208196        this->playerStatus_[player] = status;

  • code/trunk/src/modules/questsystem/LocalQuest.h

    r7456 r7552  
    4343namespace orxonox
    4444{
     45
    4546    /**
    4647    @brief
    … …  
    7475        </LocalQuest>
    7576        @endcode
     77
    7678    @author
    7779        Damian 'Mozork' Frick
     80
     81    @ingroup Questsystem
    7882    */
    7983    class _QuestsystemExport LocalQuest : public Quest

  • code/trunk/src/modules/questsystem/Quest.cc

    r7456 r7552  
    9292    bool Quest::setParentQuest(Quest* quest)
    9393    {
    94         //TODO: Replace with assert.
    95         if(quest == NULL) // We don't want to set NULL-Pointers.
    96         {
    97             COUT(2) << "The parentquest to be added to quest {" << this->getId() << "} was NULL." << std::endl;
    98             return false;
    99         }
     94        assert(quest);
    10095
    10196        this->parentQuest_ = quest;
    … …  
    115110    bool Quest::addSubQuest(Quest* quest)
    116111    {
    117         //TODO: Replace with assert.
    118         if(quest == NULL) // We don't want to set NULL-Pointers.
    119         {
    120             COUT(2) << "The subquest to be added to quest {" << this->getId() << "} was NULL." << std::endl;
    121             return false;
    122         }
     112        assert(quest);
    123113
    124114        quest->setParentQuest(this); // Sets the currentQuest (this) as parent-quest for the added sub-quest.
    … …  
    140130    bool Quest::addHint(QuestHint* hint)
    141131    {
    142         //TODO: Replace with assert.
    143         if(hint == NULL) // We don't want to set NULL-Pointers. Seriously!
    144         {
    145             COUT(2) << "A NULL-QuestHint was trying to be added." << std::endl;
    146             return false;
    147         }
     132        assert(hint);
    148133
    149134        hint->setQuest(this); // Sets the current Quest (this) as Quest for the added QuestHint.
    … …  
    164149    bool Quest::addFailEffect(QuestEffect* effect)
    165150    {
    166         //TODO: Replace with assert.
    167         if(effect == NULL) // We don't want to set NULL-Pointers.
    168         {
    169             COUT(2) << "A NULL-QuestEffect was trying to be added" << std::endl;
    170             return false;
    171         }
     151        assert(effect);
    172152
    173153        this->failEffects_.push_back(effect); // Adds the QuestEffect to the end of the list of fail QuestEffects.
    … …  
    187167    bool Quest::addCompleteEffect(QuestEffect* effect)
    188168    {
    189         //TODO: Replace with assert.
    190         if(effect == NULL) // We don't want to set NULL-Pointers.
    191         {
    192             COUT(2) << "A NULL-QuestEffect was trying to be added" << std::endl;
    193             return false;
    194         }
     169        assert(effect);
    195170
    196171        this->completeEffects_.push_back(effect); // Adds the QuestEffect to the end of the list of complete QuestEffects.
    … …  
    300275    @return
    301276        Returns true if the quest status for the specific player is 'inactive'.
    302     @throws
    303         Throws an exception if getStatus throws one.
    304277    */
    305278    bool Quest::isInactive(const PlayerInfo* player) const
    306279    {
     280        if(player == NULL)
     281            return true;
    307282        return this->getStatus(player) == QuestStatus::Inactive;
    308283    }
    … …  
    315290    @return
    316291        Returns true if the quest status for the specific player is 'active'.
    317     @throws
    318         Throws an exception if getStatus throws one.
    319292    */
    320293    bool Quest::isActive(const PlayerInfo* player) const
    321294    {
     295        if(player == NULL)
     296            return false;
    322297        return this->getStatus(player) == QuestStatus::Active;
    323298    }
    … …  
    330305    @return
    331306        Returns true if the quest status for the specific player is 'failed'.
    332     @throws
    333         Throws an exception if getStatus throws one.
    334307    */
    335308    bool Quest::isFailed(const PlayerInfo* player) const
    336309    {
     310        if(player == NULL)
     311            return false;
    337312        return this->getStatus(player) == QuestStatus::Failed;
    338313    }
    … …  
    345320    @return
    346321        Returns true if the quest status for the specific player is 'completed'.
    347     @throws
    348         Throws an exception if getStatus throws one.
    349322    */
    350323    bool Quest::isCompleted(const PlayerInfo* player) const
    351324    {
     325        if(player == NULL)
     326            return false;
    352327        return this->getStatus(player) == QuestStatus::Completed;
    353328    }
    … …  
    427402    bool Quest::addListener(QuestListener* listener)
    428403    {
    429         //TODO: Replace with assert?
    430         if(listener == NULL)
    431         {
    432             COUT(2) << "A NULL-QuestListener was trying to be added to a Quests listeners." << std::endl;
    433             return false;
    434         }
     404        assert(listener);
    435405
    436406        this->listeners_.push_back(listener);

  • code/trunk/src/modules/questsystem/Quest.h

    r7456 r7552  
    4444namespace orxonox // tolua_export
    4545{ // tolua_export
     46
     47    /**
     48    @brief
     49        Different states of a @ref orxonox::Quest "Quest".
     50
     51    @ingroup Questsystem
     52    */
    4653    namespace QuestStatus
    4754    {
    48         //! Different states of a @ref orxonox::Quest "Quest".
    4955        enum Value
    5056        {
    51             Inactive,
    52             Active,
    53             Failed,
    54             Completed
     57            Inactive, //!< The @ref orxonox::Quest "Quest" is inactive.
     58            Active, //!< The @ref orxonox::Quest "Quest" is active.
     59            Failed, //!< The @ref orxonox::Quest "Quest" has been failed.
     60            Completed //!< The @ref orxonox::Quest "Quest" has been completed.
    5561        };
    5662    }
    … …  
    6672
    6773        Quest itself should not be instantiated, if you want to create a quest either use LocalQuest or GlobalQuest, whichever suits you needs better.
     74
    6875    @author
    6976        Damian 'Mozork' Frick
     77
     78    @ingroup Questsystem
    7079    */
    7180    class _QuestsystemExport Quest // tolua_export

  • code/trunk/src/modules/questsystem/QuestDescription.h

    r7474 r7552  
    4444namespace orxonox
    4545{
     46
    4647    /**
    4748    @brief
    … …  
    5354        <QuestDescription title="Title" description="Description Text" failMessage="You fail." completeMessage="You win!" />
    5455        @endcode
     56
    5557    @author
    5658        Damian 'Mozork' Frick
     59
     60    @ingroup Questsystem
    5761    */
    5862    class _QuestsystemExport QuestDescription : public BaseObject

  • code/trunk/src/modules/questsystem/QuestEffect.h

    r7456 r7552  
    4343namespace orxonox
    4444{
     45
    4546    /**
    4647    @brief
    4748        Handles QuestEffects for @ref orxonox::Quest "Quests".
    4849        QuestEffects are one of the ways for @ref orxonox::Quest "Quests" to have any side effects on the game world and for the game world to influence the @ref orxonox::Quest "Quests".
     50
    4951    @author
    5052        Damian 'Mozork' Frick
     53
     54    @ingroup Questsystem
    5155    */
    5256    class _QuestsystemExport QuestEffect : public BaseObject

  • code/trunk/src/modules/questsystem/QuestEffectBeacon.cc

    r7484 r7552  
    4141#include "worldentities/pawns/Pawn.h"
    4242
    43 #include "objects/triggers/MultiTriggerContainer.h"
    4443#include "QuestEffect.h"
    4544
    … …  
    101100        Returns true if successfully executed, false if not.
    102101    */
    103     //TODO: Eliminate MultiTriggerContainer stuff, since they are now PlayerTriggers as well.
    104102    bool QuestEffectBeacon::execute(bool bTriggered, BaseObject* trigger)
    105103    {
    … …  
    115113
    116114        PlayerTrigger* pTrigger = orxonox_cast<PlayerTrigger*>(trigger);
    117         MultiTriggerContainer* mTrigger = orxonox_cast<MultiTriggerContainer*>(trigger);
    118115        Pawn* pawn = NULL;
    119 
    120         // If the trigger is neither a Playertrigger nor a MultiTrigger (i.e. a MultitriggerContainer) we can do anything with it.
    121         if(pTrigger == NULL && mTrigger == NULL)
    122             return false;
    123116
    124117        // If the trigger is a PlayerTrigger.
    … …  
    130123                pawn = pTrigger->getTriggeringPlayer();
    131124        }
    132 
    133         // If the trigger is a MultiTrigger (i.e. a MultiTriggerContainer)
    134         if(mTrigger != NULL)
    135         {
    136             pawn = orxonox_cast<Pawn*>(mTrigger->getData());
    137         }
     125        else
     126            return false;
    138127
    139128        if(pawn == NULL)
    … …  
    237226    bool QuestEffectBeacon::addEffect(QuestEffect* effect)
    238227    {
    239         //TODO: Replace with assert.
    240         if(effect == NULL) // NULL-pointers are not well liked here...
    241         {
    242             COUT(2) << "A NULL-QuestEffect was trying to be added" << std::endl;
    243             return false;
    244         }
     228        assert(effect);
    245229
    246230        this->effects_.push_back(effect);

  • code/trunk/src/modules/questsystem/QuestEffectBeacon.h

    r7489 r7552  
    4343namespace orxonox
    4444{
     45
     46    /**
     47    @brief
     48        The status of the @ref orxonox::QuestEffectBeacon "QuestEffectBeacon", can be either active or inactive.
     49
     50    @ingroup Questsystem
     51    */
    4552    namespace QuestEffectBeaconStatus
    4653    {
    47         //! The status of the @ref orxonox::QuestEffectBeacon "QuestEffectBeacon", can be either active or inactive.
    4854        enum Value
    4955        {
    50             Inactive,
    51             Active
     56            Inactive, //!< The @ref orxonox::QuestEffectBeacon "QuestEffectBeacon" is inactive.
     57            Active //!< The @ref orxonox::QuestEffectBeacon "QuestEffectBeacon" is active.
    5258        };
    5359    }
    … …  
    7884        </QuestEffectBeacon>
    7985        @endcode
     86
    8087    @author
    8188        Damian 'Mozork' Frick
     89
     90    @ingroup Questsystem
    8291    */
    8392    class _QuestsystemExport QuestEffectBeacon : public StaticEntity

  • code/trunk/src/modules/questsystem/QuestHint.cc

    r7548 r7552  
    8383    @param player
    8484        The player.
    85     @throws
    86         Throws an Argument Exception if the input Player-pointer is NULL.
    8785    @return
    8886        Returns true if the QuestHint is active for the specified player.
    … …  
    9088    bool QuestHint::isActive(const PlayerInfo* player) const
    9189    {
    92         //TODO: Replace with assert.
    93         if(player == NULL) // NULL-Pointers are ugly!
    94         {
    95             ThrowException(Argument, "The input PlayerInfo* is NULL.");
     90        if(player == NULL) // If the player is NULL, the Quest obviously can't be active.
    9691            return false;
    97         }
    9892
    9993        // Find the player.
    … …  
    145139    bool QuestHint::setQuest(Quest* quest)
    146140    {
    147         //TODO: Replace with assert.
    148         if(quest == NULL) // NULL-Pointer. Again..?
    149         {
    150             COUT(2) << "The input Quest* is NULL." << std::endl;
    151             return false;
    152         }
     141        assert(quest);
    153142
    154143        this->quest_ = quest;

  • code/trunk/src/modules/questsystem/QuestHint.h

    r7456 r7552  
    4444{ // tolua_export
    4545
     46    /**
     47    @brief
     48        The state of the @ref orxonox::QuestHint "QuestHint".
     49
     50    @ingroup Questsystem
     51    */
    4652    namespace QuestHintStatus
    4753    {
    48         //! The state of the @ref orxonox::QuestHint "QuestHint".
    4954        enum Value
    5055        {
    51             Inactive,
    52             Active
     56            Inactive, //!< The @ref orxonox::QuestHint "QuestHint" is inactive.
     57            Active //!< The @ref orxonox::QuestHint "QuestHint" is active.
    5358        };
    5459    }
    … …  
    6671        </QuestHint>
    6772        @endcode
     73
    6874    @author
    6975        Damian 'Mozork' Frick
     76
     77    @ingroup Questsystem
    7078    */
    7179    class _QuestsystemExport QuestHint // tolua_export

  • code/trunk/src/modules/questsystem/QuestItem.h

    r7456 r7552  
    5050        Functions as a base class for quest classes such as @ref orxonox::Quest "Quest" or @ref orxonox::QuestHint "QuestHint".
    5151        Has a unique identifier and a @ref orxonox::QuestDescription "QuestDescription".
     52
    5253    @author
    5354        Damian 'Mozork' Frick
     55
     56    @ingroup Questsystem
    5457    */
    5558    class _QuestsystemExport QuestItem : public BaseObject

  • code/trunk/src/modules/questsystem/QuestListener.h

    r7456 r7552  
    4444namespace orxonox
    4545{
     46    /**
     47    @brief
     48        The mode of the @ref orxonox::QuestListener "QuestListener".
     49
     50    @ingroup Questsystem
     51    */
    4652    namespace QuestListenerMode
    4753    {
    48         //! The mode of the @ref orxonox::QuestListener "QuestListener".
    4954        enum Value
    5055        {
    51             All,
    52             Start,
    53             Fail,
    54             Complete
     56            All, //!< Listens to all events.
     57            Start, //!< Only listens to events pertaining the starting of @ref orxonox::Quest "Quests".
     58            Fail, //!< Only listens to events pertaining the failing of @ref orxonox::Quest "Quests".
     59            Complete //!< Only listens to events pertaining the completing of @ref orxonox::Quest "Quests".
    5560        };
    5661    }
    … …  
    7277
    7378        You can use the QuestListener as if it were a @ref orxonox::Trigger "Trigger" or @ref orxonox::EventListener "EventListener", that fires an Event when the status (depending on the set mode) of the given @ref orxonox::Quest "Quest" changes.
     79
    7480    @author
    75     Damian 'Mozork' Frick
     81        Damian 'Mozork' Frick
     82
     83    @ingroup Questsystem
    7684    */
    7785    class _QuestsystemExport QuestListener : public BaseObject

  • code/trunk/src/modules/questsystem/QuestManager.cc

    r7456 r7552  
    100100    bool QuestManager::registerQuest(Quest* quest)
    101101    {
    102         //TODO: Replace with assert.
    103         if(quest == NULL) // Doh! Just as if there were actual quests behind NULL-pointers.
    104         {
    105             COUT(2) << "Registration of Quest in QuestManager failed, because inserted Quest-pointer was NULL." << std::endl;
    106             return false;
    107         }
     102        assert(quest);
    108103
    109104        std::pair<std::map<std::string, Quest*>::iterator,bool> result;
    … …  
    143138    bool QuestManager::registerHint(QuestHint* hint)
    144139    {
    145         //TODO: Replace with assert.
    146         if(hint == NULL) // Still not liking NULL-pointers.
    147         {
    148             COUT(2) << "Registration of QuestHint in QuestManager failed, because inserted QuestHint-pointer was NULL." << std::endl;
    149             return false;
    150         }
     140        assert(hint);
    151141
    152142        std::pair<std::map<std::string, QuestHint*>::iterator,bool> result;

  • code/trunk/src/modules/questsystem/QuestManager.h

    r7484 r7552  
    4747namespace orxonox  // tolua_export
    4848{  // tolua_export
     49
    4950    /**
    5051    @brief
    5152        Is a Singleton and manages @ref orxonox::Quest "Quests", by registering every @ref orxonox::Quest "Quest" / @ref orxonox::QuestHint "QuestHint" (through registerX()) and making them globally accessible (through findX()).
    5253        @ref orxonox::Quest "Quests" (and @ref orxonox::QuestHint "QuestHints") are registered in the QuestManager with their id, and can be accessed in the same way.
     54
    5355    @author
    5456        Damian 'Mozork' Frick
     57
     58    @ingroup Questsystem
    5559    */
    5660    class _QuestsystemExport QuestManager  // tolua_export

  • code/trunk/src/modules/questsystem/effects/AddQuest.cc

    r7456 r7552  
    8383    bool AddQuest::invoke(PlayerInfo* player)
    8484    {
    85         //TODO: Replace with assert?
    86         if(player == NULL) // Null-pointers are badass.
    87         {
    88             COUT(2) << "Input player is NULL." << std::endl;
    89             return false;
    90         }
     85        assert(player);
    9186
    9287        COUT(5) << "AddQuest on player: " << player << " ." << std::endl;

  • code/trunk/src/modules/questsystem/effects/AddQuest.h

    r7456 r7552  
    4141namespace orxonox
    4242{
     43
    4344    /**
    4445    @brief
    … …  
    4950        <AddQuest questId="id" />  //Where id identifies the Quest that should be added.
    5051        @endcode
     52
    5153    @author
    5254        Damian 'Mozork' Frick
     55
     56    @ingroup QuestEffects
    5357    */
    5458    class _QuestsystemExport AddQuest : public ChangeQuestStatus

  • code/trunk/src/modules/questsystem/effects/AddQuestHint.cc

    r7456 r7552  
    106106    bool AddQuestHint::invoke(PlayerInfo* player)
    107107    {
    108         //TODO: Replace with assert?
    109         if(player == NULL) // NULL-pointers are evil!
    110         {
    111             COUT(2) << "The input player is NULL." << std::endl;
    112             return false;
    113         }
     108        assert(player);
    114109
    115110        COUT(5) << "AddQuestHint on player: " << player << " ." << std::endl;

  • code/trunk/src/modules/questsystem/effects/AddQuestHint.h

    r7456 r7552  
    4343namespace orxonox
    4444{
     45
    4546    /**
    4647    @brief
    … …  
    5152        <AddQuestHint hintId="id" />  //Where id identifies the QuestHint that should be added.
    5253        @endcode
     54
    5355    @author
    5456        Damian 'Mozork' Frick
     57
     58    @ingroup QuestEffects
    5559    */
    5660    class _QuestsystemExport AddQuestHint : public QuestEffect

  • code/trunk/src/modules/questsystem/effects/AddReward.h

    r7456 r7552  
    4343namespace orxonox
    4444{
     45   
    4546    /**
    4647    @brief
    … …  
    5556        </AddReward>
    5657        @endcode
     58
    5759    @author
    5860        Damian 'Mozork' Frick
     61
     62    @ingroup QuestEffects
    5963    */
    6064    class _QuestsystemExport AddReward : public QuestEffect

  • code/trunk/src/modules/questsystem/effects/ChangeQuestStatus.h

    r7456 r7552  
    4343namespace orxonox
    4444{
     45
    4546    /**
    4647    @brief
    4748        A QuestEffect which changes the status of a specified @ref orxonox::Quest "Quest" for the player invoking the QuestEffect.
     49
    4850    @author
    4951        Damian 'Mozork' Frick
     52
     53    @ingroup QuestEffects
    5054    */
    5155    class _QuestsystemExport ChangeQuestStatus : public QuestEffect

  • code/trunk/src/modules/questsystem/effects/CompleteQuest.cc

    r7456 r7552  
    8383    bool CompleteQuest::invoke(PlayerInfo* player)
    8484    {
    85         //TODO: Replace with assert?
    86         if(player == NULL) // You know, what we think of NULL-pointers...
    87         {
    88             COUT(2) << "Input player is NULL." << std::endl;
    89             return false;
    90         }
     85        assert(player);
    9186
    9287        COUT(5) << "CompleteQuest on player: " << player << " ." << std::endl;

  • code/trunk/src/modules/questsystem/effects/CompleteQuest.h

    r7456 r7552  
    4141namespace orxonox
    4242{
     43
    4344    /**
    4445    @brief
    … …  
    4950        <CompleteQuest questId="id" />  //Where id identifies the Quest that should be completed.
    5051        @endcode
     52
    5153    @author
    5254        Damian 'Mozork' Frick
     55
     56    @ingroup QuestEffects
    5357    */
    5458    class _QuestsystemExport CompleteQuest : public ChangeQuestStatus

  • code/trunk/src/modules/questsystem/effects/FailQuest.cc

    r7456 r7552  
    8383    bool FailQuest::invoke(PlayerInfo* player)
    8484    {
    85         //TODO: Replace with assert?
    86         if(player == NULL) // We don't know what to do with no player.
    87         {
    88             COUT(2) << "Input player is NULL." << std::endl;
    89             return false;
    90         }
     85        assert(player);
    9186
    9287        COUT(4) << "FailQuest on player: " << player << " ." << std::endl;

  • code/trunk/src/modules/questsystem/effects/FailQuest.h

    r7456 r7552  
    4141namespace orxonox
    4242{
     43
    4344    /**
    4445    @brief
    … …  
    4950        <FailQuest questId="id" />  //Where id identifies the Quest that should be failed.
    5051        @endcode
     52
    5153    @author
    5254        Damian 'Mozork' Frick
     55
     56    @ingroup QuestEffects
    5357    */
    5458    class _QuestsystemExport FailQuest : public ChangeQuestStatus

  • code/trunk/src/orxonox/interfaces/NotificationListener.h

    r7484 r7552  
    5656        The NotificationListener interface presents a means to being informed when @ref orxonox::Notification "Notifications" in the target set of this NotificationListener change. (e.g. @ref orxonox::Notification "Notifications" were added or removed)
    5757        When inheriting from a NotificationListener it is important to register (in the constructor) and unregister (in the destructor) it to and from the @ref orxonox::NotificationManager "NotificationManager".
     58
    5859    @author
    5960        Fabian 'x3n' Landau
     61
     62    @ingroup Notifications
    6063    */
    61     //TODO: Needed? Remove or move some NotificationQueue things over here.
    6264    class _OrxonoxExport NotificationListener : virtual public OrxonoxClass
    6365    {

  • code/trunk/src/orxonox/interfaces/PickupCarrier.h

    r7547 r7552  
    4747
    4848    // Forward-declarations.
    49     class PickupManager;
    50     class Pickup;
    51     class HealthPickup;
    52     class InvisiblePickup;
    5349    class MetaPickup;
    54     class DronePickup;
    55     class SpeedPickup;
    5650
    5751    /**
    … …  
    7872        friend class PickupManager;
    7973        // Friends.
    80         friend class Pickup;
    81         friend class HealthPickup;
    82         friend class InvisiblePickup;
    8374        friend class MetaPickup;
    84         friend class DronePickup;
    85         friend class SpeedPickup;
    8675
    8776        public:

  • code/trunk/src/orxonox/interfaces/Pickupable.h

    r7547 r7552  
    6262    class _OrxonoxExport Pickupable : virtual public OrxonoxClass, public Rewardable
    6363    {
     64        friend class PickupCarrier;
     65
    6466        protected:
    6567            Pickupable(); //!< Default constructor.
    … …  
    146148            bool setUsed(bool used); //!< Sets the Pickupable to used or unused, depending on the input.
    147149            bool setPickedUp(bool pickedUp); //!< Helper method to set the Pickupable to either picked up or not picked up.
    148             //TODO: private?
    149150            bool setCarrier(PickupCarrier* carrier, bool tell = true); //!< Sets the carrier of the Pickupable.
    150 
    151             //TODO: private?
    152             virtual void carrierDestroyed(void); //!< Is called by the PickupCarrier when it is being destroyed.
    153151
    154152            void destroy(void); //!< Is called internally within the Pickupable module to destroy pickups.
    … …  
    162160            virtual void preDestroy(void); //!< A method that is called by OrxonoxClass::destroy() before the object is actually destroyed.
    163161            virtual void destroyPickup(void); //!< Destroys a Pickupable.
     162            virtual void carrierDestroyed(void); //!< Is called by the PickupCarrier when it is being destroyed.
    164163
    165164            /**

  • code/trunk/src/orxonox/items/Engine.h

    r7547 r7552  
    114114            virtual const Vector3& getCarrierPosition(void) const;
    115115
    116             //TODO: Move to protected or private. How?
    117116            inline void setSpeedAdd(float speedAdd)
    118117                { this->speedAdd_=speedAdd; }
Note: See TracChangeset for help on using the changeset viewer.