aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region
diff options
context:
space:
mode:
authorSignpostMarv2012-09-15 17:32:10 +0100
committerJustin Clark-Casey (justincc)2012-09-20 01:56:18 +0100
commitd667f9d260808a27e91acf11244dded87517ec58 (patch)
tree6167cf30eb8c883d923889ab3b4c17d4714350dc /OpenSim/Region
parentminor tweaks to existing comments for IDE goodness (diff)
downloadopensim-SC_OLD-d667f9d260808a27e91acf11244dded87517ec58.zip
opensim-SC_OLD-d667f9d260808a27e91acf11244dded87517ec58.tar.gz
opensim-SC_OLD-d667f9d260808a27e91acf11244dded87517ec58.tar.bz2
opensim-SC_OLD-d667f9d260808a27e91acf11244dded87517ec58.tar.xz
Documentation of teleport-related events
Diffstat (limited to 'OpenSim/Region')
-rw-r--r--OpenSim/Region/Framework/Scenes/EventManager.cs19
1 files changed, 19 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index e415e09..f079e00 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -715,9 +715,28 @@ namespace OpenSim.Region.Framework.Scenes
715 public event PrimsLoaded OnPrimsLoaded; 715 public event PrimsLoaded OnPrimsLoaded;
716 716
717 public delegate void TeleportStart(IClientAPI client, GridRegion destination, GridRegion finalDestination, uint teleportFlags, bool gridLogout); 717 public delegate void TeleportStart(IClientAPI client, GridRegion destination, GridRegion finalDestination, uint teleportFlags, bool gridLogout);
718
719 /// <summary>
720 /// Triggered when a teleport starts
721 /// </summary>
722 /// <remarks>
723 /// Triggered by <see cref="TriggerTeleportStart"/>
724 /// in <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.CreateAgent"/>
725 /// and <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.CreateAgent"/>
726 /// via <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.DoTeleport"/>
727 /// </remarks>
718 public event TeleportStart OnTeleportStart; 728 public event TeleportStart OnTeleportStart;
719 729
720 public delegate void TeleportFail(IClientAPI client, bool gridLogout); 730 public delegate void TeleportFail(IClientAPI client, bool gridLogout);
731
732 /// <summary>
733 /// Trigered when a teleport fails.
734 /// </summary>
735 /// <remarks>
736 /// Triggered by <see cref="TriggerTeleportFail"/>
737 /// in <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.Fail"/>
738 /// via <see cref="OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.DoTeleport"/>
739 /// </remarks>
721 public event TeleportFail OnTeleportFail; 740 public event TeleportFail OnTeleportFail;
722 741
723 public class MoneyTransferArgs : EventArgs 742 public class MoneyTransferArgs : EventArgs