Context Navigation

modules

Timestamp:

Aug 31, 2010, 8:56:01 PM (14 years ago)

Author:

landauf

Message:

XML code has to be enclosed in @code and @endcode tags or Doxygen will complain

Location:

code/branches/doc/src/modules

Files:

-                      r7297
+                      r7298
         Creating a NotificationQueue through XML goes as follows:
+        Be aware that the NotificationQueue must be inside the <Level></Level> tags or bad things will happen.
+        Be aware that the NotificationQueue must be inside the @code <Level></Level> @endcode tags or bad things will happen.
+        @code
         <NotificationQueue
             name = "SuperQueue" //Name of your OverlayQueue.
 …
             position = "0.0, 0.0" //The position of the NotificationQueue. (Default is 0.0,0.0)
         />
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r5781
+                      r7298
         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.
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r5781
+                      r7298
         Adds a QuestHint, resp. activates the QuestHint of the given id for the player the QuestEffect is invoked on.
     Creating a AddQuestHint through XML goes as follows:
+        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.
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r5781
+                      r7298
         Creating a AddReward through XML goes as follows:
+        @code
         <AddReward>
             <Rewardable /> //A list of Rewardable objects to be rewarded the player, see the specific Rewardables for their respective XML representations.
 …
             <Rewardable />
         </AddReward>
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r5781
+                      r7298
         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.
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r5781
+                      r7298
         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.
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r5781
+                      r7298
         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
             <QuestDescription title="Title" description="Description." /> //The description of the quest.
 …
             </reward-effects>
         </GlobalQuest>
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r5781
+                      r7298
         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
             <QuestDescription title="Title" description="Description." /> //The description of the quest.
 …
             </complete-effects>
         </LocalQuest>
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r7163
+                      r7298
         Creating a QuestDescription through XML goes as follows:
+        @code
         <QuestDescription title="Title" description="Description Text" failMessage="You fail." completeMessage="You win!" />
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r6800
+                      r7298
         Creating a QuestEffectBeacon through XML goes as follows:
+        @code
         <QuestEffectBeacon times=n> //Where 'n' is eighter a number >= 0, which means the QuestEffectBeacon can be executed n times. Or n = -1, which means the QuestEffectBeacon can be executed an infinite number of times.
             <effects>
 …
             </attached>
         </QuestEffectBeacon>
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r7163
+                      r7298
         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
             <QuestDesctription title="" description="" />
         </QuestHint>
+        @endcode
     @author
         Damian 'Mozork' Frick

-                      r5781
+                      r7298
         You can use the QuestListener as if it were a Trigger or EventListener, that fires an Event when the status (depending on the set mode) of the given Quest changes.
+        @code
         <BaseObject> // The object that should react to the status change of a Quest.
             <events>
 …
             </events>
         </BaseObject>
+        @endcode
     @author
     Damian 'Mozork' Frick

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