Changeset 7486 for code/trunk/src/modules/notifications

Timestamp:

Sep 23, 2010, 11:54:16 PM (14 years ago)

Author:

dafrick

Message:

Cleanup in Script. Some more documenting in Notifications module.

Location:

code/trunk/src/modules/notifications

Files:

• Notification.h (modified) (1 diff)
• NotificationManager.cc (modified) (1 diff)
• NotificationManager.h (modified) (1 diff)
• NotificationQueue.h (modified) (2 diffs)

code/trunk/src/modules/notifications/Notification.h

@@ -40 +40 @@
 #include <string>
 #include "core/BaseObject.h"
-#include "network/synchronisable/Synchronisable.h"
 
 namespace orxonox

code/trunk/src/modules/notifications/NotificationManager.cc

@@ -116 +116 @@
     @param sender
         The sender that sent the notification.
-    */
-    /*static*/ void NotificationManager::sendNotification(const std::string& message, unsigned int clientId, const std::string& sender)
+    @param isLocal
+        If this is set to true (false is default), then the Notification is sent to the client where this function is executed, meaning the Notification is sent locally.
+    */
+    /*static*/ void NotificationManager::sendNotification(const std::string& message, unsigned int clientId, const std::string& sender, bool isLocal)
     {
         // If we're in standalone mode or we're already no the right client we create and send the Notification.
-        if(GameMode::isStandalone() || Host::getPlayerID() == clientId)
+        if(GameMode::isStandalone() || isLocal || Host::getPlayerID() == clientId)
         {
             Notification* notification = new Notification(message);

code/trunk/src/modules/notifications/NotificationManager.h

@@ -76 +76 @@
 
             //! Sends a Notification with the specified message to the specified client from the specified sender.
-            static void sendNotification(const std::string& message, unsigned int clientId, const std::string& sender = NotificationManager::NONE);
+            static void sendNotification(const std::string& message, unsigned int clientId, const std::string& sender = NotificationManager::NONE, bool isLocal = false);
 
             bool registerNotification(Notification* notification); //!< Registers a Notification within the NotificationManager.

code/trunk/src/modules/notifications/NotificationQueue.h

@@ -58 +58 @@
     };
 
-    //! Struct to allow ordering of NotificationContainers.
+    //! Struct to allow ordering of @ref orxonox::NotificationContainer "NotificationContainers".
     struct NotificationContainerCompare {
         bool operator() (const NotificationContainer* const & a, const NotificationContainer* const & b) const
@@ -73 +73 @@
         - 'size': The size of the NotificationQueue, it specifies how many @ref orxonox::Notification "Notifications" are displayed at once at the most.
         - 'displayTime': The time a @ref orxonox::Notification "Notification" is displayed with this NotificationQueue.
+
     @author
         Damian 'Mozork' Frick