Changeset 10418 for code/branches/core7/src/libraries/core/UpdateListener.h

Timestamp:

May 3, 2015, 1:54:43 PM (9 years ago)

Author:

landauf

Message:

improved documentation

File:

• code/branches/core7/src/libraries/core/UpdateListener.h (modified) (1 diff)

code/branches/core7/src/libraries/core/UpdateListener.h

@@ -36 +36 @@
 namespace orxonox
 {
+    /**
+     * Inherit from UpdateListener if you need to receive calls before or after the game is ticked. All classes inheriting from UpdateListener
+     * need to be strictly independent of each other and may not rely on a specific order in which all UpdateListeners are called.
+     *
+     * If you do have such a dependency between two UpdateListeners, e.g. A::preUpdate() always needs to be called before B::preUpdate(), then
+     * you need to create a third class C (which inherits from UpdateListener) with the following implementation:
+     * void C::preUpdate()
+     * {
+     *     A::preUpdate();
+     *     B::preUpdate();
+     * }
+     * This is the only way to ensure that A gets called before B. In this example, only C inherits from UpdateListener, while A and B do not.
+     * Instead they receive the update from C.
+     */
     class _CoreExport UpdateListener : virtual public Listable
     {