IEntityInventory.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  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.Collections.Generic;
  28. using System.Collections;
  29. using OpenMetaverse;
  30. using OpenSim.Framework;
  31. using OpenSim.Region.Framework.Scenes;
  32. namespace OpenSim.Region.Framework.Interfaces
  33. {
  34. /// <summary>
  35. /// Interface to an entity's (SceneObjectPart's) inventory
  36. /// </summary>
  37. ///
  38. /// This is not a finished 1.0 candidate interface
  39. public interface IEntityInventory
  40. {
  41. /// <summary>
  42. /// Force the task inventory of this prim to persist at the next update sweep
  43. /// </summary>
  44. void ForceInventoryPersistence();
  45. /// <summary>
  46. /// Reset UUIDs for all the items in the prim's inventory.
  47. /// </summary>
  48. ///
  49. /// This involves either generating
  50. /// new ones or setting existing UUIDs to the correct parent UUIDs.
  51. ///
  52. /// If this method is called and there are inventory items, then we regard the inventory as having changed.
  53. ///
  54. /// <param name="linkNum">Link number for the part</param>
  55. void ResetInventoryIDs();
  56. /// <summary>
  57. /// Reset parent object UUID for all the items in the prim's inventory.
  58. /// </summary>
  59. ///
  60. /// If this method is called and there are inventory items, then we regard the inventory as having changed.
  61. ///
  62. /// <param name="linkNum">Link number for the part</param>
  63. void ResetObjectID();
  64. /// <summary>
  65. /// Change every item in this inventory to a new owner.
  66. /// </summary>
  67. /// <param name="ownerId"></param>
  68. void ChangeInventoryOwner(UUID ownerId);
  69. /// <summary>
  70. /// Change every item in this inventory to a new group.
  71. /// </summary>
  72. /// <param name="groupID"></param>
  73. void ChangeInventoryGroup(UUID groupID);
  74. /// <summary>
  75. /// Start all the scripts contained in this entity's inventory
  76. /// </summary>
  77. /// <param name="startParam"></param>
  78. /// <param name="postOnRez"></param>
  79. /// <param name="engine"></param>
  80. /// <param name="stateSource"></param>
  81. /// <returns>Number of scripts started.</returns>
  82. int CreateScriptInstances(int startParam, bool postOnRez, string engine, int stateSource);
  83. ArrayList GetScriptErrors(UUID itemID);
  84. void ResumeScripts();
  85. /// <summary>
  86. /// Stop and remove all the scripts in this entity from the scene.
  87. /// </summary>
  88. /// <param name="sceneObjectBeingDeleted">
  89. /// Should be true if these scripts are being removed because the scene
  90. /// object is being deleted. This will prevent spurious updates to the client.
  91. /// </param>
  92. void RemoveScriptInstances(bool sceneObjectBeingDeleted);
  93. /// <summary>
  94. /// Stop all the scripts in this entity.
  95. /// </summary>
  96. void StopScriptInstances();
  97. /// <summary>
  98. /// Start a script which is in this entity's inventory.
  99. /// </summary>
  100. /// <param name="item"></param>
  101. /// <param name="postOnRez"></param>
  102. /// <param name="engine"></param>
  103. /// <param name="stateSource"></param>
  104. /// <returns>
  105. /// true if the script instance was valid for starting, false otherwise. This does not guarantee
  106. /// that the script was actually started, just that the script was valid (i.e. its asset data could be found, etc.)
  107. /// </returns>
  108. bool CreateScriptInstance(
  109. TaskInventoryItem item, int startParam, bool postOnRez, string engine, int stateSource);
  110. /// <summary>
  111. /// Start a script which is in this entity's inventory.
  112. /// </summary>
  113. /// <param name="itemId"></param>
  114. /// <param name="startParam"></param>
  115. /// <param name="postOnRez"></param>
  116. /// <param name="engine"></param>
  117. /// <param name="stateSource"></param>
  118. /// <returns>
  119. /// true if the script instance was valid for starting, false otherwise. This does not guarantee
  120. /// that the script was actually started, just that the script was valid (i.e. its asset data could be found, etc.)
  121. /// </returns>
  122. bool CreateScriptInstance(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource);
  123. /// <summary>
  124. /// Stop and remove a script which is in this prim's inventory from the scene.
  125. /// </summary>
  126. /// <param name="itemId"></param>
  127. /// <param name="sceneObjectBeingDeleted">
  128. /// Should be true if these scripts are being removed because the scene
  129. /// object is being deleted. This will prevent spurious updates to the client.
  130. /// </param>
  131. void RemoveScriptInstance(UUID itemId, bool sceneObjectBeingDeleted);
  132. /// <summary>
  133. /// Stop a script which is in this prim's inventory.
  134. /// </summary>
  135. /// <param name="itemId"></param>
  136. void StopScriptInstance(UUID itemId);
  137. /// <summary>
  138. /// Try to get the script running status.
  139. /// </summary>
  140. /// <returns>
  141. /// Returns true if a script for the item was found in one of the simulator's script engines. In this case,
  142. /// the running parameter will reflect the running status.
  143. /// Returns false if the item could not be found, if the item is not a script or if a script instance for the
  144. /// item was not found in any of the script engines. In this case, running status is irrelevant.
  145. /// </returns>
  146. /// <param name='itemId'></param>
  147. /// <param name='running'></param>
  148. bool TryGetScriptInstanceRunning(UUID itemId, out bool running);
  149. /// <summary>
  150. /// Add an item to this entity's inventory. If an item with the same name already exists, then an alternative
  151. /// name is chosen.
  152. /// </summary>
  153. /// <param name="item"></param>
  154. void AddInventoryItem(TaskInventoryItem item, bool allowedDrop);
  155. /// <summary>
  156. /// Add an item to this entity's inventory. If an item with the same name already exists, it is replaced.
  157. /// </summary>
  158. /// <param name="item"></param>
  159. void AddInventoryItemExclusive(TaskInventoryItem item, bool allowedDrop);
  160. /// <summary>
  161. /// Restore a whole collection of items to the entity's inventory at once.
  162. /// We assume that the items already have all their fields correctly filled out.
  163. /// The items are not flagged for persistence to the database, since they are being restored
  164. /// from persistence rather than being newly added.
  165. /// </summary>
  166. /// <param name="items"></param>
  167. void RestoreInventoryItems(ICollection<TaskInventoryItem> items);
  168. /// <summary>
  169. /// Returns an existing inventory item. Returns the original, so any changes will be live.
  170. /// </summary>
  171. /// <param name="itemID"></param>
  172. /// <returns>null if the item does not exist</returns>
  173. TaskInventoryItem GetInventoryItem(UUID itemId);
  174. /// <summary>
  175. /// Get all inventory items.
  176. /// </summary>
  177. /// <param name="name"></param>
  178. /// <returns>
  179. /// If there are no inventory items then an empty list is returned.
  180. /// </returns>
  181. List<TaskInventoryItem> GetInventoryItems();
  182. /// <summary>
  183. /// Gets an inventory item by name
  184. /// </summary>
  185. /// <remarks>
  186. /// This method returns the first inventory item that matches the given name. In SL this is all you need
  187. /// since each item in a prim inventory must have a unique name.
  188. /// </remarks>
  189. /// <param name='name'></param>
  190. /// <returns>
  191. /// The inventory item. Null if no such item was found.
  192. /// </returns>
  193. TaskInventoryItem GetInventoryItem(string name);
  194. /// <summary>
  195. /// Get inventory items by name.
  196. /// </summary>
  197. /// <param name="name"></param>
  198. /// <returns>
  199. /// A list of inventory items with that name.
  200. /// If no inventory item has that name then an empty list is returned.
  201. /// </returns>
  202. List<TaskInventoryItem> GetInventoryItems(string name);
  203. /// <summary>
  204. /// Get inventory items by type.
  205. /// </summary>
  206. /// <param type="name"></param>
  207. /// <returns>
  208. /// A list of inventory items of that type.
  209. /// If no inventory items of that type then an empty list is returned.
  210. /// </returns>
  211. List<TaskInventoryItem> GetInventoryItems(InventoryType type);
  212. /// <summary>
  213. /// Get the scene object(s) referenced by an inventory item.
  214. /// </summary>
  215. ///
  216. /// This is returned in a 'rez ready' state. That is, name, description, permissions and other details have
  217. /// been adjusted to reflect the part and item from which it originates.
  218. ///
  219. /// <param name="item">Inventory item</param>
  220. /// <param name="objlist">The scene objects</param>
  221. /// <param name="veclist">Relative offsets for each object</param>
  222. /// <returns>true = success, false = the scene object asset couldn't be found</returns>
  223. bool GetRezReadySceneObjects(TaskInventoryItem item, out List<SceneObjectGroup> objlist, out List<Vector3> veclist);
  224. /// <summary>
  225. /// Update an existing inventory item.
  226. /// </summary>
  227. /// <param name="item">The updated item. An item with the same id must already exist
  228. /// in this prim's inventory.</param>
  229. /// <returns>false if the item did not exist, true if the update occurred successfully</returns>
  230. bool UpdateInventoryItem(TaskInventoryItem item);
  231. bool UpdateInventoryItem(TaskInventoryItem item, bool fireScriptEvents);
  232. bool UpdateInventoryItem(TaskInventoryItem item, bool fireScriptEvents, bool considerChanged);
  233. /// <summary>
  234. /// Remove an item from this entity's inventory
  235. /// </summary>
  236. /// <param name="itemID"></param>
  237. /// <returns>Numeric asset type of the item removed. Returns -1 if the item did not exist
  238. /// in this prim's inventory.</returns>
  239. int RemoveInventoryItem(UUID itemID);
  240. /// <summary>
  241. /// Serialize all the metadata for the items in this prim's inventory ready for sending to the client
  242. /// </summary>
  243. /// <param name="xferManager"></param>
  244. void RequestInventoryFile(IClientAPI client, IXfer xferManager);
  245. /// <summary>
  246. /// Backup the inventory to the given data store
  247. /// </summary>
  248. /// <param name="datastore"></param>
  249. void ProcessInventoryBackup(ISimulationDataService datastore);
  250. uint MaskEffectivePermissions();
  251. void ApplyNextOwnerPermissions();
  252. void ApplyGodPermissions(uint perms);
  253. /// <summary>
  254. /// Number of items in this inventory.
  255. /// </summary>
  256. int Count { get; }
  257. /// <summary>
  258. /// Returns true if this inventory contains any scripts
  259. /// </summary></returns>
  260. bool ContainsScripts();
  261. /// <summary>
  262. /// Number of scripts in this inventory.
  263. /// </summary>
  264. /// <remarks>
  265. /// Includes both running and non running scripts.
  266. /// </remarks>
  267. int ScriptCount();
  268. /// <summary>
  269. /// Number of running scripts in this inventory.
  270. /// </summary></returns>
  271. int RunningScriptCount();
  272. /// <summary>
  273. /// Get the uuids of all items in this inventory
  274. /// </summary>
  275. /// <returns></returns>
  276. List<UUID> GetInventoryList();
  277. /// <summary>
  278. /// Get the xml representing the saved states of scripts in this inventory.
  279. /// </summary>
  280. /// <returns>
  281. /// A <see cref="Dictionary`2"/>
  282. /// </returns>
  283. Dictionary<UUID, string> GetScriptStates();
  284. }
  285. }