Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Dec 7, 2008, 11:39:44 PM (15 years ago)
Author:
dafrick
Message:
  • Changed questStatus to mode in QuestListener.
  • Added new mode 'all' in QuestListener
  • Documented QuestListener
  • Cleaned up some code, replaced tabs with spaces, a.s.o.
File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/questsystem3/src/orxonox/objects/quest/QuestDescription.h

    r2346 r2352  
    2929/**
    3030    @file QuestDescription.h
    31     @brief
    32     Definition of the QuestDescription class.
     31    @brief Definition of the QuestDescription class.
    3332*/
    3433
    … …  
    6463            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestDescription object through XML.
    6564
    66             /**
    67             @brief Returns the title.
    68             @return Returns a string containing the title of the QuestDescription.
    69             */
    70             inline const std::string & getTitle(void) const
    71                 { return this->title_; }
    72            
    73             /**
    74             @brief Returns the description text.
    75             @return Returns a string containing the description text of the QuestDescription.
    76             */
    77             inline const std::string & getDescription(void) const
    78                 { return this->description_; }
    79                
    80             /**
    81             @brief Returns the fail message.
    82             @return Returns a string containing the fail message of the QuestDescription.
    83             */
    84             inline const std::string & getFailMessage(void) const
    85                 { return this->failMessage_; }
    86                
    87             /**
    88             @brief Returns the complete message.
    89             @return Returns a string containing the complete message of the QuestDescription.
    90             */
    91             inline const std::string & getCompleteMessage(void) const
    92                 { return this->completeMessage_; }
    93            
    94             /**
    95             @brief Sends a Notification displaying that a QuestHint was added.
    96             @return Returns true if successful.
    97             */
    98             inline bool sendAddHintNotification(void) const
     65            /**
     66            @brief Returns the title.
     67            @return Returns a string containing the title of the QuestDescription.
     68            */
     69            inline const std::string & getTitle(void) const
     70                { return this->title_; }
     71       
     72            /**
     73            @brief Returns the description text.
     74            @return Returns a string containing the description text of the QuestDescription.
     75            */
     76            inline const std::string & getDescription(void) const
     77                { return this->description_; }
     78       
     79            /**
     80            @brief Returns the fail message.
     81            @return Returns a string containing the fail message of the QuestDescription.
     82            */
     83            inline const std::string & getFailMessage(void) const
     84                { return this->failMessage_; }
     85       
     86            /**
     87            @brief Returns the complete message.
     88            @return Returns a string containing the complete message of the QuestDescription.
     89            */
     90            inline const std::string & getCompleteMessage(void) const
     91                { return this->completeMessage_; }
     92       
     93            /**
     94            @brief Sends a Notification displaying that a QuestHint was added.
     95            @return Returns true if successful.
     96            */
     97            inline bool sendAddHintNotification(void) const
    9998                { return notificationHelper("hint", ""); }
    100            
    101             /**
    102             @brief Sends a Notification displaying that a Quest was added.
    103             @return Returns true if successful.
    104             */
    105             inline bool sendAddQuestNotification(void) const
     99       
     100            /**
     101            @brief Sends a Notification displaying that a Quest was added.
     102            @return Returns true if successful.
     103            */
     104            inline bool sendAddQuestNotification(void) const
    106105                { return notificationHelper("quest", "start"); }
    107            
    108             /**
    109             @brief Sends a Notification displaying that a Quest was failed.
    110             @return Returns true if successful.
    111             */
    112             inline bool sendFailQuestNotification(void) const
     106       
     107            /**
     108            @brief Sends a Notification displaying that a Quest was failed.
     109            @return Returns true if successful.
     110            */
     111            inline bool sendFailQuestNotification(void) const
    113112                { return notificationHelper("quest", "fail"); }
    114            
    115             /**
    116             @brief Sends a Notification displaying that a Quest was completed.
    117             @return Returns true if successful.
    118             */
    119             inline bool sendCompleteQuestNotification(void) const
     113       
     114            /**
     115            @brief Sends a Notification displaying that a Quest was completed.
     116            @return Returns true if successful.
     117            */
     118            inline bool sendCompleteQuestNotification(void) const
    120119                { return notificationHelper("quest", "complete"); }
    121120
    … …  
    149148                { this->failMessage_ = message; }
    150149               
    151             /**
     150            /**
    152151            @brief Sets the complete message.
    153152            @param message The complete message to be set.
Note: See TracChangeset for help on using the changeset viewer.