Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Just changed some small stuff…

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/questsystem2/src/orxonox/objects/quest/Quest.cc

    r2159 r2191  
    8484    /**
    8585    @brief
    86         Sets the parent quest of the quest.
     86        Sets the parentquest of the Quest.
    8787    @param quest
    88         A pointer to the quest to be set as parent quest.
    89     @return
    90         Returns true if the parentQuest could be set.
     88        A pointer to the Quest to be set as parentquest.
     89    @return
     90        Returns true if the parentquest could be set.
    9191    */
    9292    bool Quest::setParentQuest(Quest* quest)
    … …  
    106106    /**
    107107    @brief
    108         Adds a sub quest to the quest.
     108        Adds a subquest to the Quest.
    109109    @param quest
    110         A pointer to the quest to be set as sub quest.
    111     @return
    112         Returns true if the subQuest vould be set.
     110        A pointer to the Quest to be set as subquest.
     111    @return
     112        Returns true if the subquest could be set.
    113113    */
    114114    bool Quest::addSubQuest(Quest* quest)
    … …  
    120120        }
    121121
    122         quest->setParentQuest(this); //!< Sets the current quest (this) as parent quest for the added subquest.
    123         this->subQuests_.push_back(quest); //!< Adds the quest to the end of the list of subquests.
     122        quest->setParentQuest(this); //!< Sets the currentQuest (this) as parentquest for the added subquest.
     123        this->subQuests_.push_back(quest); //!< Adds the Quest to the end of the list of subquests.
    124124
    125125        COUT(3) << "Sub Quest {" << quest->getId() << "} was added to Quest {" << this->getId() << "}." << std::endl;
    … …  
    130130    /**
    131131    @brief
    132         Adds a Hint to the list of hints
     132        Adds a QuestHint to the list of QuestHints
    133133    @param hint
    134         The hint that should be added to the list of hints.
     134        The QuestHint that should be added to the list of QuestHints.
    135135    @return
    136136        Returns true if the hint was successfully added.
    … …  
    144144        }
    145145
    146         hint->setQuest(this); //!< Sets the current quest (this) as quest for the added hint.
    147         this->hints_.push_back(hint); //!< Adds the hint to the end of the list of hints.
     146        hint->setQuest(this); //!< Sets the current Quest (this) as Quest for the added QuestHint.
     147        this->hints_.push_back(hint); //!< Adds the QuestHint to the end of the list of QuestHints.
    148148
    149149        COUT(3) << "QuestHint {" << hint->getId() << "} was added to Quest {" << this->getId() << "}." << std::endl;
    … …  
    153153    /**
    154154    @brief
    155         Adds an effect to the list of failEffects.
     155        Adds an QuestEffect to the list of fail QuestEffects.
    156156    @param effect
    157157        The QuestEffect to be added.
    … …  
    167167        }
    168168
    169         this->failEffects_.push_back(effect); //!< Adds the effect to the end of the list of failEffects.
     169        this->failEffects_.push_back(effect); //!< Adds the QuestEffect to the end of the list of fail QuestEffects.
    170170
    171171        COUT(3) << "A FailEffect was added to Quest {" << this->getId() << "}." << std::endl;
    … …  
    175175    /**
    176176    @brief
    177         Adds an effect to the list of completeEffects.
     177        Adds an QuestEffect to the list of complete QuestEffects.
    178178    @param effect
    179179        The QuestEffect to be added.
    … …  
    189189        }
    190190
    191         this->completeEffects_.push_back(effect); //!< Adds the effect to the end of the list of completeEffects.
     191        this->completeEffects_.push_back(effect); //!< Adds the QuestEffect to the end of the list of complete QuestEffects.
    192192
    193193        COUT(3) << "A CompleteEffect was added to Quest {" << this->getId() << "}." << std::endl;
    … …  
    197197    /**
    198198    @brief
    199         Returns the parent quest of the quest.
    200     @return
    201         Returns the parent quest of the quest.
     199        Returns the parentquest of the Quest.
     200    @return
     201        Returns a pointer to the parentquest of the Quest.
    202202    */
    203203    const Quest* Quest::getParentQuest(void)
    … …  
    208208    /**
    209209    @brief
    210         Returns the sub quest of the given index.
     210        Returns the subquest at the given index.
    211211    @param
    212212        The index.
    213213    @return
    214         Returns the subquest of the given index. NULL if there is no element on the given index.
     214        Returns a pointer to the subquest at the given index. NULL if there is no element at the given index.
    215215    */
    216216    const Quest* Quest::getSubQuest(unsigned int index) const
    … …  
    233233    /**
    234234    @brief
    235         Returns the hint of the given index.
     235        Returns the QuestHint at the given index.
    236236    @param
    237237        The index.
    238238    @return
    239         Returns the hint of the given index. NULL if there is no element on the given index.
     239        Returns a pointer to the QuestHint at the given index. NULL if there is no element at the given index.
    240240    */
    241241    const QuestHint* Quest::getHint(unsigned int index) const
    … …  
    243243        int i = index;
    244244       
    245         //! Iterate through all hints.
     245        //! Iterate through all QuestHints.
    246246        for (std::list<QuestHint*>::const_iterator hint = this->hints_.begin(); hint != this->hints_.end(); ++hint)
    247247        {
    … …  
    257257    /**
    258258    @brief
    259         Returns the failEffect of the given index.
     259        Returns the fail QuestEffect at the given index.
    260260    @param
    261261        The index.
    262262    @return
    263         Returns the failEffect of the given index. NULL if there is no element on the given index.
     263        Returns a pointer to the fail QuestEffect at the given index. NULL if there is no element at the given index.
    264264    */
    265265    const QuestEffect* Quest::getFailEffect(unsigned int index) const
    … …  
    267267        int i = index;
    268268       
    269         //! Iterate through all failEffects.
     269        //! Iterate through all fail QuestEffects.
    270270        for (std::list<QuestEffect*>::const_iterator effect = this->failEffects_.begin(); effect != this->failEffects_.end(); ++effect)
    271271        {
    … …  
    281281    /**
    282282    @brief
    283         Returns the completeEffect of the given index.
     283        Returns the complete QuestEffect at the given index.
    284284    @param
    285285        The index.
    286286    @return
    287         Returns the completeEffect of the given index. NULL if there is no element on the given index.
     287        Returns a pointer to the complete QuestEffect at the given index. NULL if there is no element at the given index.
    288288    */
    289289    const QuestEffect* Quest::getCompleteEffect(unsigned int index) const
    … …  
    291291        int i = index;
    292292       
    293         //! Iterate through all completeEffects.
     293        //! Iterate through all complete QuestEffects.
    294294        for (std::list<QuestEffect*>::const_iterator effect = this->completeEffects_.begin(); effect != this->completeEffects_.end(); ++effect)
    295295        {
    … …  
    366366    /**
    367367    @brief
    368         Starts the quest for an input player.
    369     @param player
    370         The player.
    371     @return
    372         Returns true if the quest could be started, false if not.
     368        Starts the Quest for an input player.
     369    @param player
     370        The player.
     371    @return
     372        Returns true if the Quest could be started, false if not.
    373373    */
    374374    bool Quest::start(ControllableEntity* player)
Note: See TracChangeset for help on using the changeset viewer.