Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/effects/AddQuestHint.cc @ 9381

Last change on this file since 9381 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: 3.4 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 AddQuestHint.cc
31    @brief Implementation of the AddQuestHint class.
32*/
33
34#include "AddQuestHint.h"
35
36#include "core/CoreIncludes.h"
37#include "core/XMLPort.h"
38#include "util/Exception.h"
39
40#include "questsystem/QuestHint.h"
41#include "questsystem/QuestManager.h"
42#include "questsystem/QuestItem.h"
43
44namespace orxonox
45{
46    CreateFactory(AddQuestHint);
47
48    /**
49    @brief
50        Constructor. Registers the object.
51    */
52    AddQuestHint::AddQuestHint(BaseObject* creator) : QuestEffect(creator)
53    {
54        RegisterObject(AddQuestHint);
55    }
56
57    /**
58    @brief
59        Destructor.
60    */
61    AddQuestHint::~AddQuestHint()
62    {
63    }
64
65    /**
66    @brief
67        Method for creating a AddQuestHint object through XML.
68    */
69    void AddQuestHint::XMLPort(Element& xmlelement, XMLPort::Mode mode)
70    {
71        SUPER(AddQuestHint, XMLPort, xmlelement, mode);
72
73        XMLPortParam(AddQuestHint, "hintId", setHintId, getHintId, xmlelement, mode);
74
75        orxout(verbose, context::quests) << "New AddQuestHint, with target QuestHint {" << this->getHintId() << "}, created." << endl;
76    }
77
78    /**
79    @brief
80        Sets the id of the QuestHint to be added to the player the QuestEffect is invoked on.
81    @param id
82        The QuestHint id.
83    @return
84        Returns true if successful.
85    */
86    bool AddQuestHint::setHintId(const std::string & id)
87    {
88        if(id == "")
89        {
90            orxout(internal_warning, context::quests) << "Invalid id. QuestItem id {" << id << "} could not be set." << endl;
91            return false;
92        }
93
94        this->hintId_ = id;
95        return true;
96    }
97
98    /**
99    @brief
100        Invokes the QuestEffect.
101    @param player
102        The player.
103    @return
104        Returns true if the QuestEffect was successfully invoked.
105    */
106    bool AddQuestHint::invoke(PlayerInfo* player)
107    {
108        assert(player);
109
110        orxout(verbose_more, context::quests) << "AddQuestHint on player: " << player << " ." << endl;
111
112        try
113        {
114            QuestHint* hint = QuestManager::getInstance().findHint(this->hintId_);
115            if(hint == NULL || !hint->setActive(player))
116                return false;
117        }
118        catch(const Exception& e)
119        {
120           orxout(internal_warning, context::quests) << e.getFullDescription() << endl;
121           return false;
122        }
123
124        orxout(verbose, context::quests) << "QuestHint {" << this->getHintId() << "} successfully added to player: " << player << " ." << endl;
125        return true;
126
127    }
128}
Note: See TracBrowser for help on using the repository browser.