diff options
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IEntityInventory.cs')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IEntityInventory.cs | 69 |
1 files changed, 63 insertions, 6 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs b/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs index 32f4eea..4274cbe 100644 --- a/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs +++ b/OpenSim/Region/Framework/Interfaces/IEntityInventory.cs | |||
@@ -81,13 +81,18 @@ 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(); |
88 | 93 | ||
89 | /// <summary> | 94 | /// <summary> |
90 | /// Stop all the scripts in this entity. | 95 | /// Stop and remove all the scripts in this entity from the scene. |
91 | /// </summary> | 96 | /// </summary> |
92 | /// <param name="sceneObjectBeingDeleted"> | 97 | /// <param name="sceneObjectBeingDeleted"> |
93 | /// Should be true if these scripts are being removed because the scene | 98 | /// Should be true if these scripts are being removed because the scene |
@@ -96,13 +101,22 @@ namespace OpenSim.Region.Framework.Interfaces | |||
96 | void RemoveScriptInstances(bool sceneObjectBeingDeleted); | 101 | void RemoveScriptInstances(bool sceneObjectBeingDeleted); |
97 | 102 | ||
98 | /// <summary> | 103 | /// <summary> |
104 | /// Stop all the scripts in this entity. | ||
105 | /// </summary> | ||
106 | void StopScriptInstances(); | ||
107 | |||
108 | /// <summary> | ||
99 | /// Start a script which is in this entity's inventory. | 109 | /// Start a script which is in this entity's inventory. |
100 | /// </summary> | 110 | /// </summary> |
101 | /// <param name="item"></param> | 111 | /// <param name="item"></param> |
102 | /// <param name="postOnRez"></param> | 112 | /// <param name="postOnRez"></param> |
103 | /// <param name="engine"></param> | 113 | /// <param name="engine"></param> |
104 | /// <param name="stateSource"></param> | 114 | /// <param name="stateSource"></param> |
105 | void CreateScriptInstance( | 115 | /// <returns> |
116 | /// true if the script instance was valid for starting, false otherwise. This does not guarantee | ||
117 | /// that the script was actually started, just that the script was valid (i.e. its asset data could be found, etc.) | ||
118 | /// </returns> | ||
119 | bool CreateScriptInstance( | ||
106 | TaskInventoryItem item, int startParam, bool postOnRez, string engine, int stateSource); | 120 | TaskInventoryItem item, int startParam, bool postOnRez, string engine, int stateSource); |
107 | 121 | ||
108 | /// <summary> | 122 | /// <summary> |
@@ -113,12 +127,16 @@ namespace OpenSim.Region.Framework.Interfaces | |||
113 | /// <param name="postOnRez"></param> | 127 | /// <param name="postOnRez"></param> |
114 | /// <param name="engine"></param> | 128 | /// <param name="engine"></param> |
115 | /// <param name="stateSource"></param> | 129 | /// <param name="stateSource"></param> |
116 | void CreateScriptInstance(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource); | 130 | /// <returns> |
131 | /// true if the script instance was valid for starting, false otherwise. This does not guarantee | ||
132 | /// that the script was actually started, just that the script was valid (i.e. its asset data could be found, etc.) | ||
133 | /// </returns> | ||
134 | bool CreateScriptInstance(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource); | ||
117 | 135 | ||
118 | ArrayList CreateScriptInstanceEr(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource); | 136 | ArrayList CreateScriptInstanceEr(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource); |
119 | 137 | ||
120 | /// <summary> | 138 | /// <summary> |
121 | /// Stop a script which is in this prim's inventory. | 139 | /// Stop and remove a script which is in this prim's inventory from the scene. |
122 | /// </summary> | 140 | /// </summary> |
123 | /// <param name="itemId"></param> | 141 | /// <param name="itemId"></param> |
124 | /// <param name="sceneObjectBeingDeleted"> | 142 | /// <param name="sceneObjectBeingDeleted"> |
@@ -128,6 +146,12 @@ namespace OpenSim.Region.Framework.Interfaces | |||
128 | void RemoveScriptInstance(UUID itemId, bool sceneObjectBeingDeleted); | 146 | void RemoveScriptInstance(UUID itemId, bool sceneObjectBeingDeleted); |
129 | 147 | ||
130 | /// <summary> | 148 | /// <summary> |
149 | /// Stop a script which is in this prim's inventory. | ||
150 | /// </summary> | ||
151 | /// <param name="itemId"></param> | ||
152 | void StopScriptInstance(UUID itemId); | ||
153 | |||
154 | /// <summary> | ||
131 | /// Add an item to this entity's inventory. If an item with the same name already exists, then an alternative | 155 | /// Add an item to this entity's inventory. If an item with the same name already exists, then an alternative |
132 | /// name is chosen. | 156 | /// name is chosen. |
133 | /// </summary> | 157 | /// </summary> |
@@ -166,6 +190,19 @@ namespace OpenSim.Region.Framework.Interfaces | |||
166 | List<TaskInventoryItem> GetInventoryItems(); | 190 | List<TaskInventoryItem> GetInventoryItems(); |
167 | 191 | ||
168 | /// <summary> | 192 | /// <summary> |
193 | /// Gets an inventory item by name | ||
194 | /// </summary> | ||
195 | /// <remarks> | ||
196 | /// This method returns the first inventory item that matches the given name. In SL this is all you need | ||
197 | /// since each item in a prim inventory must have a unique name. | ||
198 | /// </remarks> | ||
199 | /// <param name='name'></param> | ||
200 | /// <returns> | ||
201 | /// The inventory item. Null if no such item was found. | ||
202 | /// </returns> | ||
203 | TaskInventoryItem GetInventoryItem(string name); | ||
204 | |||
205 | /// <summary> | ||
169 | /// Get inventory items by name. | 206 | /// Get inventory items by name. |
170 | /// </summary> | 207 | /// </summary> |
171 | /// <param name="name"></param> | 208 | /// <param name="name"></param> |
@@ -174,7 +211,17 @@ namespace OpenSim.Region.Framework.Interfaces | |||
174 | /// If no inventory item has that name then an empty list is returned. | 211 | /// If no inventory item has that name then an empty list is returned. |
175 | /// </returns> | 212 | /// </returns> |
176 | List<TaskInventoryItem> GetInventoryItems(string name); | 213 | List<TaskInventoryItem> GetInventoryItems(string name); |
177 | 214 | ||
215 | /// <summary> | ||
216 | /// Get inventory items by type. | ||
217 | /// </summary> | ||
218 | /// <param type="name"></param> | ||
219 | /// <returns> | ||
220 | /// A list of inventory items of that type. | ||
221 | /// If no inventory items of that type then an empty list is returned. | ||
222 | /// </returns> | ||
223 | List<TaskInventoryItem> GetInventoryItems(InventoryType type); | ||
224 | |||
178 | /// <summary> | 225 | /// <summary> |
179 | /// Get the scene object referenced by an inventory item. | 226 | /// Get the scene object referenced by an inventory item. |
180 | /// </summary> | 227 | /// </summary> |
@@ -228,6 +275,16 @@ namespace OpenSim.Region.Framework.Interfaces | |||
228 | bool ContainsScripts(); | 275 | bool ContainsScripts(); |
229 | 276 | ||
230 | /// <summary> | 277 | /// <summary> |
278 | /// Returns the count of scripts contained | ||
279 | /// </summary></returns> | ||
280 | int ScriptCount(); | ||
281 | |||
282 | /// <summary> | ||
283 | /// Returns the count of running scripts contained | ||
284 | /// </summary></returns> | ||
285 | int RunningScriptCount(); | ||
286 | |||
287 | /// <summary> | ||
231 | /// Get the uuids of all items in this inventory | 288 | /// Get the uuids of all items in this inventory |
232 | /// </summary> | 289 | /// </summary> |
233 | /// <returns></returns> | 290 | /// <returns></returns> |