Context Navigation

Changeset 7310 for code/branches/doc

Timestamp:

Sep 1, 2010, 11:58:35 AM (14 years ago)

Author:

dafrick

Message:

Removed necessity for GUID as id for quests, since it is not very readable in the level file.

Location:

code/branches/doc/src/modules/questsystem

Files:

r7298	r7310
47	47
48	48	@code
49		<AddQuest questId="id" /> //Where id i~~s a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and i~~dentifies the Quest that should be added.
	49	<AddQuest questId="id" /> //Where id identifies the Quest that should be added.
50	50	@endcode
51	51	@author

r7298	r7310
49	49
50	50	@code
51		<AddQuestHint hintId="id" /> //Where id i~~s a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and i~~dentifies the QuestHint that should be added.
	51	<AddQuestHint hintId="id" /> //Where id identifies the QuestHint that should be added.
52	52	@endcode
53	53	@author

r7298	r7310
47	47
48	48	@code
49		<CompleteQuest questId="id" /> //Where id i~~s a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and i~~dentifies the Quest that should be completed.
	49	<CompleteQuest questId="id" /> //Where id identifies the Quest that should be completed.
50	50	@endcode
51	51	@author

r7298	r7310
47	47
48	48	@code
49		<FailQuest questId="id" /> //Where id i~~s a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and i~~dentifies the Quest that should be failed.
	49	<FailQuest questId="id" /> //Where id identifies the Quest that should be failed.
50	50	@endcode
51	51	@author

r7298	r7310
51	51
52	52	@code
53		<GlobalQuest id="questId"> ~~//Where questId is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information~~
	53	<GlobalQuest id="questId">
54	54	<QuestDescription title="Title" description="Description." /> //The description of the quest.
55	55	<subquests>

r7298	r7310
50	50
51	51	@code
52		<LocalQuest id="questId"> ~~//Where questId is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information~~
	52	<LocalQuest id="questId">
53	53	<QuestDescription title="Title" description="Description." /> //The description of the quest.
54	54	<subquests>

r7298	r7310
61	61
62	62	@code
63		<QuestHint id="hintId"> ~~//Where hintId is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information~~
	63	<QuestHint id="hintId">
64	64	<QuestDesctription title="" description="" />
65	65	</QuestHint>

-                      r7307
+                      r7310
     /**
     @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

r7163	r7310
98	98
99	99	private:
100		std::string id_; //!< Identifier. ~~Should be of GUID form: http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure~~
	100	std::string id_; //!< Identifier. Must be unique.
101	101	QuestDescription* description_; //!< The QuestDescription of the QuestItem.
102	102

Note: See TracChangeset for help on using the changeset viewer.