Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/lodfinal/src/orxonox/objects/quest/CompleteQuest.h @ 3002

Last change on this file since 3002 was 2261, checked in by landauf, 16 years ago

merged questsystem2 back to trunk

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