diff options
author | SignpostMarv | 2012-09-13 13:36:10 +0100 |
---|---|---|
committer | BlueWall | 2012-09-13 09:59:25 -0400 |
commit | 46d8405229becbad5025278226e416c37160dd96 (patch) | |
tree | 16efb86e86ba6bfc3c16276564e3265784bf3dfb /OpenSim/Region/Framework/Scenes | |
parent | correcting a typo that causes c# express to complain about xml comment contai... (diff) | |
download | opensim-SC_OLD-46d8405229becbad5025278226e416c37160dd96.zip opensim-SC_OLD-46d8405229becbad5025278226e416c37160dd96.tar.gz opensim-SC_OLD-46d8405229becbad5025278226e416c37160dd96.tar.bz2 opensim-SC_OLD-46d8405229becbad5025278226e416c37160dd96.tar.xz |
Documentation of parcel-related events
Signed-off-by: BlueWall <jamesh@bluewallgroup.com>
Diffstat (limited to 'OpenSim/Region/Framework/Scenes')
-rw-r--r-- | OpenSim/Region/Framework/Scenes/EventManager.cs | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs index 02c032e..2f34785 100644 --- a/OpenSim/Region/Framework/Scenes/EventManager.cs +++ b/OpenSim/Region/Framework/Scenes/EventManager.cs | |||
@@ -154,10 +154,32 @@ namespace OpenSim.Region.Framework.Scenes | |||
154 | 154 | ||
155 | public delegate void OnParcelPrimCountUpdateDelegate(); | 155 | public delegate void OnParcelPrimCountUpdateDelegate(); |
156 | 156 | ||
157 | /// <summary> | ||
158 | /// Triggered whenever the prim count may have been altered, or prior | ||
159 | /// to an action that requires the current prim count to be accurate. | ||
160 | /// </summary> | ||
161 | /// <remarks> | ||
162 | /// Triggered by <see cref="TriggerParcelPrimCountUpdate"/> in | ||
163 | /// <see cref="OpenSim.OpenSimBase.CreateRegion"/>, | ||
164 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandManagementModule.EventManagerOnRequestParcelPrimCountUpdate"/>, | ||
165 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandManagementModule.ClientOnParcelObjectOwnerRequest"/>, | ||
166 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandObject.GetPrimsFree"/>, | ||
167 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandObject.UpdateLandSold"/>, | ||
168 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandObject.DeedToGroup"/>, | ||
169 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandObject.SendLandUpdateToClient"/> | ||
170 | /// </remarks> | ||
157 | public event OnParcelPrimCountUpdateDelegate OnParcelPrimCountUpdate; | 171 | public event OnParcelPrimCountUpdateDelegate OnParcelPrimCountUpdate; |
158 | 172 | ||
159 | public delegate void OnParcelPrimCountAddDelegate(SceneObjectGroup obj); | 173 | public delegate void OnParcelPrimCountAddDelegate(SceneObjectGroup obj); |
160 | 174 | ||
175 | /// <summary> | ||
176 | /// Triggered in response to <see cref="OnParcelPrimCountUpdate"/> for | ||
177 | /// objects that actually contribute to parcel prim count. | ||
178 | /// </summary> | ||
179 | /// <remarks> | ||
180 | /// Triggered by <see cref="TriggerParcelPrimCountAdd"/> in | ||
181 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandManagementModule.EventManagerOnParcelPrimCountUpdate"/> | ||
182 | /// </remarks> | ||
161 | public event OnParcelPrimCountAddDelegate OnParcelPrimCountAdd; | 183 | public event OnParcelPrimCountAddDelegate OnParcelPrimCountAdd; |
162 | 184 | ||
163 | public delegate void OnPluginConsoleDelegate(string[] args); | 185 | public delegate void OnPluginConsoleDelegate(string[] args); |
@@ -178,6 +200,14 @@ namespace OpenSim.Region.Framework.Scenes | |||
178 | 200 | ||
179 | public event OnSetRootAgentSceneDelegate OnSetRootAgentScene; | 201 | public event OnSetRootAgentSceneDelegate OnSetRootAgentScene; |
180 | 202 | ||
203 | /// <summary> | ||
204 | /// Triggered after parcel properties have been updated. | ||
205 | /// </summary> | ||
206 | /// <remarks> | ||
207 | /// Triggered by <see cref="TriggerOnParcelPropertiesUpdateRequest"/> in | ||
208 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandManagementModule.ClientOnParcelPropertiesUpdateRequest"/>, | ||
209 | /// <see cref="OpenSim.Region.CoreModules.World.Land.LandManagementModule.ProcessPropertiesUpdate"/> | ||
210 | /// </remarks> | ||
181 | public event ParcelPropertiesUpdateRequest OnParcelPropertiesUpdateRequest; | 211 | public event ParcelPropertiesUpdateRequest OnParcelPropertiesUpdateRequest; |
182 | 212 | ||
183 | /// <summary> | 213 | /// <summary> |
@@ -428,6 +458,20 @@ namespace OpenSim.Region.Framework.Scenes | |||
428 | public event RequestParcelPrimCountUpdate OnRequestParcelPrimCountUpdate; | 458 | public event RequestParcelPrimCountUpdate OnRequestParcelPrimCountUpdate; |
429 | 459 | ||
430 | public delegate void ParcelPrimCountTainted(); | 460 | public delegate void ParcelPrimCountTainted(); |
461 | |||
462 | /// <summary> | ||
463 | /// Triggered when the parcel prim count has been altered. | ||
464 | /// </summary> | ||
465 | /// <remarks> | ||
466 | /// Triggered by <see cref="TriggerParcelPrimCountTainted"/> in | ||
467 | /// <see cref="OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.DetachSingleAttachmentToGround"/>, | ||
468 | /// <see cref="OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.AttachToAgent"/>, | ||
469 | /// <see cref="Scene.DeleteSceneObject"/>, | ||
470 | /// <see cref="Scene.SelectPrim"/>, | ||
471 | /// <see cref="Scene.DeselectPrim"/>, | ||
472 | /// <see cref="SceneObjectGroup.UpdatePrimFlags"/>, | ||
473 | /// <see cref="SceneObjectGroup.AbsolutePosition"/> | ||
474 | /// </remarks> | ||
431 | public event ParcelPrimCountTainted OnParcelPrimCountTainted; | 475 | public event ParcelPrimCountTainted OnParcelPrimCountTainted; |
432 | public event GetScriptRunning OnGetScriptRunning; | 476 | public event GetScriptRunning OnGetScriptRunning; |
433 | 477 | ||