aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorSignpostMarv2012-09-23 15:33:01 +0100
committerJustin Clark-Casey (justincc)2012-09-24 22:59:02 +0100
commit020103c51e4b8e340c44b2cfbe7826a95b041068 (patch)
tree6c61a12d0ca7eeb033ace001f1276db99f65cc6b
parentMerge branch 'master' of ssh://opensimulator.org/var/git/opensim (diff)
downloadopensim-SC_OLD-020103c51e4b8e340c44b2cfbe7826a95b041068.zip
opensim-SC_OLD-020103c51e4b8e340c44b2cfbe7826a95b041068.tar.gz
opensim-SC_OLD-020103c51e4b8e340c44b2cfbe7826a95b041068.tar.bz2
opensim-SC_OLD-020103c51e4b8e340c44b2cfbe7826a95b041068.tar.xz
Documenting object-related events
-rw-r--r--OpenSim/Region/Framework/Scenes/EventManager.cs43
1 files changed, 43 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 22d395c..e25fa94 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -345,15 +345,58 @@ namespace OpenSim.Region.Framework.Scenes
345 public event StopScript OnStopScript; 345 public event StopScript OnStopScript;
346 346
347 public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta); 347 public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta);
348
349 /// <summary>
350 /// Triggered when an object is moved.
351 /// </summary>
352 /// <remarks>
353 /// Triggered by <see cref="TriggerGroupMove"/>
354 /// in <see cref="SceneObjectGroup.UpdateGroupPosition"/>,
355 /// <see cref="SceneObjectGroup.GrabMovement"/>
356 /// </remarks>
348 public event SceneGroupMoved OnSceneGroupMove; 357 public event SceneGroupMoved OnSceneGroupMove;
349 358
350 public delegate void SceneGroupGrabed(UUID groupID, Vector3 offset, UUID userID); 359 public delegate void SceneGroupGrabed(UUID groupID, Vector3 offset, UUID userID);
360
361 /// <summary>
362 /// Triggered when an object is grabbed.
363 /// </summary>
364 /// <remarks>
365 /// Triggered by <see cref="TriggerGroupGrab"/>
366 /// in <see cref="SceneObjectGroup.OnGrabGroup"/>
367 /// via <see cref="SceneObjectGroup.ObjectGrabHandler"/>
368 /// via <see cref="Scene.ProcessObjectGrab"/>
369 /// via <see cref="OpenSim.Framework.IClientAPI.OnGrabObject"/>
370 /// via <see cref="OpenSim.Region.ClientStack.LindenUDP.LLClientView.HandleObjectGrab"/>
371 /// </remarks>
351 public event SceneGroupGrabed OnSceneGroupGrab; 372 public event SceneGroupGrabed OnSceneGroupGrab;
352 373
353 public delegate bool SceneGroupSpinStarted(UUID groupID); 374 public delegate bool SceneGroupSpinStarted(UUID groupID);
375
376 /// <summary>
377 /// Triggered when an object starts to spin.
378 /// </summary>
379 /// <remarks>
380 /// Triggered by <see cref="TriggerGroupSpinStart"/>
381 /// in <see cref="SceneObjectGroup.SpinStart"/>
382 /// via <see cref="SceneGraph.SpinStart"/>
383 /// via <see cref="OpenSim.Framework.IClientAPI.OnSpinStart"/>
384 /// via <see cref="OpenSim.Region.ClientStack.LindenUDP.LLClientView.HandleObjectSpinStart"/>
385 /// </remarks>
354 public event SceneGroupSpinStarted OnSceneGroupSpinStart; 386 public event SceneGroupSpinStarted OnSceneGroupSpinStart;
355 387
356 public delegate bool SceneGroupSpun(UUID groupID, Quaternion rotation); 388 public delegate bool SceneGroupSpun(UUID groupID, Quaternion rotation);
389
390 /// <summary>
391 /// Triggered when an object is being spun.
392 /// </summary>
393 /// <remarks>
394 /// Triggered by <see cref="TriggerGroupSpin"/>
395 /// in <see cref="SceneObjectGroup.SpinMovement"/>
396 /// via <see cref="SceneGraph.SpinObject"/>
397 /// via <see cref="OpenSim.Framework.IClientAPI.OnSpinUpdate"/>
398 /// via <see cref="OpenSim.Region.ClientStack.LindenUDP.LLClientView.HandleObjectSpinUpdate"/>
399 /// </remarks>
357 public event SceneGroupSpun OnSceneGroupSpin; 400 public event SceneGroupSpun OnSceneGroupSpin;
358 401
359 public delegate void LandObjectAdded(ILandObject newParcel); 402 public delegate void LandObjectAdded(ILandObject newParcel);