aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region
diff options
context:
space:
mode:
authorSignpostMarv2012-09-19 20:26:57 +0100
committerJustin Clark-Casey (justincc)2012-09-20 01:50:40 +0100
commit49e2872f9ee3c5c11145a43ec91bac2dab324f42 (patch)
treea40c58b03d49d6fe588728cca59371cebae146f1 /OpenSim/Region
parentDocumentation of object-related events (diff)
downloadopensim-SC_OLD-49e2872f9ee3c5c11145a43ec91bac2dab324f42.zip
opensim-SC_OLD-49e2872f9ee3c5c11145a43ec91bac2dab324f42.tar.gz
opensim-SC_OLD-49e2872f9ee3c5c11145a43ec91bac2dab324f42.tar.bz2
opensim-SC_OLD-49e2872f9ee3c5c11145a43ec91bac2dab324f42.tar.xz
Documentation of agent-related events
Diffstat (limited to 'OpenSim/Region')
-rw-r--r--OpenSim/Region/Framework/Scenes/EventManager.cs35
1 files changed, 34 insertions, 1 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 7024bd6..48a85a2 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -214,6 +214,18 @@ namespace OpenSim.Region.Framework.Scenes
214 214
215 public delegate void OnSetRootAgentSceneDelegate(UUID agentID, Scene scene); 215 public delegate void OnSetRootAgentSceneDelegate(UUID agentID, Scene scene);
216 216
217 /// <summary>
218 /// Triggered before the grunt work for adding a root agent to a
219 /// scene has been performed (resuming attachment scripts, physics,
220 /// animations etc.)
221 /// </summary>
222 /// <remarks>
223 /// Triggered before <see cref="OnMakeRootAgent"/>
224 /// by <see cref="TriggerSetRootAgentScene"/>
225 /// in <see cref="ScenePresence.MakeRootAgent"/>
226 /// via <see cref="Scene.AgentCrossing"/>
227 /// and <see cref="ScenePresence.CompleteMovement"/>
228 /// </remarks>
217 public event OnSetRootAgentSceneDelegate OnSetRootAgentScene; 229 public event OnSetRootAgentSceneDelegate OnSetRootAgentScene;
218 230
219 /// <summary> 231 /// <summary>
@@ -429,15 +441,36 @@ namespace OpenSim.Region.Framework.Scenes
429 public event ScriptColliding OnScriptLandColliderEnd; 441 public event ScriptColliding OnScriptLandColliderEnd;
430 442
431 public delegate void OnMakeChildAgentDelegate(ScenePresence presence); 443 public delegate void OnMakeChildAgentDelegate(ScenePresence presence);
444
445 /// <summary>
446 /// Triggered when an agent has been made a child agent of a scene.
447 /// </summary>
448 /// <remarks>
449 /// Triggered by <see cref="TriggerOnMakeChildAgent"/>
450 /// in <see cref="ScenePresence.MakeChildAgent"/>
451 /// via <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.CrossAgentToNewRegionAsync"/>,
452 /// <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.DoTeleport"/>,
453 /// <see cref="OpenSim.Region.CoreModules.InterGrid.KillAUser.ShutdownNoLogout"/>
454 /// </remarks>
432 public event OnMakeChildAgentDelegate OnMakeChildAgent; 455 public event OnMakeChildAgentDelegate OnMakeChildAgent;
433 456
434 public delegate void OnSaveNewWindlightProfileDelegate(); 457 public delegate void OnSaveNewWindlightProfileDelegate();
435 public delegate void OnSendNewWindlightProfileTargetedDelegate(RegionLightShareData wl, UUID user); 458 public delegate void OnSendNewWindlightProfileTargetedDelegate(RegionLightShareData wl, UUID user);
436 459
437 /// <summary> 460 /// <summary>
461 /// Triggered after the grunt work for adding a root agent to a
462 /// scene has been performed (resuming attachment scripts, physics,
463 /// animations etc.)
464 /// </summary>
465 /// <remarks>
438 /// This event is on the critical path for transferring an avatar from one region to another. Try and do 466 /// This event is on the critical path for transferring an avatar from one region to another. Try and do
439 /// as little work on this event as possible, or do work asynchronously. 467 /// as little work on this event as possible, or do work asynchronously.
440 /// </summary> 468 /// Triggered after <see cref="OnSetRootAgentScene"/>
469 /// by <see cref="TriggerOnMakeRootAgent"/>
470 /// in <see cref="ScenePresence.MakeRootAgent"/>
471 /// via <see cref="Scene.AgentCrossing"/>
472 /// and <see cref="ScenePresence.CompleteMovement"/>
473 /// </remarks>
441 public event Action<ScenePresence> OnMakeRootAgent; 474 public event Action<ScenePresence> OnMakeRootAgent;
442 475
443 public event OnSendNewWindlightProfileTargetedDelegate OnSendNewWindlightProfileTargeted; 476 public event OnSendNewWindlightProfileTargetedDelegate OnSendNewWindlightProfileTargeted;