[Orxonox-commit 2605] r7310 - code/branches/doc/src/modules/questsystem
dafrick at orxonox.net
dafrick at orxonox.net
Wed Sep 1 11:58:35 CEST 2010
Author: dafrick
Date: 2010-09-01 11:58:35 +0200 (Wed, 01 Sep 2010)
New Revision: 7310
Modified:
code/branches/doc/src/modules/questsystem/AddQuest.h
code/branches/doc/src/modules/questsystem/AddQuestHint.h
code/branches/doc/src/modules/questsystem/CompleteQuest.h
code/branches/doc/src/modules/questsystem/FailQuest.h
code/branches/doc/src/modules/questsystem/GlobalQuest.h
code/branches/doc/src/modules/questsystem/LocalQuest.h
code/branches/doc/src/modules/questsystem/QuestHint.h
code/branches/doc/src/modules/questsystem/QuestItem.cc
code/branches/doc/src/modules/questsystem/QuestItem.h
Log:
Removed necessity for GUID as id for quests, since it is not very readable in the level file.
Modified: code/branches/doc/src/modules/questsystem/AddQuest.h
===================================================================
--- code/branches/doc/src/modules/questsystem/AddQuest.h 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/AddQuest.h 2010-09-01 09:58:35 UTC (rev 7310)
@@ -46,7 +46,7 @@
Creating a AddQuest through XML goes as follows:
@code
- <AddQuest 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 added.
+ <AddQuest questId="id" /> //Where id identifies the Quest that should be added.
@endcode
@author
Damian 'Mozork' Frick
Modified: code/branches/doc/src/modules/questsystem/AddQuestHint.h
===================================================================
--- code/branches/doc/src/modules/questsystem/AddQuestHint.h 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/AddQuestHint.h 2010-09-01 09:58:35 UTC (rev 7310)
@@ -48,7 +48,7 @@
Creating a AddQuestHint through XML goes as follows:
@code
- <AddQuestHint hintId="id" /> //Where id is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and identifies the QuestHint that should be added.
+ <AddQuestHint hintId="id" /> //Where id identifies the QuestHint that should be added.
@endcode
@author
Damian 'Mozork' Frick
Modified: code/branches/doc/src/modules/questsystem/CompleteQuest.h
===================================================================
--- code/branches/doc/src/modules/questsystem/CompleteQuest.h 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/CompleteQuest.h 2010-09-01 09:58:35 UTC (rev 7310)
@@ -46,7 +46,7 @@
Creating a CompleteQuest through XML goes as follows:
@code
- <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.
+ <CompleteQuest questId="id" /> //Where id identifies the Quest that should be completed.
@endcode
@author
Damian 'Mozork' Frick
Modified: code/branches/doc/src/modules/questsystem/FailQuest.h
===================================================================
--- code/branches/doc/src/modules/questsystem/FailQuest.h 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/FailQuest.h 2010-09-01 09:58:35 UTC (rev 7310)
@@ -46,7 +46,7 @@
Creating a FailQuest through XML goes as follows:
@code
- <FailQuest 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 failed.
+ <FailQuest questId="id" /> //Where id identifies the Quest that should be failed.
@endcode
@author
Damian 'Mozork' Frick
Modified: code/branches/doc/src/modules/questsystem/GlobalQuest.h
===================================================================
--- code/branches/doc/src/modules/questsystem/GlobalQuest.h 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/GlobalQuest.h 2010-09-01 09:58:35 UTC (rev 7310)
@@ -50,7 +50,7 @@
Creating a GlobalQuest through XML goes as follows:
@code
- <GlobalQuest id="questId"> //Where questId is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information
+ <GlobalQuest id="questId">
<QuestDescription title="Title" description="Description." /> //The description of the quest.
<subquests>
<Quest id ="questId1" /> //A list of n subquest, be aware, each of the <Quest /> tags must have a description and so on and so forth as well.
Modified: code/branches/doc/src/modules/questsystem/LocalQuest.h
===================================================================
--- code/branches/doc/src/modules/questsystem/LocalQuest.h 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/LocalQuest.h 2010-09-01 09:58:35 UTC (rev 7310)
@@ -49,7 +49,7 @@
Creating a LocalQuest through XML goes as follows:
@code
- <LocalQuest id="questId"> //Where questId is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information
+ <LocalQuest id="questId">
<QuestDescription title="Title" description="Description." /> //The description of the quest.
<subquests>
<Quest id ="questId1" /> //A list of n subquest, be aware, each of the <Quest /> tags must have a description and so on and so forth as well.
Modified: code/branches/doc/src/modules/questsystem/QuestHint.h
===================================================================
--- code/branches/doc/src/modules/questsystem/QuestHint.h 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/QuestHint.h 2010-09-01 09:58:35 UTC (rev 7310)
@@ -60,7 +60,7 @@
Creating a QuestHint through XML goes as follows:
@code
- <QuestHint id="hintId"> //Where hintId is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information
+ <QuestHint id="hintId">
<QuestDesctription title="" description="" />
</QuestHint>
@endcode
Modified: code/branches/doc/src/modules/questsystem/QuestItem.cc
===================================================================
--- code/branches/doc/src/modules/questsystem/QuestItem.cc 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/QuestItem.cc 2010-09-01 09:58:35 UTC (rev 7310)
@@ -76,7 +76,8 @@
/**
@brief
- Sets the id of the QuestItem. The id must be of GUID form.
+ Sets the id of the QuestItem.
+ The id can be any string and must be unique in the context it is used (commonly a level file). To ensure uniqueness one could use GUIDs, however they are in general less readable, so make your own choice.
@see
http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure
@param id
Modified: code/branches/doc/src/modules/questsystem/QuestItem.h
===================================================================
--- code/branches/doc/src/modules/questsystem/QuestItem.h 2010-09-01 09:51:39 UTC (rev 7309)
+++ code/branches/doc/src/modules/questsystem/QuestItem.h 2010-09-01 09:58:35 UTC (rev 7310)
@@ -97,7 +97,7 @@
{ this->description_ = description; }
private:
- std::string id_; //!< Identifier. Should be of GUID form: http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure
+ std::string id_; //!< Identifier. Must be unique.
QuestDescription* description_; //!< The QuestDescription of the QuestItem.
bool registered_;
More information about the Orxonox-commit
mailing list