10 files changed, 319 insertions, 13 deletions

diff --git a/OpenSim/Region/Framework/Interfaces/IAttachmentsModule.cs b/OpenSim/Region/Framework/Interfaces/IAttachmentsModule.cs
index 90a13a7..d781eae 100644
--- a/OpenSim/Region/Framework/Interfaces/IAttachmentsModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IAttachmentsModule.cs
@@ -114,6 +114,15 @@ namespace OpenSim.Region.Framework.Interfaces
         void DetachSingleAttachmentToGround(IScenePresence sp, uint objectLocalID);
 
         /// <summary>
+        /// Detach the given item to the ground at the specified coordinates & rotation
+        /// </summary>
+        /// <param name="sp"></param>
+        /// <param name="objectLocalID"></param>
+        /// <param name="absolutePos"></param>
+        /// <param name="absoluteRot"></param>
+        void DetachSingleAttachmentToGround(IScenePresence sp, uint objectLocalID, Vector3 absolutePos, Quaternion absoluteRot);
+
+        /// <summary>
         /// Detach the given attachment so that it remains in the user's inventory.
         /// </summary>
         /// <param name="sp">/param>
diff --git a/OpenSim/Region/Framework/Interfaces/IDynamicTextureManager.cs b/OpenSim/Region/Framework/Interfaces/IDynamicTextureManager.cs
index 8954513..6df5cc2 100644
--- a/OpenSim/Region/Framework/Interfaces/IDynamicTextureManager.cs
+++ b/OpenSim/Region/Framework/Interfaces/IDynamicTextureManager.cs
@@ -25,6 +25,8 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+using System;
+using System.Drawing;
 using System.IO;
 using OpenMetaverse;
 
@@ -33,7 +35,14 @@ namespace OpenSim.Region.Framework.Interfaces
     public interface IDynamicTextureManager
     {
         void RegisterRender(string handleType, IDynamicTextureRender render);
-        void ReturnData(UUID id, byte[] data);
+
+        /// <summary>
+        /// Used by IDynamicTextureRender implementations to return renders
+        /// </summary>
+        /// <param name='id'></param>
+        /// <param name='data'></param>
+        /// <param name='isReuseable'></param>
+        void ReturnData(UUID id, IDynamicTexture texture);
 
         UUID AddDynamicTextureURL(UUID simID, UUID primID, string contentType, string url, string extraParams,
                                     int updateTimer);
@@ -113,11 +122,65 @@ namespace OpenSim.Region.Framework.Interfaces
         string GetName();
         string GetContentType();
         bool SupportsAsynchronous();
-        byte[] ConvertUrl(string url, string extraParams);
-        byte[] ConvertStream(Stream data, string extraParams);
+
+//        /// <summary>
+//        /// Return true if converting the input body and extra params data will always result in the same byte[] array
+//        /// </summary>
+//        /// <remarks>
+//        /// This method allows the caller to use a previously generated asset if it has one.
+//        /// </remarks>
+//        /// <returns></returns>
+//        /// <param name='bodyData'></param>
+//        /// <param name='extraParams'></param>
+//        bool AlwaysIdenticalConversion(string bodyData, string extraParams);
+
+        IDynamicTexture ConvertUrl(string url, string extraParams);
+        IDynamicTexture ConvertData(string bodyData, string extraParams);
+
         bool AsyncConvertUrl(UUID id, string url, string extraParams);
         bool AsyncConvertData(UUID id, string bodyData, string extraParams);
+
         void GetDrawStringSize(string text, string fontName, int fontSize, 
                                out double xSize, out double ySize);
     }
