From e3993eefa5f9e2d968bb3ff627b5102224b62c3d Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 19:59:44 +0100
Subject: Documenting some of the events on
OpenSim.Region.Framework.Scenes.EventManager (OnFrame)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 8 ++++++++
1 file changed, 8 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 4d65be9..6769fc9 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -47,6 +47,14 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void OnFrameDelegate();
+ ///
+ /// Triggered on each sim frame.
+ ///
+ ///
+ /// This gets triggered in
+ /// Core uses it for things like Sun, Wind & Clouds
+ /// The MRM module also uses it.
+ ///
public event OnFrameDelegate OnFrame;
public delegate void ClientMovement(ScenePresence client);
--
cgit v1.1
From 44349f742e309df65a4a100b004053b4262e9ade Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:00:14 +0100
Subject: documentation (OnClientMovement)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 7 +++++++
1 file changed, 7 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 6769fc9..c9be46d 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -59,6 +59,13 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void ClientMovement(ScenePresence client);
+ ///
+ /// Trigerred when an agent moves.
+ ///
+ ///
+ /// This gets triggered in
+ /// prior to
+ ///
public event ClientMovement OnClientMovement;
public delegate void OnTerrainTaintedDelegate();
--
cgit v1.1
From ed5f574356ed5fa290599fa7c852c06370c16747 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:00:30 +0100
Subject: documentation (OnTerrainTainted)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 7 +++++++
1 file changed, 7 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index c9be46d..b2960e7 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -70,6 +70,13 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void OnTerrainTaintedDelegate();
+ ///
+ /// Triggered if the terrain has been edited
+ ///
+ ///
+ /// This gets triggered in
+ /// after it determines that an update has been made.
+ ///
public event OnTerrainTaintedDelegate OnTerrainTainted;
public delegate void OnTerrainTickDelegate();
--
cgit v1.1
From fd8a7e64b90aa02897ff145d527e96e98936d3ca Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:01:00 +0100
Subject: documentation (OnTerrainTick)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 7 +++++++
1 file changed, 7 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index b2960e7..6dc8865 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -81,6 +81,13 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void OnTerrainTickDelegate();
+ ///
+ /// Triggered if the terrain has been edited
+ ///
+ ///
+ /// This gets triggered in
+ /// but is used by core solely to update the physics engine.
+ ///
public event OnTerrainTickDelegate OnTerrainTick;
public delegate void OnBackupDelegate(ISimulationDataService datastore, bool forceBackup);
--
cgit v1.1
From 5e51f16cebb0df15d79f69eda52ebe0916c20c2d Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:01:31 +0100
Subject: documentation (OnBackup)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 7 +++++++
1 file changed, 7 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 6dc8865..8b5936f 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -92,6 +92,13 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void OnBackupDelegate(ISimulationDataService datastore, bool forceBackup);
+ ///
+ /// Triggered when a region is backed up/persisted to storage
+ ///
+ ///
+ /// This gets triggered in
+ /// and is fired before the persistence occurs.
+ ///
public event OnBackupDelegate OnBackup;
public delegate void OnClientConnectCoreDelegate(IClientCore client);
--
cgit v1.1
From 0a22e78f591b905a92e9c5e2cf57d50d281e11f6 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:02:00 +0100
Subject: documentation (OnClientConnect)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 9 +++++++++
1 file changed, 9 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 8b5936f..0daecaf 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -103,6 +103,15 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void OnClientConnectCoreDelegate(IClientCore client);
+ ///
+ /// Triggered when a new client connects to the scene.
+ ///
+ ///
+ /// This gets triggered in ,
+ /// which checks if an instance of
+ /// also implements and as such,
+ /// is not triggered by NPCs.
+ ///
public event OnClientConnectCoreDelegate OnClientConnect;
public delegate void OnNewClientDelegate(IClientAPI client);
--
cgit v1.1
From 0760121eb989734e86d216e7a02123895f016795 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:02:19 +0100
Subject: documentation (OnNewPresence)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 7 +++++++
1 file changed, 7 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 0daecaf..744c4a1 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -132,6 +132,13 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void OnNewPresenceDelegate(ScenePresence presence);
+ ///
+ /// Triggered when a new presence is added to the scene
+ ///
+ ///
+ /// Triggered in which is used by both
+ /// users and NPCs
+ ///
public event OnNewPresenceDelegate OnNewPresence;
public delegate void OnRemovePresenceDelegate(UUID agentId);
--
cgit v1.1
From 97b8739c1d1aefb99526ae5baa0abb628e477061 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:02:32 +0100
Subject: documentation (OnRemovePresence)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 7 +++++++
1 file changed, 7 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 744c4a1..c66ef42 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -143,6 +143,13 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void OnRemovePresenceDelegate(UUID agentId);
+ ///
+ /// Triggered when a presence is removed from the scene
+ ///
+ ///
+ /// Triggered in which is used by both
+ /// users and NPCs
+ ///
public event OnRemovePresenceDelegate OnRemovePresence;
public delegate void OnParcelPrimCountUpdateDelegate();
--
cgit v1.1
From ad1b9bbba6bc4831ccb63d3d5fc1c7c10515fcc4 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:02:48 +0100
Subject: documentation (OnSceneObjectPartCopy)
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 3 +++
1 file changed, 3 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index c66ef42..9bdaecf 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -540,6 +540,9 @@ namespace OpenSim.Region.Framework.Scenes
///
///
/// True if the duplicate will immediately be in the scene, false otherwise
+ ///
+ /// Triggered in
+ ///
public event SceneObjectPartCopyDelegate OnSceneObjectPartCopy;
public delegate void SceneObjectPartCopyDelegate(SceneObjectPart copy, SceneObjectPart original, bool userExposed);
--
cgit v1.1
From 41f3f2400e40345b66fd7cad76675d25f9e7beb1 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 23:34:24 +0100
Subject: Documentation of economy-related EventManager events
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 9bdaecf..02c032e 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -651,8 +651,29 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void LandBuy(Object sender, LandBuyArgs e);
+ ///
+ /// Triggered when an attempt to transfer grid currency occurs
+ ///
+ ///
+ /// Triggered in
+ /// via
+ /// via
+ /// via
+ ///
public event MoneyTransferEvent OnMoneyTransfer;
+
+ ///
+ /// Triggered after after
+ ///
public event LandBuy OnLandBuy;
+
+ ///
+ /// Triggered to allow or prevent a real estate transaction
+ ///
+ ///
+ /// Triggered in
+ ///
+ ///
public event LandBuy OnValidateLandBuy;
public void TriggerOnAttach(uint localID, UUID itemID, UUID avatarID)
--
cgit v1.1
From 46d8405229becbad5025278226e416c37160dd96 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Thu, 13 Sep 2012 13:36:10 +0100
Subject: Documentation of parcel-related events
Signed-off-by: BlueWall
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 44 +++++++++++++++++++++++++
1 file changed, 44 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
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
public delegate void OnParcelPrimCountUpdateDelegate();
+ ///
+ /// Triggered whenever the prim count may have been altered, or prior
+ /// to an action that requires the current prim count to be accurate.
+ ///
+ ///
+ /// Triggered by in
+ /// ,
+ /// ,
+ /// ,
+ /// ,
+ /// ,
+ /// ,
+ ///
+ ///
public event OnParcelPrimCountUpdateDelegate OnParcelPrimCountUpdate;
public delegate void OnParcelPrimCountAddDelegate(SceneObjectGroup obj);
+ ///
+ /// Triggered in response to for
+ /// objects that actually contribute to parcel prim count.
+ ///
+ ///
+ /// Triggered by in
+ ///
+ ///
public event OnParcelPrimCountAddDelegate OnParcelPrimCountAdd;
public delegate void OnPluginConsoleDelegate(string[] args);
@@ -178,6 +200,14 @@ namespace OpenSim.Region.Framework.Scenes
public event OnSetRootAgentSceneDelegate OnSetRootAgentScene;
+ ///
+ /// Triggered after parcel properties have been updated.
+ ///
+ ///
+ /// Triggered by in
+ /// ,
+ ///
+ ///
public event ParcelPropertiesUpdateRequest OnParcelPropertiesUpdateRequest;
///
@@ -428,6 +458,20 @@ namespace OpenSim.Region.Framework.Scenes
public event RequestParcelPrimCountUpdate OnRequestParcelPrimCountUpdate;
public delegate void ParcelPrimCountTainted();
+
+ ///
+ /// Triggered when the parcel prim count has been altered.
+ ///
+ ///
+ /// Triggered by in
+ /// ,
+ /// ,
+ /// ,
+ /// ,
+ /// ,
+ /// ,
+ ///
+ ///
public event ParcelPrimCountTainted OnParcelPrimCountTainted;
public event GetScriptRunning OnGetScriptRunning;
--
cgit v1.1
From ce468215d576cc301a261d85bee9baa68a246ce6 Mon Sep 17 00:00:00 2001
From: Oren Hurvitz
Date: Tue, 24 Jul 2012 19:48:08 +0300
Subject: Support multi-region OAR files
Merged ArchiveWriteRequestPreparation.cs and ArchiveWriteRequestExecution.cs. This simplifies the code, and it's faster to write each scene to the archive as it's found rather than all at once at the end.
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 2f34785..e1c9c8e 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -531,7 +531,7 @@ namespace OpenSim.Region.Framework.Scenes
/// the scripts may not have started yet
/// Message is non empty string if there were problems loading the oar file
///
- public delegate void OarFileLoaded(Guid guid, string message);
+ public delegate void OarFileLoaded(Guid guid, List loadedScenes, string message);
public event OarFileLoaded OnOarFileLoaded;
///
@@ -2195,7 +2195,7 @@ namespace OpenSim.Region.Framework.Scenes
return 6;
}
- public void TriggerOarFileLoaded(Guid requestId, string message)
+ public void TriggerOarFileLoaded(Guid requestId, List loadedScenes, string message)
{
OarFileLoaded handlerOarFileLoaded = OnOarFileLoaded;
if (handlerOarFileLoaded != null)
@@ -2204,7 +2204,7 @@ namespace OpenSim.Region.Framework.Scenes
{
try
{
- d(requestId, message);
+ d(requestId, loadedScenes, message);
}
catch (Exception e)
{
--
cgit v1.1
From a74167bb0684eb6977aef08247144dc0e4aa6b3f Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Wed, 19 Sep 2012 12:47:23 +0100
Subject: Documentation of OnPluginConsole
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index e1c9c8e..1025943 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -184,6 +184,22 @@ namespace OpenSim.Region.Framework.Scenes
public delegate void OnPluginConsoleDelegate(string[] args);
+ ///
+ /// Triggered after
+ /// has been called for all
+ /// loaded via .
+ /// Handlers for this event are typically used to parse the arguments
+ /// from in order to process or
+ /// filter the arguments and pass them onto
+ ///
+ ///
+ /// Triggered by in
+ /// via
+ /// via
+ /// via
+ /// via
+ ///
+ ///
public event OnPluginConsoleDelegate OnPluginConsole;
///
--
cgit v1.1
From 61f4523e01b11ac116ab0c1a86075126039f481b Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Wed, 19 Sep 2012 15:00:02 +0100
Subject: Documentation of object-related events
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 39 ++++++++++++++++++++++++-
1 file changed, 38 insertions(+), 1 deletion(-)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 1025943..7024bd6 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -238,12 +238,34 @@ namespace OpenSim.Region.Framework.Scenes
///
/// Fired when an object is touched/grabbed.
///
+ ///
/// The originalID is the local ID of the part that was actually touched. The localID itself is always that of
/// the root part.
+ /// Triggerd in response to
+ /// via
+ /// in
+ ///
public event ObjectGrabDelegate OnObjectGrab;
public delegate void ObjectGrabDelegate(uint localID, uint originalID, Vector3 offsetPos, IClientAPI remoteClient, SurfaceTouchEventArgs surfaceArgs);
+ ///
+ /// Triggered when an object is being touched/grabbed continuously.
+ ///
+ ///
+ /// Triggered in response to
+ /// via
+ /// in
+ ///
public event ObjectGrabDelegate OnObjectGrabbing;
+
+ ///
+ /// Triggered when an object stops being touched/grabbed.
+ ///
+ ///
+ /// Triggered in response to
+ /// via
+ /// in
+ ///
public event ObjectDeGrabDelegate OnObjectDeGrab;
public event ScriptResetDelegate OnScriptReset;
@@ -453,12 +475,27 @@ namespace OpenSim.Region.Framework.Scenes
///
/// Triggered when an object is added to the scene.
///
+ ///
+ /// Triggered by
+ /// in ,
+ /// ,
+ ///
+ ///
public event Action OnObjectAddedToScene;
///
- /// Triggered when an object is removed from the scene.
+ /// Delegate for
///
+ /// The object being removed from the scene
public delegate void ObjectBeingRemovedFromScene(SceneObjectGroup obj);
+
+ ///
+ /// Triggered when an object is removed from the scene.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ ///
public event ObjectBeingRemovedFromScene OnObjectBeingRemovedFromScene;
public delegate void NoticeNoLandDataFromStorage();
--
cgit v1.1
From 49e2872f9ee3c5c11145a43ec91bac2dab324f42 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Wed, 19 Sep 2012 20:26:57 +0100
Subject: Documentation of agent-related events
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 35 ++++++++++++++++++++++++-
1 file changed, 34 insertions(+), 1 deletion(-)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
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
public delegate void OnSetRootAgentSceneDelegate(UUID agentID, Scene scene);
+ ///
+ /// Triggered before the grunt work for adding a root agent to a
+ /// scene has been performed (resuming attachment scripts, physics,
+ /// animations etc.)
+ ///
+ ///
+ /// Triggered before
+ /// by
+ /// in
+ /// via
+ /// and
+ ///
public event OnSetRootAgentSceneDelegate OnSetRootAgentScene;
///
@@ -429,15 +441,36 @@ namespace OpenSim.Region.Framework.Scenes
public event ScriptColliding OnScriptLandColliderEnd;
public delegate void OnMakeChildAgentDelegate(ScenePresence presence);
+
+ ///
+ /// Triggered when an agent has been made a child agent of a scene.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via ,
+ /// ,
+ ///
+ ///
public event OnMakeChildAgentDelegate OnMakeChildAgent;
public delegate void OnSaveNewWindlightProfileDelegate();
public delegate void OnSendNewWindlightProfileTargetedDelegate(RegionLightShareData wl, UUID user);
///
+ /// Triggered after the grunt work for adding a root agent to a
+ /// scene has been performed (resuming attachment scripts, physics,
+ /// animations etc.)
+ ///
+ ///
/// This event is on the critical path for transferring an avatar from one region to another. Try and do
/// as little work on this event as possible, or do work asynchronously.
- ///
+ /// Triggered after
+ /// by
+ /// in
+ /// via
+ /// and
+ ///
public event Action OnMakeRootAgent;
public event OnSendNewWindlightProfileTargetedDelegate OnSendNewWindlightProfileTargeted;
--
cgit v1.1
From 696b3f66c482aa6ee56b0a0d7cd3686a43e59503 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Wed, 19 Sep 2012 20:27:52 +0100
Subject: minor tweaks to existing comments for IDE goodness
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 48a85a2..e415e09 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -496,9 +496,10 @@ namespace OpenSim.Region.Framework.Scenes
public event AvatarKillData OnAvatarKilled;
public delegate void AvatarKillData(uint KillerLocalID, ScenePresence avatar);
-// public delegate void ScriptTimerEvent(uint localID, double timerinterval);
-
-// public event ScriptTimerEvent OnScriptTimerEvent;
+ /*
+ public delegate void ScriptTimerEvent(uint localID, double timerinterval);
+ public event ScriptTimerEvent OnScriptTimerEvent;
+ */
public delegate void EstateToolsSunUpdate(ulong regionHandle, bool FixedTime, bool EstateSun, float LindenHour);
public delegate void GetScriptRunning(IClientAPI controllingClient, UUID objectID, UUID itemID);
@@ -724,7 +725,9 @@ namespace OpenSim.Region.Framework.Scenes
public UUID sender;
public UUID receiver;
- // Always false. The SL protocol sucks.
+ ///
+ /// Always false. The SL protocol sucks.
+ ///
public bool authenticated = false;
public int amount;
--
cgit v1.1
From d667f9d260808a27e91acf11244dded87517ec58 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Sat, 15 Sep 2012 17:32:10 +0100
Subject: Documentation of teleport-related events
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
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
public event PrimsLoaded OnPrimsLoaded;
public delegate void TeleportStart(IClientAPI client, GridRegion destination, GridRegion finalDestination, uint teleportFlags, bool gridLogout);
+
+ ///
+ /// Triggered when a teleport starts
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// and
+ /// via
+ ///
public event TeleportStart OnTeleportStart;
public delegate void TeleportFail(IClientAPI client, bool gridLogout);
+
+ ///
+ /// Trigered when a teleport fails.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ ///
public event TeleportFail OnTeleportFail;
public class MoneyTransferArgs : EventArgs
--
cgit v1.1
From 8d7b1f8aa08efbb2d0087abee22178c36cbc2f98 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Fri, 21 Sep 2012 23:32:41 +0100
Subject: Documenting non-LSL script-related events
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 52 +++++++++++++++++++++++++
1 file changed, 52 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index f079e00..96e9797 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -279,6 +279,16 @@ namespace OpenSim.Region.Framework.Scenes
/// in
///
public event ObjectDeGrabDelegate OnObjectDeGrab;
+
+ ///
+ /// Triggered when a script resets.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ ///
public event ScriptResetDelegate OnScriptReset;
public event OnPermissionErrorDelegate OnPermissionError;
@@ -288,17 +298,50 @@ namespace OpenSim.Region.Framework.Scenes
///
///
/// Occurs after OnNewScript.
+ /// Triggered by
+ /// in
///
public event NewRezScript OnRezScript;
public delegate void NewRezScript(uint localID, UUID itemID, string script, int startParam, bool postOnRez, string engine, int stateSource);
public delegate void RemoveScript(uint localID, UUID itemID);
+
+ ///
+ /// Triggered when a script is removed from an object.
+ ///
+ ///
+ /// Triggered by
+ /// in ,
+ /// ,
+ /// ,
+ ///
+ ///
public event RemoveScript OnRemoveScript;
public delegate void StartScript(uint localID, UUID itemID);
+
+ ///
+ /// Triggered when a script starts.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via ,
+ /// via
+ ///
public event StartScript OnStartScript;
public delegate void StopScript(uint localID, UUID itemID);
+
+ ///
+ /// Triggered when a script stops.
+ ///
+ ///
+ /// Triggered by ,
+ /// in ,
+ /// ,
+ ///
+ ///
public event StopScript OnStopScript;
public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta);
@@ -349,6 +392,9 @@ namespace OpenSim.Region.Framework.Scenes
///
///
/// Occurs before OnRezScript
+ /// Triggered by
+ /// in ,
+ ///
///
public event NewScript OnNewScript;
@@ -383,6 +429,12 @@ namespace OpenSim.Region.Framework.Scenes
///
///
/// Triggered after the scene receives a client's upload of an updated script and has stored it in an asset.
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ /// via
///
public event UpdateScript OnUpdateScript;
--
cgit v1.1
From 1cfd63d0b4bfdd1318d55b8d1c70ab25d101328d Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Sat, 22 Sep 2012 17:44:48 +0100
Subject: Documenting LSL script-related events
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 149 +++++++++++++++++++++++-
1 file changed, 147 insertions(+), 2 deletions(-)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 96e9797..22d395c 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -460,36 +460,170 @@ namespace OpenSim.Region.Framework.Scenes
}
///
+ /// Triggered when some scene object properties change.
+ ///
+ ///
/// ScriptChangedEvent is fired when a scene object property that a script might be interested
/// in (such as color, scale or inventory) changes. Only enough information sent is for the LSL changed event.
/// This is not an indication that the script has changed (see OnUpdateScript for that).
/// This event is sent to a script to tell it that some property changed on
/// the object the script is in. See http://lslwiki.net/lslwiki/wakka.php?wakka=changed .
- ///
+ /// Triggered by
+ /// in ,
+ ///
+ ///
public event ScriptChangedEvent OnScriptChangedEvent;
public delegate void ScriptChangedEvent(uint localID, uint change);
public delegate void ScriptControlEvent(UUID item, UUID avatarID, uint held, uint changed);
+
+ ///
+ /// Triggered when a script receives control input from an agent.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event ScriptControlEvent OnScriptControlEvent;
public delegate void ScriptAtTargetEvent(uint localID, uint handle, Vector3 targetpos, Vector3 atpos);
+
+ ///
+ /// Triggered when an object has arrived within a tolerance distance
+ /// of a motion target.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via ,
+ /// via
+ ///
public event ScriptAtTargetEvent OnScriptAtTargetEvent;
public delegate void ScriptNotAtTargetEvent(uint localID);
+
+ ///
+ /// Triggered when an object has a motion target but has not arrived
+ /// within a tolerance distance.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via ,
+ /// via
+ ///
public event ScriptNotAtTargetEvent OnScriptNotAtTargetEvent;
public delegate void ScriptAtRotTargetEvent(uint localID, uint handle, Quaternion targetrot, Quaternion atrot);
+
+ ///
+ /// Triggered when an object has arrived within a tolerance rotation
+ /// of a rotation target.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via ,
+ /// via
+ ///
public event ScriptAtRotTargetEvent OnScriptAtRotTargetEvent;
public delegate void ScriptNotAtRotTargetEvent(uint localID);
+
+ ///
+ /// Triggered when an object has a rotation target but has not arrived
+ /// within a tolerance rotation.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via ,
+ /// via
+ ///
public event ScriptNotAtRotTargetEvent OnScriptNotAtRotTargetEvent;
public delegate void ScriptColliding(uint localID, ColliderArgs colliders);
+
+ ///
+ /// Triggered when a physical collision has started between a prim
+ /// and something other than the region terrain.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event ScriptColliding OnScriptColliderStart;
+
+ ///
+ /// Triggered when something that previously collided with a prim has
+ /// not stopped colliding with it.
+ ///
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event ScriptColliding OnScriptColliding;
+
+ ///
+ /// Triggered when something that previously collided with a prim has
+ /// stopped colliding with it.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event ScriptColliding OnScriptCollidingEnd;
+
+ ///
+ /// Triggered when a physical collision has started between an object
+ /// and the region terrain.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event ScriptColliding OnScriptLandColliderStart;
+
+ ///
+ /// Triggered when an object that previously collided with the region
+ /// terrain has not yet stopped colliding with it.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event ScriptColliding OnScriptLandColliding;
+
+ ///
+ /// Triggered when an object that previously collided with the region
+ /// terrain has stopped colliding with it.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event ScriptColliding OnScriptLandColliderEnd;
public delegate void OnMakeChildAgentDelegate(ScenePresence presence);
@@ -550,6 +684,13 @@ namespace OpenSim.Region.Framework.Scenes
/*
public delegate void ScriptTimerEvent(uint localID, double timerinterval);
+ ///
+ /// Used to be triggered when the LSL timer event fires.
+ ///
+ ///
+ /// Triggered by
+ /// via
+ ///
public event ScriptTimerEvent OnScriptTimerEvent;
*/
@@ -2293,7 +2434,11 @@ namespace OpenSim.Region.Framework.Scenes
}
}
- // this lets us keep track of nasty script events like timer, etc.
+ ///
+ /// this lets us keep track of nasty script events like timer, etc.
+ ///
+ ///
+ ///
public void TriggerTimerEvent(uint objLocalID, double Interval)
{
throw new NotImplementedException("TriggerTimerEvent was thought to be not used anymore and the registration for the event from scene object part has been commented out due to a memory leak");
--
cgit v1.1
From 020103c51e4b8e340c44b2cfbe7826a95b041068 Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Sun, 23 Sep 2012 15:33:01 +0100
Subject: Documenting object-related events
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 43 +++++++++++++++++++++++++
1 file changed, 43 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 22d395c..e25fa94 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -345,15 +345,58 @@ namespace OpenSim.Region.Framework.Scenes
public event StopScript OnStopScript;
public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta);
+
+ ///
+ /// Triggered when an object is moved.
+ ///
+ ///
+ /// Triggered by
+ /// in ,
+ ///
+ ///
public event SceneGroupMoved OnSceneGroupMove;
public delegate void SceneGroupGrabed(UUID groupID, Vector3 offset, UUID userID);
+
+ ///
+ /// Triggered when an object is grabbed.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ /// via
+ ///
public event SceneGroupGrabed OnSceneGroupGrab;
public delegate bool SceneGroupSpinStarted(UUID groupID);
+
+ ///
+ /// Triggered when an object starts to spin.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event SceneGroupSpinStarted OnSceneGroupSpinStart;
public delegate bool SceneGroupSpun(UUID groupID, Quaternion rotation);
+
+ ///
+ /// Triggered when an object is being spun.
+ ///
+ ///
+ /// Triggered by
+ /// in
+ /// via
+ /// via
+ /// via
+ ///
public event SceneGroupSpun OnSceneGroupSpin;
public delegate void LandObjectAdded(ILandObject newParcel);
--
cgit v1.1
From 91ca3117cb35444e6b0e4300468959ed43c048c3 Mon Sep 17 00:00:00 2001
From: Dan Lake
Date: Fri, 5 Oct 2012 17:32:07 -0700
Subject: Add bool to TriggerSceneObjectPartUpdated where full = true indicates
a full update. There should be a better way to indicate which properties have
changed that is non LLUDP-centric
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index e25fa94..a8ff218 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -913,7 +913,7 @@ namespace OpenSim.Region.Framework.Scenes
public event SceneObjectPartCopyDelegate OnSceneObjectPartCopy;
public delegate void SceneObjectPartCopyDelegate(SceneObjectPart copy, SceneObjectPart original, bool userExposed);
- public delegate void SceneObjectPartUpdated(SceneObjectPart sop);
+ public delegate void SceneObjectPartUpdated(SceneObjectPart sop, bool full);
public event SceneObjectPartUpdated OnSceneObjectPartUpdated;
public delegate void ScenePresenceUpdated(ScenePresence sp);
@@ -2837,7 +2837,7 @@ namespace OpenSim.Region.Framework.Scenes
}
}
- public void TriggerSceneObjectPartUpdated(SceneObjectPart sop)
+ public void TriggerSceneObjectPartUpdated(SceneObjectPart sop, bool full)
{
SceneObjectPartUpdated handler = OnSceneObjectPartUpdated;
if (handler != null)
@@ -2846,7 +2846,7 @@ namespace OpenSim.Region.Framework.Scenes
{
try
{
- d(sop);
+ d(sop, full);
}
catch (Exception e)
{
--
cgit v1.1
From 528085adefdd105aca2621c747fefe728ea8c218 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 10 Oct 2012 00:48:20 +0100
Subject: minor: Add method doc to EventManager.OnNewClient, OnClientLogin,
ClientClosed, OnRemovePresence that any long-running operations should be
launched on a thread separate to the event thread.
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 14 ++++++++++++++
1 file changed, 14 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index a8ff218..4c49b71 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -121,13 +121,21 @@ namespace OpenSim.Region.Framework.Scenes
///
///
/// This is triggered for both child and root agent client connections.
+ ///
/// Triggered before OnClientLogin.
+ ///
+ /// This is triggered under per-agent lock. So if you want to perform any long-running operations, please
+ /// do this on a separate thread.
///
public event OnNewClientDelegate OnNewClient;
///
/// Fired if the client entering this sim is doing so as a new login
///
+ ///
+ /// This is triggered under per-agent lock. So if you want to perform any long-running operations, please
+ /// do this on a separate thread.
+ ///
public event Action OnClientLogin;
public delegate void OnNewPresenceDelegate(ScenePresence presence);
@@ -149,6 +157,9 @@ namespace OpenSim.Region.Framework.Scenes
///
/// Triggered in which is used by both
/// users and NPCs
+ ///
+ /// Triggered under per-agent lock. So if you want to perform any long-running operations, please
+ /// do this on a separate thread.
///
public event OnRemovePresenceDelegate OnRemovePresence;
@@ -425,6 +436,9 @@ namespace OpenSim.Region.Framework.Scenes
///
///
/// At the point of firing, the scene still contains the client's scene presence.
+ ///
+ /// This is triggered under per-agent lock. So if you want to perform any long-running operations, please
+ /// do this on a separate thread.
///
public event ClientClosed OnClientClosed;
--
cgit v1.1
From 4fa088bafb4c78ad3177b0e944a4312bd6abdea7 Mon Sep 17 00:00:00 2001
From: teravus
Date: Sun, 4 Nov 2012 22:57:24 -0500
Subject: Pipe Throttle Update Event to EventManager, client --> ScenePresence
--> EventManager, so that modules can know when throttles are updated. The
event contains no client specific data to preserve the possibility of
'multiple clients' and you must still call
ControllingClient.GetThrottlesPacked(f) to see what the throttles actually
are once the event fires. Hook EventManager.OnUpdateThrottle to
GetTextureModule.
---
OpenSim/Region/Framework/Scenes/EventManager.cs | 13 +++++++++++++
1 file changed, 13 insertions(+)
(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index 7916c42..4a19c3b 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -376,6 +376,10 @@ namespace OpenSim.Region.Framework.Scenes
public event ParcelPrimCountTainted OnParcelPrimCountTainted;
public event GetScriptRunning OnGetScriptRunning;
+ public delegate void ThrottleUpdate(ScenePresence scenePresence);
+
+ public event ThrottleUpdate OnThrottleUpdate;
+
///
/// RegisterCapsEvent is called by Scene after the Caps object
/// has been instantiated and before it is return to the
@@ -2641,5 +2645,14 @@ namespace OpenSim.Region.Framework.Scenes
}
}
}
+
+ public void TriggerThrottleUpdate(ScenePresence scenePresence)
+ {
+ ThrottleUpdate handler = OnThrottleUpdate;
+ if (handler != null)
+ {
+ handler(scenePresence);
+ }
+ }
}
}
--
cgit v1.1