aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Scenes/EventManager.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
-rw-r--r--OpenSim/Region/Framework/Scenes/EventManager.cs83
1 files changed, 83 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 4d65be9..02c032e 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -47,26 +47,71 @@ namespace OpenSim.Region.Framework.Scenes
47 47
48 public delegate void OnFrameDelegate(); 48 public delegate void OnFrameDelegate();
49 49
50 /// <summary>
51 /// Triggered on each sim frame.
52 /// </summary>
53 /// <remarks>
54 /// This gets triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.Update"/>
55 /// Core uses it for things like Sun, Wind & Clouds
56 /// The MRM module also uses it.
57 /// </remarks>
50 public event OnFrameDelegate OnFrame; 58 public event OnFrameDelegate OnFrame;
51 59
52 public delegate void ClientMovement(ScenePresence client); 60 public delegate void ClientMovement(ScenePresence client);
53 61
62 /// <summary>
63 /// Trigerred when an agent moves.
64 /// </summary>
65 /// <remarks>
66 /// This gets triggered in <see cref="OpenSim.Region.Framework.Scenes.ScenePresence.HandleAgentUpdate"/>
67 /// prior to <see cref="OpenSim.Region.Framework.Scenes.ScenePresence.TriggerScenePresenceUpdated"/>
68 /// </remarks>
54 public event ClientMovement OnClientMovement; 69 public event ClientMovement OnClientMovement;
55 70
56 public delegate void OnTerrainTaintedDelegate(); 71 public delegate void OnTerrainTaintedDelegate();
57 72
73 /// <summary>
74 /// Triggered if the terrain has been edited
75 /// </summary>
76 /// <remarks>
77 /// This gets triggered in <see cref="OpenSim.Region.CoreModules.World.Terrain.CheckForTerrainUpdates"/>
78 /// after it determines that an update has been made.
79 /// </remarks>
58 public event OnTerrainTaintedDelegate OnTerrainTainted; 80 public event OnTerrainTaintedDelegate OnTerrainTainted;
59 81
60 public delegate void OnTerrainTickDelegate(); 82 public delegate void OnTerrainTickDelegate();
61 83
84 /// <summary>
85 /// Triggered if the terrain has been edited
86 /// </summary>
87 /// <remarks>
88 /// This gets triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.UpdateTerrain"/>
89 /// but is used by core solely to update the physics engine.
90 /// </remarks>
62 public event OnTerrainTickDelegate OnTerrainTick; 91 public event OnTerrainTickDelegate OnTerrainTick;
63 92
64 public delegate void OnBackupDelegate(ISimulationDataService datastore, bool forceBackup); 93 public delegate void OnBackupDelegate(ISimulationDataService datastore, bool forceBackup);
65 94
95 /// <summary>
96 /// Triggered when a region is backed up/persisted to storage
97 /// </summary>
98 /// <remarks>
99 /// This gets triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.Backup"/>
100 /// and is fired before the persistence occurs.
101 /// </remarks>
66 public event OnBackupDelegate OnBackup; 102 public event OnBackupDelegate OnBackup;
67 103
68 public delegate void OnClientConnectCoreDelegate(IClientCore client); 104 public delegate void OnClientConnectCoreDelegate(IClientCore client);
69 105
106 /// <summary>
107 /// Triggered when a new client connects to the scene.
108 /// </summary>
109 /// <remarks>
110 /// This gets triggered in <see cref="TriggerOnNewClient"/>,
111 /// which checks if an instance of <see cref="OpenSim.Framework.IClientAPI"/>
112 /// also implements <see cref="OpenSim.Framework.Client.IClientCore"/> and as such,
113 /// is not triggered by <see cref="OpenSim.Region.OptionalModules.World.NPC">NPCs</see>.
114 /// </remarks>
70 public event OnClientConnectCoreDelegate OnClientConnect; 115 public event OnClientConnectCoreDelegate OnClientConnect;
71 116
72 public delegate void OnNewClientDelegate(IClientAPI client); 117 public delegate void OnNewClientDelegate(IClientAPI client);
@@ -87,10 +132,24 @@ namespace OpenSim.Region.Framework.Scenes
87 132
88 public delegate void OnNewPresenceDelegate(ScenePresence presence); 133 public delegate void OnNewPresenceDelegate(ScenePresence presence);
89 134
135 /// <summary>
136 /// Triggered when a new presence is added to the scene
137 /// </summary>
138 /// <remarks>
139 /// Triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.AddNewClient"/> which is used by both
140 /// <see cref="OpenSim.Framework.PresenceType.User">users</see> and <see cref="OpenSim.Framework.PresenceType.Npc">NPCs</see>
141 /// </remarks>
90 public event OnNewPresenceDelegate OnNewPresence; 142 public event OnNewPresenceDelegate OnNewPresence;
91 143
92 public delegate void OnRemovePresenceDelegate(UUID agentId); 144 public delegate void OnRemovePresenceDelegate(UUID agentId);
93 145
146 /// <summary>
147 /// Triggered when a presence is removed from the scene
148 /// </summary>
149 /// <remarks>
150 /// Triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.AddNewClient"/> which is used by both
151 /// <see cref="OpenSim.Framework.PresenceType.User">users</see> and <see cref="OpenSim.Framework.PresenceType.Npc">NPCs</see>
152 /// </remarks>
94 public event OnRemovePresenceDelegate OnRemovePresence; 153 public event OnRemovePresenceDelegate OnRemovePresence;
95 154
96 public delegate void OnParcelPrimCountUpdateDelegate(); 155 public delegate void OnParcelPrimCountUpdateDelegate();
@@ -481,6 +540,9 @@ namespace OpenSim.Region.Framework.Scenes
481 /// <param name="copy"></param> 540 /// <param name="copy"></param>
482 /// <param name="original"></param> 541 /// <param name="original"></param>
483 /// <param name="userExposed">True if the duplicate will immediately be in the scene, false otherwise</param> 542 /// <param name="userExposed">True if the duplicate will immediately be in the scene, false otherwise</param>
543 /// <remarks>
544 /// Triggered in <see cref="OpenSim.Region.Framework.Scenes.SceneObjectPart.Copy"/>
545 /// </remarks>
484 public event SceneObjectPartCopyDelegate OnSceneObjectPartCopy; 546 public event SceneObjectPartCopyDelegate OnSceneObjectPartCopy;
485 public delegate void SceneObjectPartCopyDelegate(SceneObjectPart copy, SceneObjectPart original, bool userExposed); 547 public delegate void SceneObjectPartCopyDelegate(SceneObjectPart copy, SceneObjectPart original, bool userExposed);
486 548
@@ -589,8 +651,29 @@ namespace OpenSim.Region.Framework.Scenes
589 651
590 public delegate void LandBuy(Object sender, LandBuyArgs e); 652 public delegate void LandBuy(Object sender, LandBuyArgs e);
591 653
654 /// <summary>
655 /// Triggered when an attempt to transfer grid currency occurs
656 /// </summary>
657 /// <remarks>
658 /// Triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.ProcessMoneyTransferRequest"/>
659 /// via <see cref="OpenSim.Region.Framework.Scenes.Scene.SubscribeToClientGridEvents"/>
660 /// via <see cref="OpenSim.Region.Framework.Scenes.Scene.SubscribeToClientEvents"/>
661 /// via <see cref="OpenSim.Region.Framework.Scenes.Scene.AddNewClient"/>
662 /// </remarks>
592 public event MoneyTransferEvent OnMoneyTransfer; 663 public event MoneyTransferEvent OnMoneyTransfer;
664
665 /// <summary>
666 /// Triggered after after <see cref="OnValidateLandBuy"/>
667 /// </summary>
593 public event LandBuy OnLandBuy; 668 public event LandBuy OnLandBuy;
669
670 /// <summary>
671 /// Triggered to allow or prevent a real estate transaction
672 /// </summary>
673 /// <remarks>
674 /// Triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.ProcessParcelBuy"/>
675 /// <seealso cref="OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ValidateLandBuy"/>
676 /// </remarks>
594 public event LandBuy OnValidateLandBuy; 677 public event LandBuy OnValidateLandBuy;
595 678
596 public void TriggerOnAttach(uint localID, UUID itemID, UUID avatarID) 679 public void TriggerOnAttach(uint localID, UUID itemID, UUID avatarID)