aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorSignpostMarv2012-09-19 15:00:02 +0100
committerJustin Clark-Casey (justincc)2012-09-20 01:48:50 +0100
commit61f4523e01b11ac116ab0c1a86075126039f481b (patch)
tree7781145dd12810e78381f509d17b27aafa9f1a76
parentDocumentation of OnPluginConsole (diff)
downloadopensim-SC_OLD-61f4523e01b11ac116ab0c1a86075126039f481b.zip
opensim-SC_OLD-61f4523e01b11ac116ab0c1a86075126039f481b.tar.gz
opensim-SC_OLD-61f4523e01b11ac116ab0c1a86075126039f481b.tar.bz2
opensim-SC_OLD-61f4523e01b11ac116ab0c1a86075126039f481b.tar.xz
Documentation of object-related events
-rw-r--r--OpenSim/Region/Framework/Scenes/EventManager.cs39
1 files changed, 38 insertions, 1 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 1025943..7024bd6 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -238,12 +238,34 @@ namespace OpenSim.Region.Framework.Scenes
238 /// <summary> 238 /// <summary>
239 /// Fired when an object is touched/grabbed. 239 /// Fired when an object is touched/grabbed.
240 /// </summary> 240 /// </summary>
241 /// <remarks>
241 /// The originalID is the local ID of the part that was actually touched. The localID itself is always that of 242 /// The originalID is the local ID of the part that was actually touched. The localID itself is always that of
242 /// the root part. 243 /// the root part.
244 /// Triggerd in response to <see cref="OpenSim.Framework.IClientAPI.OnGrabObject"/>
245 /// via <see cref="TriggerObjectGrab"/>
246 /// in <see cref="Scene.ProcessObjectGrab"/>
247 /// </remarks>
243 public event ObjectGrabDelegate OnObjectGrab; 248 public event ObjectGrabDelegate OnObjectGrab;
244 public delegate void ObjectGrabDelegate(uint localID, uint originalID, Vector3 offsetPos, IClientAPI remoteClient, SurfaceTouchEventArgs surfaceArgs); 249 public delegate void ObjectGrabDelegate(uint localID, uint originalID, Vector3 offsetPos, IClientAPI remoteClient, SurfaceTouchEventArgs surfaceArgs);
245 250
251 /// <summary>
252 /// Triggered when an object is being touched/grabbed continuously.
253 /// </summary>
254 /// <remarks>
255 /// Triggered in response to <see cref="OpenSim.Framework.IClientAPI.OnGrabUpdate"/>
256 /// via <see cref="TriggerObjectGrabbing"/>
257 /// in <see cref="Scene.ProcessObjectGrabUpdate"/>
258 /// </remarks>
246 public event ObjectGrabDelegate OnObjectGrabbing; 259 public event ObjectGrabDelegate OnObjectGrabbing;
260
261 /// <summary>
262 /// Triggered when an object stops being touched/grabbed.
263 /// </summary>
264 /// <remarks>
265 /// Triggered in response to <see cref="OpenSim.Framework.IClientAPI.OnDeGrabObject"/>
266 /// via <see cref="TriggerObjectDeGrab"/>
267 /// in <see cref="Scene.ProcessObjectDeGrab"/>
268 /// </remarks>
247 public event ObjectDeGrabDelegate OnObjectDeGrab; 269 public event ObjectDeGrabDelegate OnObjectDeGrab;
248 public event ScriptResetDelegate OnScriptReset; 270 public event ScriptResetDelegate OnScriptReset;
249 271
@@ -453,12 +475,27 @@ namespace OpenSim.Region.Framework.Scenes
453 /// <summary> 475 /// <summary>
454 /// Triggered when an object is added to the scene. 476 /// Triggered when an object is added to the scene.
455 /// </summary> 477 /// </summary>
478 /// <remarks>
479 /// Triggered by <see cref="TriggerObjectAddedToScene"/>
480 /// in <see cref="Scene.AddNewSceneObject"/>,
481 /// <see cref="Scene.DuplicateObject"/>,
482 /// <see cref="Scene.doObjectDuplicateOnRay"/>
483 /// </remarks>
456 public event Action<SceneObjectGroup> OnObjectAddedToScene; 484 public event Action<SceneObjectGroup> OnObjectAddedToScene;
457 485
458 /// <summary> 486 /// <summary>
459 /// Triggered when an object is removed from the scene. 487 /// Delegate for <see cref="OnObjectBeingRemovedFromScene"/>
460 /// </summary> 488 /// </summary>
489 /// <param name="obj">The object being removed from the scene</param>
461 public delegate void ObjectBeingRemovedFromScene(SceneObjectGroup obj); 490 public delegate void ObjectBeingRemovedFromScene(SceneObjectGroup obj);
491
492 /// <summary>
493 /// Triggered when an object is removed from the scene.
494 /// </summary>
495 /// <remarks>
496 /// Triggered by <see cref="TriggerObjectBeingRemovedFromScene"/>
497 /// in <see cref="Scene.DeleteSceneObject"/>
498 /// </remarks>
462 public event ObjectBeingRemovedFromScene OnObjectBeingRemovedFromScene; 499 public event ObjectBeingRemovedFromScene OnObjectBeingRemovedFromScene;
463 500
464 public delegate void NoticeNoLandDataFromStorage(); 501 public delegate void NoticeNoLandDataFromStorage();