diff options
author | Melanie | 2012-09-24 20:14:00 +0100 |
---|---|---|
committer | Melanie | 2012-09-24 20:14:00 +0100 |
commit | bbaf2c5a80441fdbd2f55e02ec9f46c3b66869c6 (patch) | |
tree | 2ac67907f6333bbbc9e4d821c6607b53d0e22acb /OpenSim/Region/Framework/Scenes/EventManager.cs | |
parent | Merge branch 'master' into careminster (diff) | |
parent | HG Rez object: warn the user if the item or asset cannot be found. (diff) | |
download | opensim-SC_OLD-bbaf2c5a80441fdbd2f55e02ec9f46c3b66869c6.zip opensim-SC_OLD-bbaf2c5a80441fdbd2f55e02ec9f46c3b66869c6.tar.gz opensim-SC_OLD-bbaf2c5a80441fdbd2f55e02ec9f46c3b66869c6.tar.bz2 opensim-SC_OLD-bbaf2c5a80441fdbd2f55e02ec9f46c3b66869c6.tar.xz |
Merge branch 'master' into careminster
Conflicts:
OpenSim/Region/Framework/Scenes/Scene.cs
Diffstat (limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
-rw-r--r-- | OpenSim/Region/Framework/Scenes/EventManager.cs | 172 |
1 files changed, 166 insertions, 6 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs index e257b57..67d218b 100644 --- a/OpenSim/Region/Framework/Scenes/EventManager.cs +++ b/OpenSim/Region/Framework/Scenes/EventManager.cs | |||
@@ -188,6 +188,22 @@ namespace OpenSim.Region.Framework.Scenes | |||
188 | 188 | ||
189 | public delegate void OnPluginConsoleDelegate(string[] args); | 189 | public delegate void OnPluginConsoleDelegate(string[] args); |
190 | 190 | ||
191 | /// <summary> | ||
192 | /// Triggered after <see cref="OpenSim.IApplicationPlugin.PostInitialise"/> | ||
193 | /// has been called for all <see cref="OpenSim.IApplicationPlugin"/> | ||
194 | /// loaded via <see cref="OpenSim.OpenSimBase.LoadPlugins"/>. | ||
195 | /// Handlers for this event are typically used to parse the arguments | ||
196 | /// from <see cref="OnPluginConsoleDelegate"/> in order to process or | ||
197 | /// filter the arguments and pass them onto <see cref="OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.ProcessConsoleCommand"/> | ||
198 | /// </summary> | ||
199 | /// <remarks> | ||
200 | /// Triggered by <see cref="TriggerOnPluginConsole"/> in | ||
201 | /// <see cref="Scene.SendCommandToPlugins"/> via | ||
202 | /// <see cref="SceneManager.SendCommandToPluginModules"/> via | ||
203 | /// <see cref="OpenSim.OpenSimBase.HandleCommanderCommand"/> via | ||
204 | /// <see cref="OpenSim.OpenSimBase.AddPluginCommands"/> via | ||
205 | /// <see cref="OpenSim.OpenSimBase.StartupSpecific"/> | ||
206 | /// </remarks> | ||
191 | public event OnPluginConsoleDelegate OnPluginConsole; | 207 | public event OnPluginConsoleDelegate OnPluginConsole; |
192 | 208 | ||
193 | /// <summary> | 209 | /// <summary> |
@@ -202,6 +218,18 @@ namespace OpenSim.Region.Framework.Scenes | |||
202 | 218 | ||
203 | public delegate void OnSetRootAgentSceneDelegate(UUID agentID, Scene scene); | 219 | public delegate void OnSetRootAgentSceneDelegate(UUID agentID, Scene scene); |
204 | 220 | ||
221 | /// <summary> | ||
222 | /// Triggered before the grunt work for adding a root agent to a | ||
223 | /// scene has been performed (resuming attachment scripts, physics, | ||
224 | /// animations etc.) | ||
225 | /// </summary> | ||
226 | /// <remarks> | ||
227 | /// Triggered before <see cref="OnMakeRootAgent"/> | ||
228 | /// by <see cref="TriggerSetRootAgentScene"/> | ||
229 | /// in <see cref="ScenePresence.MakeRootAgent"/> | ||
230 | /// via <see cref="Scene.AgentCrossing"/> | ||
231 | /// and <see cref="ScenePresence.CompleteMovement"/> | ||
232 | /// </remarks> | ||
205 | public event OnSetRootAgentSceneDelegate OnSetRootAgentScene; | 233 | public event OnSetRootAgentSceneDelegate OnSetRootAgentScene; |
206 | 234 | ||
207 | /// <summary> | 235 | /// <summary> |
@@ -226,13 +254,45 @@ namespace OpenSim.Region.Framework.Scenes | |||
226 | /// <summary> | 254 | /// <summary> |
227 | /// Fired when an object is touched/grabbed. | 255 | /// Fired when an object is touched/grabbed. |
228 | /// </summary> | 256 | /// </summary> |
257 | /// <remarks> | ||
229 | /// The originalID is the local ID of the part that was actually touched. The localID itself is always that of | 258 | /// The originalID is the local ID of the part that was actually touched. The localID itself is always that of |
230 | /// the root part. | 259 | /// the root part. |
260 | /// Triggerd in response to <see cref="OpenSim.Framework.IClientAPI.OnGrabObject"/> | ||
261 | /// via <see cref="TriggerObjectGrab"/> | ||
262 | /// in <see cref="Scene.ProcessObjectGrab"/> | ||
263 | /// </remarks> | ||
231 | public event ObjectGrabDelegate OnObjectGrab; | 264 | public event ObjectGrabDelegate OnObjectGrab; |
232 | public delegate void ObjectGrabDelegate(uint localID, uint originalID, Vector3 offsetPos, IClientAPI remoteClient, SurfaceTouchEventArgs surfaceArgs); | 265 | public delegate void ObjectGrabDelegate(uint localID, uint originalID, Vector3 offsetPos, IClientAPI remoteClient, SurfaceTouchEventArgs surfaceArgs); |
233 | 266 | ||
267 | /// <summary> | ||
268 | /// Triggered when an object is being touched/grabbed continuously. | ||
269 | /// </summary> | ||
270 | /// <remarks> | ||
271 | /// Triggered in response to <see cref="OpenSim.Framework.IClientAPI.OnGrabUpdate"/> | ||
272 | /// via <see cref="TriggerObjectGrabbing"/> | ||
273 | /// in <see cref="Scene.ProcessObjectGrabUpdate"/> | ||
274 | /// </remarks> | ||
234 | public event ObjectGrabDelegate OnObjectGrabbing; | 275 | public event ObjectGrabDelegate OnObjectGrabbing; |
276 | |||
277 | /// <summary> | ||
278 | /// Triggered when an object stops being touched/grabbed. | ||
279 | /// </summary> | ||
280 | /// <remarks> | ||
281 | /// Triggered in response to <see cref="OpenSim.Framework.IClientAPI.OnDeGrabObject"/> | ||
282 | /// via <see cref="TriggerObjectDeGrab"/> | ||
283 | /// in <see cref="Scene.ProcessObjectDeGrab"/> | ||
284 | /// </remarks> | ||
235 | public event ObjectDeGrabDelegate OnObjectDeGrab; | 285 | public event ObjectDeGrabDelegate OnObjectDeGrab; |
286 | |||
287 | /// <summary> | ||
288 | /// Triggered when a script resets. | ||
289 | /// </summary> | ||
290 | /// <remarks> | ||
291 | /// Triggered by <see cref="TriggerScriptReset"/> | ||
292 | /// in <see cref="Scene.ProcessScriptReset"/> | ||
293 | /// via <see cref="OpenSim.Framework.IClientAPI.OnScriptReset"/> | ||
294 | /// via <see cref="OpenSim.Region.ClientStack.LindenUDP.LLClientView.HandleScriptReset"/> | ||
295 | /// </remarks> | ||
236 | public event ScriptResetDelegate OnScriptReset; | 296 | public event ScriptResetDelegate OnScriptReset; |
237 | 297 | ||
238 | public event OnPermissionErrorDelegate OnPermissionError; | 298 | public event OnPermissionErrorDelegate OnPermissionError; |
@@ -242,17 +302,50 @@ namespace OpenSim.Region.Framework.Scenes | |||
242 | /// </summary> | 302 | /// </summary> |
243 | /// <remarks> | 303 | /// <remarks> |
244 | /// Occurs after OnNewScript. | 304 | /// Occurs after OnNewScript. |
305 | /// Triggered by <see cref="TriggerRezScript"/> | ||
306 | /// in <see cref="SceneObjectPartInventory.CreateScriptInstance"/> | ||
245 | /// </remarks> | 307 | /// </remarks> |
246 | public event NewRezScript OnRezScript; | 308 | public event NewRezScript OnRezScript; |
247 | public delegate void NewRezScript(uint localID, UUID itemID, string script, int startParam, bool postOnRez, string engine, int stateSource); | 309 | public delegate void NewRezScript(uint localID, UUID itemID, string script, int startParam, bool postOnRez, string engine, int stateSource); |
248 | 310 | ||
249 | public delegate void RemoveScript(uint localID, UUID itemID); | 311 | public delegate void RemoveScript(uint localID, UUID itemID); |
312 | |||
313 | /// <summary> | ||
314 | /// Triggered when a script is removed from an object. | ||
315 | /// </summary> | ||
316 | /// <remarks> | ||
317 | /// Triggered by <see cref="TriggerRemoveScript"/> | ||
318 | /// in <see cref="Scene.RemoveTaskInventory"/>, | ||
319 | /// <see cref="Scene.CreateAgentInventoryItemFromTask"/>, | ||
320 | /// <see cref="SceneObjectPartInventory.RemoveScriptInstance"/>, | ||
321 | /// <see cref="SceneObjectPartInventory.RemoveInventoryItem"/> | ||
322 | /// </remarks> | ||
250 | public event RemoveScript OnRemoveScript; | 323 | public event RemoveScript OnRemoveScript; |
251 | 324 | ||
252 | public delegate void StartScript(uint localID, UUID itemID); | 325 | public delegate void StartScript(uint localID, UUID itemID); |
326 | |||
327 | /// <summary> | ||
328 | /// Triggered when a script starts. | ||
329 | /// </summary> | ||
330 | /// <remarks> | ||
331 | /// Triggered by <see cref="TriggerStartScript"/> | ||
332 | /// in <see cref="Scene.SetScriptRunning"/> | ||
333 | /// via <see cref="OpenSim.Framework.IClientAPI.OnSetScriptRunning"/>, | ||
334 | /// via <see cref="OpenSim.Region.ClientStack.LindenUDP.HandleSetScriptRunning"/> | ||
335 | /// </remarks> | ||
253 | public event StartScript OnStartScript; | 336 | public event StartScript OnStartScript; |
254 | 337 | ||
255 | public delegate void StopScript(uint localID, UUID itemID); | 338 | public delegate void StopScript(uint localID, UUID itemID); |
339 | |||
340 | /// <summary> | ||
341 | /// Triggered when a script stops. | ||
342 | /// </summary> | ||
343 | /// <remarks> | ||
344 | /// Triggered by <see cref="TriggerStopScript"/>, | ||
345 | /// in <see cref="SceneObjectPartInventory.CreateScriptInstance"/>, | ||
346 | /// <see cref="SceneObjectPartInventory.StopScriptInstance"/>, | ||
347 | /// <see cref="Scene.SetScriptRunning"/> | ||
348 | /// </remarks> | ||
256 | public event StopScript OnStopScript; | 349 | public event StopScript OnStopScript; |
257 | 350 | ||
258 | public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta); | 351 | public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta); |
@@ -303,6 +396,9 @@ namespace OpenSim.Region.Framework.Scenes | |||
303 | /// </summary> | 396 | /// </summary> |
304 | /// <remarks> | 397 | /// <remarks> |
305 | /// Occurs before OnRezScript | 398 | /// Occurs before OnRezScript |
399 | /// Triggered by <see cref="TriggerNewScript"/> | ||
400 | /// in <see cref="Scene.RezScriptFromAgentInventory"/>, | ||
401 | /// <see cref="Scene.RezNewScript"/> | ||
306 | /// </remarks> | 402 | /// </remarks> |
307 | public event NewScript OnNewScript; | 403 | public event NewScript OnNewScript; |
308 | 404 | ||
@@ -337,6 +433,12 @@ namespace OpenSim.Region.Framework.Scenes | |||
337 | /// </summary> | 433 | /// </summary> |
338 | /// <remarks> | 434 | /// <remarks> |
339 | /// Triggered after the scene receives a client's upload of an updated script and has stored it in an asset. | 435 | /// Triggered after the scene receives a client's upload of an updated script and has stored it in an asset. |
436 | /// Triggered by <see cref="TriggerUpdateScript"/> | ||
437 | /// in <see cref="Scene.CapsUpdateTaskInventoryScriptAsset"/> | ||
438 | /// via <see cref="Scene.CapsUpdateTaskInventoryScriptAsset"/> | ||
439 | /// via <see cref="OpenSim.Region.ClientStack.Linden.BunchOfCaps.TaskScriptUpdated"/> | ||
440 | /// via <see cref="OpenSim.Region.ClientStack.Linden.TaskInventoryScriptUpdater.OnUpLoad"/> | ||
441 | /// via <see cref="OpenSim.Region.ClientStack.Linden.TaskInventoryScriptUpdater.uploaderCaps"/> | ||
340 | /// </remarks> | 442 | /// </remarks> |
341 | public event UpdateScript OnUpdateScript; | 443 | public event UpdateScript OnUpdateScript; |
342 | 444 | ||
@@ -395,15 +497,36 @@ namespace OpenSim.Region.Framework.Scenes | |||
395 | public event ScriptColliding OnScriptLandColliderEnd; | 497 | public event ScriptColliding OnScriptLandColliderEnd; |
396 | 498 | ||
397 | public delegate void OnMakeChildAgentDelegate(ScenePresence presence); | 499 | public delegate void OnMakeChildAgentDelegate(ScenePresence presence); |
500 | |||
501 | /// <summary> | ||
502 | /// Triggered when an agent has been made a child agent of a scene. | ||
503 | /// </summary> | ||
504 | /// <remarks> | ||
505 | /// Triggered by <see cref="TriggerOnMakeChildAgent"/> | ||
506 | /// in <see cref="ScenePresence.MakeChildAgent"/> | ||
507 | /// via <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.CrossAgentToNewRegionAsync"/>, | ||
508 | /// <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.DoTeleport"/>, | ||
509 | /// <see cref="OpenSim.Region.CoreModules.InterGrid.KillAUser.ShutdownNoLogout"/> | ||
510 | /// </remarks> | ||
398 | public event OnMakeChildAgentDelegate OnMakeChildAgent; | 511 | public event OnMakeChildAgentDelegate OnMakeChildAgent; |
399 | 512 | ||
400 | public delegate void OnSaveNewWindlightProfileDelegate(); | 513 | public delegate void OnSaveNewWindlightProfileDelegate(); |
401 | public delegate void OnSendNewWindlightProfileTargetedDelegate(RegionLightShareData wl, UUID user); | 514 | public delegate void OnSendNewWindlightProfileTargetedDelegate(RegionLightShareData wl, UUID user); |
402 | 515 | ||
403 | /// <summary> | 516 | /// <summary> |
517 | /// Triggered after the grunt work for adding a root agent to a | ||
518 | /// scene has been performed (resuming attachment scripts, physics, | ||
519 | /// animations etc.) | ||
520 | /// </summary> | ||
521 | /// <remarks> | ||
404 | /// This event is on the critical path for transferring an avatar from one region to another. Try and do | 522 | /// This event is on the critical path for transferring an avatar from one region to another. Try and do |
405 | /// as little work on this event as possible, or do work asynchronously. | 523 | /// as little work on this event as possible, or do work asynchronously. |
406 | /// </summary> | 524 | /// Triggered after <see cref="OnSetRootAgentScene"/> |
525 | /// by <see cref="TriggerOnMakeRootAgent"/> | ||
526 | /// in <see cref="ScenePresence.MakeRootAgent"/> | ||
527 | /// via <see cref="Scene.AgentCrossing"/> | ||
528 | /// and <see cref="ScenePresence.CompleteMovement"/> | ||
529 | /// </remarks> | ||
407 | public event Action<ScenePresence> OnMakeRootAgent; | 530 | public event Action<ScenePresence> OnMakeRootAgent; |
408 | 531 | ||
409 | public event OnSendNewWindlightProfileTargetedDelegate OnSendNewWindlightProfileTargeted; | 532 | public event OnSendNewWindlightProfileTargetedDelegate OnSendNewWindlightProfileTargeted; |
@@ -429,9 +552,10 @@ namespace OpenSim.Region.Framework.Scenes | |||
429 | public event AvatarKillData OnAvatarKilled; | 552 | public event AvatarKillData OnAvatarKilled; |
430 | public delegate void AvatarKillData(uint KillerLocalID, ScenePresence avatar); | 553 | public delegate void AvatarKillData(uint KillerLocalID, ScenePresence avatar); |
431 | 554 | ||
432 | // public delegate void ScriptTimerEvent(uint localID, double timerinterval); | 555 | /* |
433 | 556 | public delegate void ScriptTimerEvent(uint localID, double timerinterval); | |
434 | // public event ScriptTimerEvent OnScriptTimerEvent; | 557 | public event ScriptTimerEvent OnScriptTimerEvent; |
558 | */ | ||
435 | 559 | ||
436 | public delegate void EstateToolsSunUpdate(ulong regionHandle, bool FixedTime, bool EstateSun, float LindenHour); | 560 | public delegate void EstateToolsSunUpdate(ulong regionHandle, bool FixedTime, bool EstateSun, float LindenHour); |
437 | public delegate void GetScriptRunning(IClientAPI controllingClient, UUID objectID, UUID itemID); | 561 | public delegate void GetScriptRunning(IClientAPI controllingClient, UUID objectID, UUID itemID); |
@@ -441,12 +565,27 @@ namespace OpenSim.Region.Framework.Scenes | |||
441 | /// <summary> | 565 | /// <summary> |
442 | /// Triggered when an object is added to the scene. | 566 | /// Triggered when an object is added to the scene. |
443 | /// </summary> | 567 | /// </summary> |
568 | /// <remarks> | ||
569 | /// Triggered by <see cref="TriggerObjectAddedToScene"/> | ||
570 | /// in <see cref="Scene.AddNewSceneObject"/>, | ||
571 | /// <see cref="Scene.DuplicateObject"/>, | ||
572 | /// <see cref="Scene.doObjectDuplicateOnRay"/> | ||
573 | /// </remarks> | ||
444 | public event Action<SceneObjectGroup> OnObjectAddedToScene; | 574 | public event Action<SceneObjectGroup> OnObjectAddedToScene; |
445 | 575 | ||
446 | /// <summary> | 576 | /// <summary> |
447 | /// Triggered when an object is removed from the scene. | 577 | /// Delegate for <see cref="OnObjectBeingRemovedFromScene"/> |
448 | /// </summary> | 578 | /// </summary> |
579 | /// <param name="obj">The object being removed from the scene</param> | ||
449 | public delegate void ObjectBeingRemovedFromScene(SceneObjectGroup obj); | 580 | public delegate void ObjectBeingRemovedFromScene(SceneObjectGroup obj); |
581 | |||
582 | /// <summary> | ||
583 | /// Triggered when an object is removed from the scene. | ||
584 | /// </summary> | ||
585 | /// <remarks> | ||
586 | /// Triggered by <see cref="TriggerObjectBeingRemovedFromScene"/> | ||
587 | /// in <see cref="Scene.DeleteSceneObject"/> | ||
588 | /// </remarks> | ||
450 | public event ObjectBeingRemovedFromScene OnObjectBeingRemovedFromScene; | 589 | public event ObjectBeingRemovedFromScene OnObjectBeingRemovedFromScene; |
451 | 590 | ||
452 | public delegate void NoticeNoLandDataFromStorage(); | 591 | public delegate void NoticeNoLandDataFromStorage(); |
@@ -632,9 +771,28 @@ namespace OpenSim.Region.Framework.Scenes | |||
632 | public event PrimsLoaded OnPrimsLoaded; | 771 | public event PrimsLoaded OnPrimsLoaded; |
633 | 772 | ||
634 | public delegate void TeleportStart(IClientAPI client, GridRegion destination, GridRegion finalDestination, uint teleportFlags, bool gridLogout); | 773 | public delegate void TeleportStart(IClientAPI client, GridRegion destination, GridRegion finalDestination, uint teleportFlags, bool gridLogout); |
774 | |||
775 | /// <summary> | ||
776 | /// Triggered when a teleport starts | ||
777 | /// </summary> | ||
778 | /// <remarks> | ||
779 | /// Triggered by <see cref="TriggerTeleportStart"/> | ||
780 | /// in <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.CreateAgent"/> | ||
781 | /// and <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.CreateAgent"/> | ||
782 | /// via <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.DoTeleport"/> | ||
783 | /// </remarks> | ||
635 | public event TeleportStart OnTeleportStart; | 784 | public event TeleportStart OnTeleportStart; |
636 | 785 | ||
637 | public delegate void TeleportFail(IClientAPI client, bool gridLogout); | 786 | public delegate void TeleportFail(IClientAPI client, bool gridLogout); |
787 | |||
788 | /// <summary> | ||
789 | /// Trigered when a teleport fails. | ||
790 | /// </summary> | ||
791 | /// <remarks> | ||
792 | /// Triggered by <see cref="TriggerTeleportFail"/> | ||
793 | /// in <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.Fail"/> | ||
794 | /// via <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.DoTeleport"/> | ||
795 | /// </remarks> | ||
638 | public event TeleportFail OnTeleportFail; | 796 | public event TeleportFail OnTeleportFail; |
639 | 797 | ||
640 | public class MoneyTransferArgs : EventArgs | 798 | public class MoneyTransferArgs : EventArgs |
@@ -642,7 +800,9 @@ namespace OpenSim.Region.Framework.Scenes | |||
642 | public UUID sender; | 800 | public UUID sender; |
643 | public UUID receiver; | 801 | public UUID receiver; |
644 | 802 | ||
645 | // Always false. The SL protocol sucks. | 803 | /// <summary> |
804 | /// Always false. The SL protocol sucks. | ||
805 | /// </summary> | ||
646 | public bool authenticated = false; | 806 | public bool authenticated = false; |
647 | 807 | ||
648 | public int amount; | 808 | public int amount; |