+
+    public interface IDynamicTexture
+    {
+        /// <summary>
+        /// Input commands used to generate this data.
+        /// </summary>
+        /// <remarks>
+        /// Null if input commands were not used.
+        /// </remarks>
+        string InputCommands { get; }
+
+        /// <summary>
+        /// Uri used to generate this data.
+        /// </summary>
+        /// <remarks>
+        /// Null if a uri was not used.
+        /// </remarks>
+        Uri InputUri { get; }
+
+        /// <summary>
+        /// Extra input params used to generate this data.
+        /// </summary>
+        string InputParams { get; }
+
+        /// <summary>
+        /// Texture data.
+        /// </summary>
+        byte[] Data { get; }
+
+        /// <summary>
+        /// Size of texture.
+        /// </summary>
+        Size Size { get; }
+
+        /// <summary>
+        /// Signal whether the texture is reuseable (i.e. whether the same input data will always generate the same
+        /// texture).
+        /// </summary>
+        bool IsReuseable { get; }
+    }
 }
diff --git a/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs b/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs
index 4274cbe..8028d87 100644
--- a/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs
@@ -152,6 +152,19 @@ namespace OpenSim.Region.Framework.Interfaces
         void StopScriptInstance(UUID itemId);
 
         /// <summary>
+        /// Try to get the script running status.
+        /// </summary>
+        /// <returns>
+        /// Returns true if a script for the item was found in one of the simulator's script engines.  In this case,
+        /// the running parameter will reflect the running status.
+        /// Returns false if the item could not be found, if the item is not a script or if a script instance for the
+        /// item was not found in any of the script engines.  In this case, running status is irrelevant.
+        /// </returns>
+        /// <param name='itemId'></param>
+        /// <param name='running'></param>
+        bool TryGetScriptInstanceRunning(UUID itemId, out bool running);
+
+        /// <summary>
         /// Add an item to this entity's inventory.  If an item with the same name already exists, then an alternative
         /// name is chosen.
         /// </summary>
@@ -270,17 +283,25 @@ namespace OpenSim.Region.Framework.Interfaces
         void ApplyGodPermissions(uint perms);
 
         /// <summary>
+        /// Number of items in this inventory.
+        /// </summary>
+        int Count { get; }
+
+        /// <summary>
         /// Returns true if this inventory contains any scripts
         /// </summary></returns>
         bool ContainsScripts();
 
         /// <summary>
-        /// Returns the count of scripts contained
-        /// </summary></returns>
+        /// Number of scripts in this inventory.
+        /// </summary>
+        /// <remarks>
+        /// Includes both running and non running scripts.
+        /// </remarks>
         int ScriptCount();
 
         /// <summary>
-        /// Returns the count of running scripts contained
+        /// Number of running scripts in this inventory.
         /// </summary></returns>
         int RunningScriptCount();
 
diff --git a/OpenSim/Region/Framework/Interfaces/IEstateModule.cs b/OpenSim/Region/Framework/Interfaces/IEstateModule.cs
index ca2ad94..292efa4 100644
--- a/OpenSim/Region/Framework/Interfaces/IEstateModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEstateModule.cs
@@ -46,6 +46,10 @@ namespace OpenSim.Region.Framework.Interfaces
         /// </summary>
         void sendRegionHandshakeToAll();
         void TriggerEstateInfoChange();
+
+        /// <summary>
+        /// Fires the OnRegionInfoChange event.
+        /// </summary>
         void TriggerRegionInfoChange();
 
         void setEstateTerrainBaseTexture(int level, UUID texture);
