From 445e8bc56017fe70a94e80b6f3306b8f17c56747 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 28 Mar 2012 01:08:56 +0100
Subject: minor: Add some documentation to OnNewClient and OnClientClosed
events
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
(limited to 'OpenSim/Region/Framework/Scenes')
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
public delegate void OnNewClientDelegate(IClientAPI client);
///
- /// Deprecated in favour of OnClientConnect.
- /// Will be marked Obsolete after IClientCore has 100% of IClientAPI interfaces.
+ /// Triggered when a new client is added to the scene.
///
+ ///
+ /// Triggered before OnClientLogin.
+ ///
public event OnNewClientDelegate OnNewClient;
///
@@ -188,6 +190,12 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void ClientClosed(UUID clientID, Scene scene);
+ ///
+ /// Fired when a client is removed from a scene.
+ ///
+ ///
+ /// At the point of firing, the scene still contains the client's scene presence.
+ ///
public event ClientClosed OnClientClosed;
public delegate void NewScript(UUID clientID, SceneObjectPart part, UUID itemID);
--
cgit v1.1