Changeset 7601 for code/trunk/src/modules/objects/triggers/EventMultiTrigger.h

Timestamp:

Oct 30, 2010, 1:54:49 PM (14 years ago)

Author:

dafrick

Message:

Adding all classes in modules/objects to Objects module (in doxygen).
Created TriggerBase which is the base class of Trigger and MultiTrigger and now provides the shared functionality and data.
Updated some of the documentation in MultiTrigger and Script.

File:

• code/trunk/src/modules/objects/triggers/EventMultiTrigger.h (modified) (4 diffs)

code/trunk/src/modules/objects/triggers/EventMultiTrigger.h

@@ -30 +30 @@
     @file EventMultiTrigger.h
     @brief Definition of the EventMultiTrigger class.
+    @ingroup MultiTrigger
 */
 
@@ -44 +45 @@
     /**
     @brief
-        The EventMultiTrigger class is the equivalent of the EventTrigger class for MultiTriggers.
-        Consequentially what it does is it provides a way to have a MultiTrigger triggered by any kinds of events.
-        Events that are not caused by a MultiTrigger or by a MultiTrigger with an originator that is no target of this EventMultiTrigger are broadcasted to all entities that are the target of this EventMultitrigger. Events that are caused by MultiTriggers with an originator that is a target of this EventMultiTrigger just trigger the EventMultiTrigger for the originator that caused the MultiTrigger to trigger. Thus showing the equivalent behavior to the EventTrigger.
+        The EventMultiTrigger class is the equivalent of the @ref orxonox::EventTrigger "EventTrigger" class for MultiTriggers.
+        Consequentially what it does is it provides a way to have a MultiTrigger triggered by any kinds of @ref orxonox::Event "Events".
+        @ref orxonox::Event "Events" that are not caused by a MultiTrigger, or that are caused by a MultiTrigger with an originator that is no target of this EventMultiTrigger, are broadcasted to all entities that are the target of this EventMultiTrigger. @ref orxonox::Event "Events" that are caused by @ref orxonox::MultiTrigger "MultiTriggers" with an originator that is a target of this EventMultiTrigger just trigger the EventMultiTrigger for the originator that caused the MultiTrigger to trigger. Thus showing the equivalent behavior to the @ref orxonox::EventTrigger "EventTrigger".
 
         Example:
@@ -59 +60 @@
         </EventMultiTrigger>
         @endcode
-    @see MultiTrigger.h
+
+    @see MultiTrigger
         For more information on MultiTriggers.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup MultiTrigger
     */
     class _ObjectsExport EventMultiTrigger : public MultiTrigger
@@ -75 +80 @@
 
         private:
-            void trigger(bool bTriggered, BaseObject* originator); //!< Method that causes the EventMultiTrigger to trigger upon receiving an event.
+            void trigger(bool bTriggered, BaseObject* originator); //!< Method that causes the EventMultiTrigger to trigger upon receiving an @ref orxonox::Event "Event".
 
     };