aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim
diff options
context:
space:
mode:
authorSignpostMarv2012-11-11 00:39:10 +0000
committerDiva Canto2012-11-10 17:09:47 -0800
commitd5f9f5c9c347f6d858bf91de87a5ba71ba06082a (patch)
tree4a033b07150bb7f9201ad57965e0a65165290f57 /OpenSim
parentdocument & 80-character width terminal formatting (diff)
downloadopensim-SC_OLD-d5f9f5c9c347f6d858bf91de87a5ba71ba06082a.zip
opensim-SC_OLD-d5f9f5c9c347f6d858bf91de87a5ba71ba06082a.tar.gz
opensim-SC_OLD-d5f9f5c9c347f6d858bf91de87a5ba71ba06082a.tar.bz2
opensim-SC_OLD-d5f9f5c9c347f6d858bf91de87a5ba71ba06082a.tar.xz
document, 80-character width terminal formatting converting comments to documentation for IDE & doxygen goodness
Signed-off-by: Diva Canto <diva@metaverseink.com>
Diffstat (limited to 'OpenSim')
-rw-r--r--OpenSim/Region/CoreModules/Scripting/WorldComm/WorldCommModule.cs80
1 files changed, 65 insertions, 15 deletions
diff --git a/OpenSim/Region/CoreModules/Scripting/WorldComm/WorldCommModule.cs b/OpenSim/Region/CoreModules/Scripting/WorldComm/WorldCommModule.cs
index c88be82..2d2ea2f 100644
--- a/OpenSim/Region/CoreModules/Scripting/WorldComm/WorldCommModule.cs
+++ b/OpenSim/Region/CoreModules/Scripting/WorldComm/WorldCommModule.cs
@@ -744,10 +744,23 @@ namespace OpenSim.Region.CoreModules.Scripting.WorldComm
744 744
745 #endregion 745 #endregion
746 746
747 // Theres probably a more clever and efficient way to 747 /// <summary>
748 // do this, maybe with regex. 748 /// Get listeners matching the input parameters.
749 // PM2008: Ha, one could even be smart and define a specialized Enumerator. 749 /// </summary>
750 public List<ListenerInfo> GetListeners(UUID itemID, int channel, string name, UUID id, string msg) 750 /// <remarks>
751 /// Theres probably a more clever and efficient way to do this, maybe
752 /// with regex.
753 /// PM2008: Ha, one could even be smart and define a specialized
754 /// Enumerator.
755 /// </remarks>
756 /// <param name="itemID"></param>
757 /// <param name="channel"></param>
758 /// <param name="name"></param>
759 /// <param name="id"></param>
760 /// <param name="msg"></param>
761 /// <returns></returns>
762 public List<ListenerInfo> GetListeners(UUID itemID, int channel,
763 string name, UUID id, string msg)
751 { 764 {
752 List<ListenerInfo> collection = new List<ListenerInfo>(); 765 List<ListenerInfo> collection = new List<ListenerInfo>();
753 766
@@ -845,17 +858,54 @@ namespace OpenSim.Region.CoreModules.Scripting.WorldComm
845 858
846 public class ListenerInfo : IWorldCommListenerInfo 859 public class ListenerInfo : IWorldCommListenerInfo
847 { 860 {
848 private bool m_active; // Listener is active or not 861 /// <summary>
849 private int m_handle; // Assigned handle of this listener 862 /// Listener is active or not
850 private uint m_localID; // Local ID from script engine 863 /// </summary>
851 private UUID m_itemID; // ID of the host script engine 864 private bool m_active;
852 private UUID m_hostID; // ID of the host/scene part 865
853 private int m_channel; // Channel 866 /// <summary>
854 private UUID m_id; // ID to filter messages from 867 /// Assigned handle of this listener
855 private string m_name; // Object name to filter messages from 868 /// </summary>
856 private string m_message; // The message 869 private int m_handle;
857 870
858 public ListenerInfo(int handle, uint localID, UUID ItemID, UUID hostID, int channel, string name, UUID id, string message) 871 /// <summary>
872 /// Local ID from script engine
873 /// </summary>
874 private uint m_localID;
875
876 /// <summary>
877 /// ID of the host script engine
878 /// </summary>
879 private UUID m_itemID;
880
881 /// <summary>
882 /// ID of the host/scene part
883 /// </summary>
884 private UUID m_hostID;
885
886 /// <summary>
887 /// Channel
888 /// </summary>
889 private int m_channel;
890
891 /// <summary>
892 /// ID to filter messages from
893 /// </summary>
894 private UUID m_id;
895
896 /// <summary>
897 /// Object name to filter messages from
898 /// </summary>
899 private string m_name;
900
901 /// <summary>
902 /// The message
903 /// </summary>
904 private string m_message;
905
906 public ListenerInfo(int handle, uint localID, UUID ItemID,
907 UUID hostID, int channel, string name, UUID id,
908 string message)
859 { 909 {
860 Initialise(handle, localID, ItemID, hostID, channel, name, id, 910 Initialise(handle, localID, ItemID, hostID, channel, name, id,
861 message, 0); 911 message, 0);