diff --git a/OpenSim/Region/Framework/Interfaces/IJsonStoreModule.cs b/OpenSim/Region/Framework/Interfaces/IJsonStoreModule.cs
index baac6e8..da39e95 100644
--- a/OpenSim/Region/Framework/Interfaces/IJsonStoreModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IJsonStoreModule.cs
@@ -35,7 +35,7 @@ namespace OpenSim.Region.Framework.Interfaces
 
     public interface IJsonStoreModule
     {
-        bool CreateStore(string value, out UUID result);
+        bool CreateStore(string value, ref UUID result);
         bool DestroyStore(UUID storeID);
         bool TestPath(UUID storeID, string path, bool useJson);
         bool SetValue(UUID storeID, string path, string value, bool useJson);
diff --git a/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs b/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs
index a76ffde..70ff954 100644
--- a/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs
+++ b/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs
@@ -47,9 +47,46 @@ namespace OpenSim.Region.Framework.Interfaces
         /// </summary>
         event ScriptCommand OnScriptCommand;
 
+        /// <summary>
+        /// Register an instance method as a script call by method name
+        /// </summary>
+        /// <param name="target"></param>
+        /// <param name="method"></param>
         void RegisterScriptInvocation(object target, string method);
+
+        /// <summary>
+        /// Register a static or instance method as a script call by method info
+        /// </summary>
+        /// <param name="target">If target is a Type object, will assume method is static.</param>
+        /// <param name="method"></param>
         void RegisterScriptInvocation(object target, MethodInfo method);
+
+        /// <summary>
+        /// Register one or more instance methods as script calls by method name
+        /// </summary>
+        /// <param name="target"></param>
+        /// <param name="methods"></param>
         void RegisterScriptInvocation(object target, string[] methods);
+
+        /// <summary>
+        /// Register one or more static methods as script calls by method name
+        /// </summary>
+        /// <param name="target"></param>
+        /// <param name="methods"></param>
+        void RegisterScriptInvocation(Type target, string[] methods);
+
+        /// <summary>
+        /// Automatically register script invocations by checking for methods
+        /// with <see cref="ScriptInvocationAttribute"/>. Should only check
+        /// public methods.
+        /// </summary>
+        /// <param name="target"></param>
+        void RegisterScriptInvocations(IRegionModuleBase target);
+
+        /// <summary>
+        /// Returns an array of all registered script calls
+        /// </summary>
+        /// <returns></returns>
         Delegate[] GetScriptInvocationList();
 
         Delegate LookupScriptInvocation(string fname);
@@ -68,12 +105,44 @@ namespace OpenSim.Region.Framework.Interfaces
         /// <param name="key"></param>
         void DispatchReply(UUID scriptId, int code, string text, string key);
 
-        /// For constants
+        /// <summary>
+        /// Operation to for a region module to register a constant to be used
+        /// by the script engine
+        /// </summary>
+        /// <param name="cname">
+        /// The name of the constant. LSL convention is for constant names to
+        /// be uppercase.
+        /// </param>
+        /// <param name="value">
+        /// The value of the constant. Should be of a type that can be
+        /// converted to one of <see cref="OpenSim.Region.ScriptEngine.Shared.LSL_Types"/>
+        /// </param>
         void RegisterConstant(string cname, object value);
+
+        /// <summary>
+        /// Automatically register all constants on a region module by
+        /// checking for fields with <see cref="ScriptConstantAttribute"/>.
+        /// </summary>
+        /// <param name="target"></param>
+        void RegisterConstants(IRegionModuleBase target);
+
+        /// <summary>
+        /// Operation to check for a registered constant
+        /// </summary>
+        /// <param name="cname">Name of constant</param>
+        /// <returns>Value of constant or null if none found.</returns>
         object LookupModConstant(string cname);
         Dictionary<string, object> GetConstants();
 
         // For use ONLY by the script API
         void RaiseEvent(UUID script, string id, string module, string command, string key);
     }
+
+    [AttributeUsage(AttributeTargets.Method)]
+    public class ScriptInvocationAttribute : Attribute
+    { }
+
+    [AttributeUsage(AttributeTargets.Field)]
+    public class ScriptConstantAttribute : Attribute
+    { }
 }
