Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/objects/quest/CompleteQuest.h @ 2743

Last change on this file since 2743 was 2710, checked in by rgrieder, 16 years ago

Merged buildsystem3 containing buildsystem2 containing Adi's buildsystem branch back to the trunk.
Please update the media directory if you were not using buildsystem3 before.

File size: 2.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
31    @brief Definition of the CompleteQuest class.
32*/
33
34#ifndef _CompleteQuest_H__
35#define _CompleteQuest_H__
36
37#include "OrxonoxPrereqs.h"
38
39#include <string>
40
41#include "core/XMLPort.h"
42#include "ChangeQuestStatus.h"
43
44namespace orxonox
45{
46    /**
47    @brief
48        Completes a Quest (with a specified id) for the player invoking the QuestEffect.
49       
50        Creating a CompleteQuest through XML goes as follows:
51       
52        <CompleteQuest questId="id" />  //Where id is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and identifies the Quest that should be completed.
53    @author
54        Damian 'Mozork' Frick
55    */
56    class _OrxonoxExport CompleteQuest : public ChangeQuestStatus
57    {
58        public:
59            CompleteQuest(BaseObject* creator);
60            virtual ~CompleteQuest();
61
62            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a CompleteQuest object through XML.
63
64            virtual bool invoke(PlayerInfo* player); //!< Invokes the QuestEffect.
65
66    };
67
68}
69
70#endif /* _CompleteQuest_H__ */
Note: See TracBrowser for help on using the repository browser.