IWorldComm.cs 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  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 OpenMetaverse;
  29. using OpenSim.Framework;
  30. namespace OpenSim.Region.Framework.Interfaces
  31. {
  32. public interface IWorldCommListenerInfo
  33. {
  34. Object[] GetSerializationData();
  35. UUID GetItemID();
  36. UUID GetHostID();
  37. int GetChannel();
  38. uint GetLocalID();
  39. int GetHandle();
  40. string GetMessage();
  41. string GetName();
  42. bool IsActive();
  43. void Deactivate();
  44. void Activate();
  45. UUID GetID();
  46. }
  47. public interface IWorldComm
  48. {
  49. /// <summary>
  50. /// Create a listen event callback with the specified filters.
  51. /// The parameters localID,itemID are needed to uniquely identify
  52. /// the script during 'peek' time. Parameter hostID is needed to
  53. /// determine the position of the script.
  54. /// </summary>
  55. /// <param name="localID">localID of the script engine</param>
  56. /// <param name="itemID">UUID of the script engine</param>
  57. /// <param name="hostID">UUID of the SceneObjectPart</param>
  58. /// <param name="channel">channel to listen on</param>
  59. /// <param name="name">name to filter on</param>
  60. /// <param name="id">key to filter on (user given, could be totally faked)</param>
  61. /// <param name="msg">msg to filter on</param>
  62. /// <returns>number of the scripts handle</returns>
  63. int Listen(uint LocalID, UUID itemID, UUID hostID, int channel, string name, UUID id, string msg);
  64. /// <summary>
  65. /// This method scans over the objects which registered an interest in listen callbacks.
  66. /// For everyone it finds, it checks if it fits the given filter. If it does, then
  67. /// enqueue the message for delivery to the objects listen event handler.
  68. /// The enqueued ListenerInfo no longer has filter values, but the actually trigged values.
  69. /// Objects that do an llSay have their messages delivered here and for nearby avatars,
  70. /// the OnChatFromClient event is used.
  71. /// </summary>
  72. /// <param name="type">type of delvery (whisper,say,shout or regionwide)</param>
  73. /// <param name="channel">channel to sent on</param>
  74. /// <param name="name">name of sender (object or avatar)</param>
  75. /// <param name="id">key of sender (object or avatar)</param>
  76. /// <param name="msg">msg to sent</param>
  77. void DeliverMessage(ChatTypeEnum type, int channel, string name, UUID id, string msg);
  78. /// <summary>
  79. /// Delivers the message to a specified object in the region.
  80. /// </summary>
  81. /// <param name='target'>
  82. /// Target.
  83. /// </param>
  84. /// <param name='channel'>
  85. /// Channel.
  86. /// </param>
  87. /// <param name='name'>
  88. /// Name.
  89. /// </param>
  90. /// <param name='id'>
  91. /// Identifier.
  92. /// </param>
  93. /// <param name='msg'>
  94. /// Message.
  95. /// </param>
  96. bool DeliverMessageTo(UUID target, int channel, Vector3 pos, string name, UUID id, string msg, out string error);
  97. /// <summary>
  98. /// Are there any listen events ready to be dispatched?
  99. /// </summary>
  100. /// <returns>boolean indication</returns>
  101. bool HasMessages();
  102. /// <summary>
  103. /// Pop the first availlable listen event from the queue
  104. /// </summary>
  105. /// <returns>ListenerInfo with filter filled in</returns>
  106. IWorldCommListenerInfo GetNextMessage();
  107. void ListenControl(UUID itemID, int handle, int active);
  108. void ListenRemove(UUID itemID, int handle);
  109. void DeleteListener(UUID itemID);
  110. Object[] GetSerializationData(UUID itemID);
  111. void CreateFromData(uint localID, UUID itemID, UUID hostID,
  112. Object[] data);
  113. }
  114. }