IEntityInventory.cs

Go to the documentation of this file.

/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System.Collections.Generic;
using System.Collections;
using OpenMetaverse;
using OpenSim.Framework;
using OpenSim.Region.Framework.Scenes;

namespace OpenSim.Region.Framework.Interfaces
{
    public interface IEntityInventory
    {
        void ForceInventoryPersistence();

        void ResetInventoryIDs();

        void ResetObjectID();

        void ChangeInventoryOwner(UUID ownerId);

        void ChangeInventoryGroup(UUID groupID);

        int CreateScriptInstances(int startParam, bool postOnRez, string engine, int stateSource);
        
        ArrayList GetScriptErrors(UUID itemID);
        void ResumeScripts();

        void RemoveScriptInstances(bool sceneObjectBeingDeleted);

        void StopScriptInstances();

        bool CreateScriptInstance(
            TaskInventoryItem item, int startParam, bool postOnRez, string engine, int stateSource);

        bool CreateScriptInstance(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource);

        ArrayList CreateScriptInstanceEr(UUID itemId, int startParam, bool postOnRez, string engine, int stateSource);

        void RemoveScriptInstance(UUID itemId, bool sceneObjectBeingDeleted);

        void StopScriptInstance(UUID itemId);

        bool TryGetScriptInstanceRunning(UUID itemId, out bool running);

        void AddInventoryItem(TaskInventoryItem item, bool allowedDrop);

        void AddInventoryItemExclusive(TaskInventoryItem item, bool allowedDrop);

        void RestoreInventoryItems(ICollection<TaskInventoryItem> items);

        TaskInventoryItem GetInventoryItem(UUID itemId);

        List<TaskInventoryItem> GetInventoryItems();

        TaskInventoryItem GetInventoryItem(string name);

        List<TaskInventoryItem> GetInventoryItems(string name);

        List<TaskInventoryItem> GetInventoryItems(InventoryType type);

        bool GetRezReadySceneObjects(TaskInventoryItem item, out List<SceneObjectGroup> objlist, out List<Vector3> veclist, out Vector3 bbox, out float offsetHeight);

        bool UpdateInventoryItem(TaskInventoryItem item);
        bool UpdateInventoryItem(TaskInventoryItem item, bool fireScriptEvents);
        bool UpdateInventoryItem(TaskInventoryItem item, bool fireScriptEvents, bool considerChanged);

        int RemoveInventoryItem(UUID itemID);

        void RequestInventoryFile(IClientAPI client, IXfer xferManager);

        void ProcessInventoryBackup(ISimulationDataService datastore);

        uint MaskEffectivePermissions();

        void ApplyNextOwnerPermissions();

        void ApplyGodPermissions(uint perms);

        int Count { get; }

        bool ContainsScripts();

        int ScriptCount();

        int RunningScriptCount();

        List<UUID> GetInventoryList();
        
        Dictionary<UUID, string> GetScriptStates();
        Dictionary<UUID, string> GetScriptStates(bool oldIDs);
    }
}