diff --git a/OpenSim/Region/Framework/Interfaces/ISoundModule.cs b/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
index 6117a80..68af492 100644
--- a/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
@@ -32,9 +32,96 @@ namespace OpenSim.Region.Framework.Interfaces
 {
     public interface ISoundModule
     {
-        void PlayAttachedSound(UUID soundID, UUID ownerID, UUID objectID, double gain, Vector3 position, byte flags, float radius);
-        
+        /// <summary>
+        /// Maximum distance between a sound source and a recipient.
+        /// </summary>
+        float MaxDistance { get; }
+
+        /// <summary>
+        /// Play a sound from an object.
+        /// </summary>
+        /// <param name="soundID">Sound asset ID</param>
+        /// <param name="ownerID">Sound source owner</param>
+        /// <param name="objectID">Sound source ID</param>
+        /// <param name="gain">Sound volume</param>
+        /// <param name="position">Sound source position</param>
+        /// <param name="flags">Sound flags</param>
+        /// <param name="radius">
+        /// Radius used to affect gain over distance.
+        /// </param>
+        void PlayAttachedSound(UUID soundID, UUID ownerID, UUID objectID,
+                double gain, Vector3 position, byte flags, float radius);
+
+        /// <summary>
+        /// Trigger a sound in the scene.
+        /// </summary>
+        /// <param name="soundId">Sound asset ID</param>
+        /// <param name="ownerID">Sound source owner</param>
+        /// <param name="objectID">Sound source ID</param>
+        /// <param name="parentID">Sound source parent.</param>
+        /// <param name="gain">Sound volume</param>
+        /// <param name="position">Sound source position</param>
+        /// <param name="handle"></param>
+        /// <param name="radius">
+        /// Radius used to affect gain over distance.
+        /// </param>
         void TriggerSound(
-            UUID soundId, UUID ownerID, UUID objectID, UUID parentID, double gain, Vector3 position, UInt64 handle, float radius);
+                UUID soundId, UUID ownerID, UUID objectID, UUID parentID,
+                double gain, Vector3 position, UInt64 handle, float radius);
+
+        /// <summary>
+        /// Stop sounds eminating from an object.
+        /// </summary>
+        /// <param name="objectID">Sound source ID</param>
+        void StopSound(UUID objectID);
+
+        /// <summary>
+        /// Preload sound to viewers within range.
+        /// </summary>
+        /// <param name="objectID">Sound source ID</param>
+        /// <param name="soundID">Sound asset ID</param>
+        /// <param name="radius">
+        /// Radius used to determine which viewers should preload the sound.
+        /// </param>
+        void PreloadSound(UUID objectID, UUID soundID, float radius);
+
+        /// <summary>
+        /// Loop specified sound at specified volume with specified radius,
+        /// optionally declaring object as new sync master.
+        /// </summary>
+        /// <param name="objectID">Sound source ID</param>
+        /// <param name="soundID">Sound asset ID</param>
+        /// <param name="gain">Sound volume</param>
+        /// <param name="radius">Sound radius</param>
+        /// <param name="isMaster">Set object to sync master if true</param>
+        void LoopSound(UUID objectID, UUID soundID, double gain,
+                double radius, bool isMaster);
+
+        /// <summary>
+        /// Trigger or play an attached sound in this part's inventory.
+        /// </summary>
+        /// <param name="objectID">Sound source ID</param>
+        /// <param name="sound">Sound asset ID</param>
+        /// <param name="volume">Sound volume</param>
+        /// <param name="triggered">Triggered or not.</param>
+        /// <param name="flags"></param>
+        /// <param name="radius">Sound radius</param>
+        /// <param name="useMaster">Play using sound master</param>
+        /// <param name="isMaster">Play as sound master</param>
+        void SendSound(UUID objectID, UUID sound, double volume,
+                bool triggered, byte flags, float radius, bool useMaster,
+                bool isMaster);
+
+        /// <summary>
+        /// Trigger a sound to be played to all agents within an axis-aligned
+        /// bounding box.
+        /// </summary>
+        /// <param name="objectID">Sound source ID</param>
+        /// <param name="sound">Sound asset ID</param>
+        /// <param name="volume">Sound volume</param>
+        /// <param name="min">AABB bottom south-west corner</param>
+        /// <param name="max">AABB top north-east corner</param>
+        void TriggerSoundLimited(UUID objectID, UUID sound, double volume,
+                Vector3 min, Vector3 max);
     }
 }
