diff options
author | Justin Clark-Casey (justincc) | 2012-03-28 01:08:56 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2012-03-28 01:08:56 +0100 |
commit | 445e8bc56017fe70a94e80b6f3306b8f17c56747 (patch) | |
tree | 830ca1c0ba9fe682c7475137cd9720527759b807 /OpenSim/Region/Framework | |
parent | Merge branch 'master' of ssh://opensimulator.org/var/git/opensim (diff) | |
download | opensim-SC_OLD-445e8bc56017fe70a94e80b6f3306b8f17c56747.zip opensim-SC_OLD-445e8bc56017fe70a94e80b6f3306b8f17c56747.tar.gz opensim-SC_OLD-445e8bc56017fe70a94e80b6f3306b8f17c56747.tar.bz2 opensim-SC_OLD-445e8bc56017fe70a94e80b6f3306b8f17c56747.tar.xz |
minor: Add some documentation to OnNewClient and OnClientClosed events
Diffstat (limited to 'OpenSim/Region/Framework')
-rw-r--r-- | OpenSim/Region/Framework/Scenes/EventManager.cs | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs index 1e1fcb7..7993abe 100644 --- a/OpenSim/Region/Framework/Scenes/EventManager.cs +++ b/OpenSim/Region/Framework/Scenes/EventManager.cs | |||
@@ -68,9 +68,11 @@ namespace OpenSim.Region.Framework.Scenes | |||
68 | public delegate void OnNewClientDelegate(IClientAPI client); | 68 | public delegate void OnNewClientDelegate(IClientAPI client); |
69 | 69 | ||
70 | /// <summary> | 70 | /// <summary> |
71 | /// Deprecated in favour of OnClientConnect. | 71 | /// Triggered when a new client is added to the scene. |
72 | /// Will be marked Obsolete after IClientCore has 100% of IClientAPI interfaces. | ||
73 | /// </summary> | 72 | /// </summary> |
73 | /// <remarks> | ||
74 | /// Triggered before OnClientLogin. | ||
75 | /// </remarks> | ||
74 | public event OnNewClientDelegate OnNewClient; | 76 | public event OnNewClientDelegate OnNewClient; |
75 | 77 | ||
76 | /// <summary> | 78 | /// <summary> |
@@ -188,6 +190,12 @@ namespace OpenSim.Region.Framework.Scenes | |||
188 | 190 | ||
189 | public delegate void ClientClosed(UUID clientID, Scene scene); | 191 | public delegate void ClientClosed(UUID clientID, Scene scene); |
190 | 192 | ||
193 | /// <summary> | ||
194 | /// Fired when a client is removed from a scene. | ||
195 | /// </summary> | ||
196 | /// <remarks> | ||
197 | /// At the point of firing, the scene still contains the client's scene presence. | ||
198 | /// </remarks> | ||
191 | public event ClientClosed OnClientClosed; | 199 | public event ClientClosed OnClientClosed; |
192 | 200 | ||
193 | public delegate void NewScript(UUID clientID, SceneObjectPart part, UUID itemID); | 201 | public delegate void NewScript(UUID clientID, SceneObjectPart part, UUID itemID); |