IScenePresence.cs 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  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.Generic;
  29. using OpenSim.Framework;
  30. using OpenSim.Region.Framework.Scenes;
  31. namespace OpenSim.Region.Framework.Interfaces
  32. {
  33. /// <summary>
  34. /// An agent in the scene.
  35. /// </summary>
  36. /// <remarks>
  37. /// Interface is a work in progress. Please feel free to add other required properties and methods.
  38. /// </remarks>
  39. public interface IScenePresence : ISceneAgent
  40. {
  41. /// <summary>
  42. /// Copy of the script states while the agent is in transit. This state may
  43. /// need to be placed back in case of transfer fail.
  44. /// </summary>
  45. List<string> InTransitScriptStates { get; }
  46. /// <summary>
  47. /// The AttachmentsModule synchronizes on this to avoid race conditions between commands to add and remove attachments.
  48. /// </summary>
  49. /// <remarks>
  50. /// All add and remove attachment operations must synchronize on this for the lifetime of their operations.
  51. /// </remarks>
  52. Object AttachmentsSyncLock { get; }
  53. /// <summary>
  54. /// The scene objects attached to this avatar.
  55. /// </summary>
  56. /// <returns>
  57. /// A copy of the list.
  58. /// </returns>
  59. /// <remarks>
  60. /// Do not change this list directly - use the attachments module.
  61. /// </remarks>
  62. List<SceneObjectGroup> GetAttachments();
  63. /// <summary>
  64. /// The scene objects attached to this avatar at a specific attachment point.
  65. /// </summary>
  66. /// <param name="attachmentPoint"></param>
  67. /// <returns></returns>
  68. List<SceneObjectGroup> GetAttachments(uint attachmentPoint);
  69. /// <summary>
  70. /// Does this avatar have any attachments?
  71. /// </summary>
  72. /// <returns></returns>
  73. bool HasAttachments();
  74. // Don't use these methods directly. Instead, use the AttachmentsModule
  75. void AddAttachment(SceneObjectGroup gobj);
  76. void RemoveAttachment(SceneObjectGroup gobj);
  77. void ClearAttachments();
  78. }
  79. }