Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Nov 12, 2008, 1:29:33 PM (15 years ago)
Author:
dafrick
Message:

Just changed some small stuff…

File:
1 edited

Legend:

Unmodified
Added
Removed
  • code/branches/questsystem2/src/orxonox/objects/quest/GlobalQuest.cc

    r2159 r2191  
    7979    /**
    8080    @brief
    81         Fails the quest for all players.
    82         Invokes the failEffects on all the players possessing this quest.
     81        Fails the Quest for all players.
     82        Invokes the fail QuestEffects on all the players possessing this Quest.
    8383    @param player
    8484        The player failing it.
    8585    @return
    86         Returns true if the quest could be failed, false if not.
     86        Returns true if the Quest could be failed, false if not.
    8787    */
    8888    bool GlobalQuest::fail(ControllableEntity* player)
    8989    {
    90         if(this->isFailable(player)) //!< Check whether the quest can be failed.
     90        if(this->isFailable(player)) //!< Check whether the Quest can be failed.
    9191        {
    9292            this->setStatus(player, questStatus::failed);
    9393           
    94             //! Iterate through all players possessing this quest.
     94            //! Iterate through all players possessing this Quest.
    9595            for(std::set<ControllableEntity*>::const_iterator it = players_.begin(); it != players_.end(); it++)
    9696            {
     
    107107    /**
    108108    @brief
    109         Completes the quest for all players.
    110         Invokes the completeEffects on all the players possessing this quest.
    111         Invokes the reward effects on the player completing the quest.
     109        Completes the Quest for all players.
     110        Invokes the complete QuestEffects on all the players possessing this Quest.
     111        Invokes the reward QuestEffects on the player completing the Quest.
    112112    @param player
    113113        The player completing it.
    114114    @return
    115         Returns true if the quest could be completed, false if not.
     115        Returns true if the Quest could be completed, false if not.
    116116    */
    117117    bool GlobalQuest::complete(ControllableEntity* player)
    118118    {
    119         if(this->isCompletable(player)) //!< Check whether the quest can be completed.
     119        if(this->isCompletable(player)) //!< Check whether the Quest can be completed.
    120120        {
    121121            this->setStatus(player, questStatus::completed);
    122122           
    123             //! Iterate through all players possessing the quest.
     123            //! Iterate through all players possessing the Quest.
    124124            for(std::set<ControllableEntity*>::const_iterator it = players_.begin(); it != players_.end(); it++)
    125125            {
     
    127127            }
    128128           
    129             QuestEffect::invokeEffects(player, this->rewards_); //!< Invoke reward effects on the player completing the quest.
     129            QuestEffect::invokeEffects(player, this->rewards_); //!< Invoke reward QuestEffects on the player completing the Quest.
    130130            return true;
    131131        }
     
    137137    /**
    138138    @brief
    139         Checks whether the quest can be started.
     139        Checks whether the Quest can be started.
    140140    @param player
    141141        The player for whom is to be checked.
     
    152152    /**
    153153    @brief
    154         Checks whether the quest can be failed.
     154        Checks whether the Quest can be failed.
    155155    @param player
    156156        The player for whom is to be checked.
    157157    @return
    158         Returns true if the quest can be failed, false if not.
     158        Returns true if the Quest can be failed, false if not.
    159159    @throws
    160160        Throws an Exception if isActive() throws one.
     
    168168    /**
    169169    @brief
    170         Checks whether the quest can be completed.
     170        Checks whether the Quest can be completed.
    171171    @param player
    172172        The player for whom is to be checked.
    173173    @return
    174         Returns true if the quest can be completed, false if not.
     174        Returns true if the Quest can be completed, false if not.
    175175    @throws
    176176        Throws an Exception if isActive() throws one.
     
    183183    /**
    184184    @brief
    185         Returns the status of the quest for a specific player.
     185        Returns the status of the Quest for a specific player.
    186186    @param player
    187187        The player.
     
    237237    /**
    238238    @brief
    239         Adds a reward effect to the list of reward effects.
     239        Adds a reward QuestEffect to the list of reward QuestEffects.
    240240    @param effect
    241         The effect to be added.
     241        The QuestEffect to be added.
    242242    @return
    243243        Returns true if successful.
     
    251251        }
    252252
    253         this->rewards_.push_back(effect); //!< Add the effect to the list.
     253        this->rewards_.push_back(effect); //!< Add the QuestEffect to the list.
    254254
    255255        COUT(3) << "Reward effect was added to Quest {" << this->getId() << "}." << std::endl;
     
    259259    /**
    260260    @brief
    261         Returns the reward effect at the given index.
     261        Returns the reward QuestEffect at the given index.
    262262    @param index
    263263        The index.
Note: See TracChangeset for help on using the changeset viewer.