\ No newline at end of file
diff --git a/OpenSim/Region/Framework/Interfaces/IUrlModule.cs b/OpenSim/Region/Framework/Interfaces/IUrlModule.cs
index 457444c..79e9f9d 100644
--- a/OpenSim/Region/Framework/Interfaces/IUrlModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IUrlModule.cs
@@ -39,6 +39,8 @@ namespace OpenSim.Region.Framework.Interfaces
         UUID RequestSecureURL(IScriptModule engine, SceneObjectPart host, UUID itemID);
         void ReleaseURL(string url);
         void HttpResponse(UUID request, int status, string body);
+        void HttpContentType(UUID request, string type);
+        
         string GetHttpHeader(UUID request, string header);
         int GetFreeUrls();
 
diff --git a/OpenSim/Region/Framework/Interfaces/IUserManagement.cs b/OpenSim/Region/Framework/Interfaces/IUserManagement.cs
index 24cd069..f8088c3 100644
--- a/OpenSim/Region/Framework/Interfaces/IUserManagement.cs
+++ b/OpenSim/Region/Framework/Interfaces/IUserManagement.cs
@@ -1,4 +1,31 @@
-using System;
+/*
+ * Copyright (c) Contributors, http://opensimulator.org/
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the OpenSimulator Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+using System;
 using System.Collections.Generic;
 
 using OpenMetaverse;
diff --git a/OpenSim/Region/Framework/Interfaces/IWorldComm.cs b/OpenSim/Region/Framework/Interfaces/IWorldComm.cs
index e8e375e..20e0199 100644
--- a/OpenSim/Region/Framework/Interfaces/IWorldComm.cs
+++ b/OpenSim/Region/Framework/Interfaces/IWorldComm.cs
@@ -45,6 +45,13 @@ namespace OpenSim.Region.Framework.Interfaces
         void Deactivate();
         void Activate();
         UUID GetID();
+
+        /// <summary>
+        /// Bitfield indicating which strings should be processed as regex.
+        /// 1 corresponds to IWorldCommListenerInfo::GetName()
+        /// 2 corresponds to IWorldCommListenerInfo::GetMessage()
+        /// </summary>
+        int RegexBitfield { get; }
     }
 
     public interface IWorldComm
@@ -60,7 +67,7 @@ namespace OpenSim.Region.Framework.Interfaces
         /// the script during 'peek' time. Parameter hostID is needed to
         /// determine the position of the script.
         /// </summary>
-        /// <param name="localID">localID of the script engine</param>
+        /// <param name="LocalID">localID of the script engine</param>
         /// <param name="itemID">UUID of the script engine</param>
         /// <param name="hostID">UUID of the SceneObjectPart</param>
         /// <param name="channel">channel to listen on</param>
@@ -70,6 +77,23 @@ namespace OpenSim.Region.Framework.Interfaces
         /// <returns>number of the scripts handle</returns>
         int Listen(uint LocalID, UUID itemID, UUID hostID, int channel, string name, UUID id, string msg);
 
+         /// <summary>
+        /// Create a listen event callback with the specified filters.
+        /// The parameters localID,itemID are needed to uniquely identify
+        /// the script during 'peek' time. Parameter hostID is needed to
+        /// determine the position of the script.
+        /// </summary>
+        /// <param name="LocalID">localID of the script engine</param>
+        /// <param name="itemID">UUID of the script engine</param>
+        /// <param name="hostID">UUID of the SceneObjectPart</param>
+        /// <param name="channel">channel to listen on</param>
+        /// <param name="name">name to filter on</param>
+        /// <param name="id">key to filter on (user given, could be totally faked)</param>
+        /// <param name="msg">msg to filter on</param>
+        /// <param name="regexBitfield">Bitfield indicating which strings should be processed as regex.</param>
+        /// <returns>number of the scripts handle</returns>
+        int Listen(uint LocalID, UUID itemID, UUID hostID, int channel, string name, UUID id, string msg, int regexBitfield);
+
         /// <summary>
         /// This method scans over the objects which registered an interest in listen callbacks.
         /// For everyone it finds, it checks if it fits the given filter. If it does,  then