Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/QuestDescription.cc @ 8898

Last change on this file since 8898 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 4.0 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file QuestDescription.cc
31    @brief Implementation of the QuestDescription class.
32*/
33
34
35#include "QuestDescription.h"
36
37#include "core/CoreIncludes.h"
38#include "core/XMLPort.h"
39
40#include "infos/PlayerInfo.h"
41
42#include "interfaces/NotificationListener.h"
43
44namespace orxonox
45{
46    CreateFactory(QuestDescription);
47
48    /*static*/ const std::string QuestDescription::SENDER = "questsystem";
49
50    /**
51    @brief
52        Constructor. Registers and initializes the object.
53    */
54    QuestDescription::QuestDescription(BaseObject* creator) : BaseObject(creator)
55    {
56        RegisterObject(QuestDescription);
57    }
58
59    /**
60    @brief
61        Destructor.
62    */
63    QuestDescription::~QuestDescription()
64    {
65
66    }
67
68    /**
69    @brief
70        Method for creating a QuestDescription object through XML.
71    */
72    void QuestDescription::XMLPort(Element& xmlelement, XMLPort::Mode mode)
73    {
74        SUPER(QuestDescription, XMLPort, xmlelement, mode);
75
76        XMLPortParam(QuestDescription, "title", setTitle, getTitle, xmlelement, mode);
77        XMLPortParam(QuestDescription, "description", setDescription, getDescription, xmlelement, mode);
78        XMLPortParam(QuestDescription, "failMessage", setFailMessage, getFailMessage, xmlelement, mode);
79        XMLPortParam(QuestDescription, "completeMessage", setCompleteMessage, getCompleteMessage, xmlelement, mode);
80
81        orxout(verbose, context::quests) << "New QuestDescription with title '" << this->getTitle() << "' created." << endl;
82    }
83
84    /**
85    @brief
86        This method is a helper for sending QuestDescriptions as Notifications.
87    @param item
88        The item the QuestDescription is for.
89    @param status
90        The status the QuestDescription us for.
91    @param player
92        The player the Notification is sent to.
93    @return
94        Returns true if successful.
95    */
96    bool QuestDescription::notificationHelper(const std::string & item, const std::string & status, PlayerInfo* player)
97    {
98        std::string message;
99        if(item == "hint")
100            message = "You received a hint: '" + this->title_ + '\'';
101        else if(item == "quest")
102        {
103            if(status == "start")
104                message = "You received a new quest: '" + this->title_ + '\'';
105            else if(status == "fail")
106                message = "You failed the quest: '" + this->title_ + '\'';
107            else if(status == "complete")
108                message = "You successfully completed the quest: '" + this->title_ + '\'';
109            else
110            {
111                orxout(internal_warning, context::quests) << "Bad input in notificationHelper, this should not be happening!" << endl;
112                return false;
113            }
114        }
115        else
116        {
117            orxout(internal_warning, context::quests) << "Bad input in notificationHelper, this should not be happening!" << endl;
118            return false;
119        }
120
121        NotificationListener::sendNotification(message, QuestDescription::SENDER, notificationMessageType::info, notificationSendMode::network, player->getClientID());
122        return true;
123    }
124
125
126}
Note: See TracBrowser for help on using the repository browser.