Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/QuestNotification.cc @ 7456

Last change on this file since 7456 was 7456, checked in by dafrick, 14 years ago

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

  • Property svn:eol-style set to native
File size: 2.3 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 thes
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 QuestNotification.cc
31    @brief Implementation of the QuestNotification class.
32*/
33
34#include "QuestNotification.h"
35#include "core/CoreIncludes.h"
36#include "infos/PlayerInfo.h"
37
38namespace orxonox {
39
40    /*static*/ const std::string QuestNotification::SENDER("questsystem");
41
42    CreateUnloadableFactory(QuestNotification);
43
44    /**
45    @brief
46        Default Constructor. Creates a useless QuestNotification.
47    */
48    QuestNotification::QuestNotification(BaseObject* creator) : Notification(creator)
49    {
50        RegisterObject(QuestNotification);
51    }
52
53    /**
54    @brief
55        Creates a QuestNotification with the input message.
56    @param creator
57        The creator of this object
58    @param message
59        The message to be sent.
60    */
61    QuestNotification::QuestNotification(BaseObject* creator, const std::string & message) : Notification(creator, message)
62    {
63        RegisterObject(QuestNotification);
64    }
65
66    /**
67    @brief
68        Destructor.
69    */
70    QuestNotification::~QuestNotification()
71    {
72
73    }
74
75    /**
76    @brief
77        Send the QuestNotification.
78    @param player
79        The player the Notification is sent to.
80    @return
81        Returns true if successful.
82    */
83    bool QuestNotification::send(PlayerInfo* player)
84    {
85        return this->Notification::send(player->getClientID(), QuestNotification::SENDER);
86    }
87
88
89}
Note: See TracBrowser for help on using the repository browser.