IScriptInstance.cs 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  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 System;
  28. using System.Collections;
  29. using System.Collections.Generic;
  30. using OpenMetaverse;
  31. using log4net;
  32. using OpenSim.Framework;
  33. using OpenSim.Region.ScriptEngine.Shared;
  34. using OpenSim.Region.ScriptEngine.Interfaces;
  35. namespace OpenSim.Region.ScriptEngine.Interfaces
  36. {
  37. public enum StateSource
  38. {
  39. RegionStart = 0,
  40. NewRez = 1,
  41. PrimCrossing = 2,
  42. ScriptedRez = 3,
  43. AttachedRez = 4,
  44. Teleporting = 5
  45. }
  46. public interface IScriptWorkItem
  47. {
  48. bool Cancel();
  49. void Abort();
  50. bool Wait(TimeSpan t);
  51. }
  52. /// <summary>
  53. /// Interface for interaction with a particular script instance
  54. /// </summary>
  55. public interface IScriptInstance
  56. {
  57. /// <summary>
  58. /// Is this script currently running?
  59. /// </summary>
  60. bool Running { get; set; }
  61. bool ShuttingDown { get; set; }
  62. string State { get; set; }
  63. IScriptEngine Engine { get; }
  64. UUID AppDomain { get; set; }
  65. string PrimName { get; }
  66. string ScriptName { get; }
  67. UUID ItemID { get; }
  68. UUID ObjectID { get; }
  69. uint LocalID { get; }
  70. UUID AssetID { get; }
  71. Queue EventQueue { get; }
  72. void ClearQueue();
  73. int StartParam { get; set; }
  74. void RemoveState();
  75. void Init();
  76. void Start();
  77. /// <summary>
  78. /// Stop the script.
  79. /// </summary>
  80. /// <param name="timeout"></param>
  81. /// <returns>true if the script was successfully stopped, false otherwise</returns>
  82. bool Stop(int timeout);
  83. void SetState(string state);
  84. void PostEvent(EventParams data);
  85. void Suspend();
  86. void Resume();
  87. /// <summary>
  88. /// Process the next event queued for this script
  89. /// </summary>
  90. /// <returns></returns>
  91. object EventProcessor();
  92. int EventTime();
  93. void ResetScript();
  94. void ApiResetScript();
  95. Dictionary<string, object> GetVars();
  96. void SetVars(Dictionary<string, object> vars);
  97. DetectParams GetDetectParams(int idx);
  98. UUID GetDetectID(int idx);
  99. void SaveState(string assembly);
  100. void DestroyScriptInstance();
  101. IScriptApi GetApi(string name);
  102. Dictionary<KeyValuePair<int, int>, KeyValuePair<int, int>> LineMap
  103. { get; set; }
  104. string GetAssemblyName();
  105. string GetXMLState();
  106. double MinEventDelay { set; }
  107. UUID RegionID { get; }
  108. }
  109. }