aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IEntityInventory.cs')
-rw-r--r--OpenSim/Region/Framework/Interfaces/IEntityInventory.cs54
1 files changed, 50 insertions, 4 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs b/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs
index 32f4eea..4f0e100 100644
--- a/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs
@@ -81,7 +81,12 @@ namespace OpenSim.Region.Framework.Interfaces
81 /// <summary> 81 /// <summary>
82 /// Start all the scripts contained in this entity's inventory 82 /// Start all the scripts contained in this entity's inventory
83 /// </summary> 83 /// </summary>
84 void CreateScriptInstances(int startParam, bool postOnRez, string engine, int stateSource); 84 /// <param name="startParam"></param>
85 /// <param name="postOnRez"></param>
86 /// <param name="engine"></param>
87 /// <param name="stateSource"></param>
88 /// <returns>Number of scripts started.</returns>
89 int CreateScriptInstances(int startParam, bool postOnRez, string engine, int stateSource);
85 90
86 ArrayList GetScriptErrors(UUID itemID); 91 ArrayList GetScriptErrors(UUID itemID);
87 void ResumeScripts(); 92 void ResumeScripts();
@@ -102,7 +107,11 @@ namespace OpenSim.Region.Framework.Interfaces
102 /// <param name="postOnRez"></param> 107 /// <param name="postOnRez"></param>
103 /// <param name="engine"></param> 108 /// <param name="engine"></param>
104 /// <param name="stateSource"></param> 109 /// <param name="stateSource"></param>
105 void CreateScriptInstance( 110 /// <returns>
111 /// true if the script instance was valid for starting, false otherwise. This does not guarantee
112 /// that the script was actually started, just that the script was valid (i.e. its asset data could be found, etc.)
113 /// </returns>
114 bool CreateScriptInstance(
106 TaskInventoryItem item, int startParam, bool postOnRez, string engine, int stateSource); 115 TaskInventoryItem item, int startParam, bool postOnRez, string engine, int stateSource);
107 116
108 /// <summary> 117 /// <summary>
@@ -113,7 +122,11 @@ namespace OpenSim.Region.Framework.Interfaces
113 /// <param name="postOnRez"></param> 122 /// <param name="postOnRez"></param>
114 /// <param name="engine"></param> 123 /// <param name="engine"></param>
115 /// <param name="stateSource"></param> 124 /// <param name="stateSource"></param>
116 void CreateScriptInstance(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource); 125 /// <returns>
126 /// true if the script instance was valid for starting, false otherwise. This does not guarantee
127 /// that the script was actually started, just that the script was valid (i.e. its asset data could be found, etc.)
128 /// </returns>
129 bool CreateScriptInstance(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource);
117 130
118 ArrayList CreateScriptInstanceEr(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource); 131 ArrayList CreateScriptInstanceEr(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource);
119 132
@@ -166,6 +179,19 @@ namespace OpenSim.Region.Framework.Interfaces
166 List<TaskInventoryItem> GetInventoryItems(); 179 List<TaskInventoryItem> GetInventoryItems();
167 180
168 /// <summary> 181 /// <summary>
182 /// Gets an inventory item by name
183 /// </summary>
184 /// <remarks>
185 /// This method returns the first inventory item that matches the given name. In SL this is all you need
186 /// since each item in a prim inventory must have a unique name.
187 /// </remarks>
188 /// <param name='name'></param>
189 /// <returns>
190 /// The inventory item. Null if no such item was found.
191 /// </returns>
192 TaskInventoryItem GetInventoryItem(string name);
193
194 /// <summary>
169 /// Get inventory items by name. 195 /// Get inventory items by name.
170 /// </summary> 196 /// </summary>
171 /// <param name="name"></param> 197 /// <param name="name"></param>
@@ -174,7 +200,17 @@ namespace OpenSim.Region.Framework.Interfaces
174 /// If no inventory item has that name then an empty list is returned. 200 /// If no inventory item has that name then an empty list is returned.
175 /// </returns> 201 /// </returns>
176 List<TaskInventoryItem> GetInventoryItems(string name); 202 List<TaskInventoryItem> GetInventoryItems(string name);
177 203
204 /// <summary>
205 /// Get inventory items by type.
206 /// </summary>
207 /// <param type="name"></param>
208 /// <returns>
209 /// A list of inventory items of that type.
210 /// If no inventory items of that type then an empty list is returned.
211 /// </returns>
212 List<TaskInventoryItem> GetInventoryItems(InventoryType type);
213
178 /// <summary> 214 /// <summary>
179 /// Get the scene object referenced by an inventory item. 215 /// Get the scene object referenced by an inventory item.
180 /// </summary> 216 /// </summary>
@@ -228,6 +264,16 @@ namespace OpenSim.Region.Framework.Interfaces
228 bool ContainsScripts(); 264 bool ContainsScripts();
229 265
230 /// <summary> 266 /// <summary>
267 /// Returns the count of scripts contained
268 /// </summary></returns>
269 int ScriptCount();
270
271 /// <summary>
272 /// Returns the count of running scripts contained
273 /// </summary></returns>
274 int RunningScriptCount();
275
276 /// <summary>
231 /// Get the uuids of all items in this inventory 277 /// Get the uuids of all items in this inventory
232 /// </summary> 278 /// </summary>
233 /// <returns></returns> 279 /// <returns></returns>