IScriptEngine.cs 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using log4net;
  28. using System;
  29. using OpenSim.Region.ScriptEngine.Shared;
  30. using OpenSim.Region.Framework.Scenes;
  31. using OpenSim.Region.Framework.Interfaces;
  32. using OpenMetaverse;
  33. using Nini.Config;
  34. using OpenSim.Region.ScriptEngine.Interfaces;
  35. using Amib.Threading;
  36. using OpenSim.Framework;
  37. namespace OpenSim.Region.ScriptEngine.Interfaces
  38. {
  39. /// <summary>
  40. /// An interface for a script API module to communicate with
  41. /// the engine it's running under
  42. /// </summary>
  43. public delegate void ScriptRemoved(UUID script);
  44. public delegate void ObjectRemoved(UUID prim);
  45. public interface IScriptEngine
  46. {
  47. /// <summary>
  48. /// Queue an event for execution
  49. /// </summary>
  50. IScriptWorkItem QueueEventHandler(object parms);
  51. Scene World { get; }
  52. IScriptModule ScriptModule { get; }
  53. event ScriptRemoved OnScriptRemoved;
  54. event ObjectRemoved OnObjectRemoved;
  55. /// <summary>
  56. /// Post an event to a single script
  57. /// </summary>
  58. bool PostScriptEvent(UUID itemID, EventParams parms);
  59. /// <summary>
  60. /// Post event to an entire prim
  61. /// </summary>
  62. bool PostObjectEvent(uint localID, EventParams parms);
  63. DetectParams GetDetectParams(UUID item, int number);
  64. void SetMinEventDelay(UUID itemID, double delay);
  65. int GetStartParameter(UUID itemID);
  66. void SetScriptState(UUID itemID, bool state);
  67. bool GetScriptState(UUID itemID);
  68. void SetState(UUID itemID, string newState);
  69. void ApiResetScript(UUID itemID);
  70. void ResetScript(UUID itemID);
  71. IConfig Config { get; }
  72. IConfigSource ConfigSource { get; }
  73. string ScriptEngineName { get; }
  74. string ScriptEnginePath { get; }
  75. IScriptApi GetApi(UUID itemID, string name);
  76. }
  77. }