Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutorial3/src/modules/overlays/hud/ChatOverlay.cc @ 10904

Last change on this file since 10904 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: 2.9 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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#include "ChatOverlay.h"
30
31#include <string>
32#include <OgreTextAreaOverlayElement.h>
33
34#include "util/Convert.h"
35#include "util/DisplayStringConversions.h"
36#include "core/CoreIncludes.h"
37#include "core/ConfigValueIncludes.h"
38#include "core/command/Executor.h"
39
40#include "tools/Timer.h"
41#include "infos/PlayerInfo.h"
42#include "PlayerManager.h"
43
44namespace orxonox
45{
46    CreateFactory(ChatOverlay);
47
48    ChatOverlay::ChatOverlay(BaseObject* creator)
49        : OverlayText(creator)
50    {
51        RegisterObject(ChatOverlay);
52
53        this->displayTime_ = 0.0;
54
55        this->setConfigValues();
56    }
57
58    ChatOverlay::~ChatOverlay()
59    {
60        for (std::set<Timer*>::iterator it = this->timers_.begin(); it != this->timers_.end(); ++it)
61            delete (*it);
62    }
63
64    void ChatOverlay::setConfigValues()
65    {
66        SetConfigValue(displayTime_, 6.0f);
67    }
68
69    void ChatOverlay::incomingChat(const std::string& message, const std::string& /*name*/)
70    {
71        this->messages_.push_back(multi_cast<Ogre::DisplayString>(message));
72
73        Timer* timer = new Timer();
74        this->timers_.insert(timer); // store the timer in a set to destroy it in the destructor
75        const ExecutorPtr& executor = createExecutor(createFunctor(&ChatOverlay::dropMessage, this));
76        executor->setDefaultValues(timer);
77        timer->setTimer(this->displayTime_, false, executor, true);
78
79        this->updateOverlayText();
80    }
81
82    void ChatOverlay::dropMessage(Timer* timer)
83    {
84        if (this->messages_.size() > 0)
85            this->messages_.pop_front();
86        this->updateOverlayText();
87        this->timers_.erase(timer); // the timer destroys itself, but we have to remove it from the set
88    }
89
90    void ChatOverlay::updateOverlayText()
91    {
92        this->text_->setCaption("");
93
94        for (std::list<Ogre::DisplayString>::iterator it = this->messages_.begin(); it != this->messages_.end(); ++it)
95        {
96            this->text_->setCaption(this->text_->getCaption() + "\n" + (*it));
97        }
98    }
99}
Note: See TracBrowser for help on using the repository browser.