OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Region.Framework.Interfaces.IInventoryAccessModule Interface Reference
Inheritance diagram for OpenSim.Region.Framework.Interfaces.IInventoryAccessModule:
Inheritance graph
[legend]

Public Member Functions

UUID CapsUpdateInventoryItemAsset (IClientAPI remoteClient, UUID itemID, byte[] data)
 
bool UpdateInventoryItemAsset (UUID ownerID, InventoryItemBase item, AssetBase asset)
 
List< InventoryItemBaseCopyToInventory (DeRezAction action, UUID folderID, List< SceneObjectGroup > objectGroups, IClientAPI remoteClient, bool asAttachment)
 Copy objects to a user's inventory. More...
 
SceneObjectGroup RezObject (IClientAPI remoteClient, UUID itemID, Vector3 RayEnd, Vector3 RayStart, UUID RayTargetID, byte BypassRayCast, bool RayEndIsIntersection, bool RezSelected, bool RemoveItem, UUID fromTaskID, bool attachment)
 Rez an object into the scene from the user's inventory More...
 
SceneObjectGroup RezObject (IClientAPI remoteClient, InventoryItemBase item, UUID assetID, Vector3 RayEnd, Vector3 RayStart, UUID RayTargetID, byte BypassRayCast, bool RayEndIsIntersection, bool RezSelected, bool RemoveItem, UUID fromTaskID, bool attachment)
 Rez an object into the scene from the user's inventory More...
 
void TransferInventoryAssets (InventoryItemBase item, UUID sender, UUID receiver)
 
bool CanGetAgentInventoryItem (IClientAPI remoteClient, UUID itemID, UUID requestID)
 Does the client have sufficient permissions to retrieve the inventory item? More...
 
bool IsForeignUser (UUID userID, out string assetServerURL)
 

Detailed Description

Definition at line 38 of file IInventoryAccessModule.cs.

Member Function Documentation

bool OpenSim.Region.Framework.Interfaces.IInventoryAccessModule.CanGetAgentInventoryItem ( IClientAPI  remoteClient,
UUID  itemID,
UUID  requestID 
)

Does the client have sufficient permissions to retrieve the inventory item?

Parameters
remoteClient
itemID
requestID
Returns

Implemented in OpenSim.Region.CoreModules.Framework.InventoryAccess.BasicInventoryAccessModule.

UUID OpenSim.Region.Framework.Interfaces.IInventoryAccessModule.CapsUpdateInventoryItemAsset ( IClientAPI  remoteClient,
UUID  itemID,
byte[]  data 
)
List<InventoryItemBase> OpenSim.Region.Framework.Interfaces.IInventoryAccessModule.CopyToInventory ( DeRezAction  action,
UUID  folderID,
List< SceneObjectGroup objectGroups,
IClientAPI  remoteClient,
bool  asAttachment 
)

Copy objects to a user's inventory.

Is it left to the caller to delete them from the scene if required.

Parameters
action
folderID
objectGroups
remoteClient
asAttachmentShould be true if the object(s) are begin taken as attachments. False otherwise.
Returns
A list of the items created. If there was more than one object and objects are not being coaleseced in inventory, then the order of items is in the same order as the input objects.

Implemented in OpenSim.Region.CoreModules.Framework.InventoryAccess.BasicInventoryAccessModule.

bool OpenSim.Region.Framework.Interfaces.IInventoryAccessModule.IsForeignUser ( UUID  userID,
out string  assetServerURL 
)
SceneObjectGroup OpenSim.Region.Framework.Interfaces.IInventoryAccessModule.RezObject ( IClientAPI  remoteClient,
UUID  itemID,
Vector3  RayEnd,
Vector3  RayStart,
UUID  RayTargetID,
byte  BypassRayCast,
bool  RayEndIsIntersection,
bool  RezSelected,
bool  RemoveItem,
UUID  fromTaskID,
bool  attachment 
)

Rez an object into the scene from the user's inventory

FIXME: It would be really nice if inventory access modules didn't also actually do the work of rezzing things to the scene. The caller should be doing that, I think.

Parameters
remoteClient
itemID
RayEnd
RayStart
RayTargetID
BypassRayCast
RayEndIsIntersection
RezSelected
RemoveItem
fromTaskID
attachment
Returns
The SceneObjectGroup rezzed or null if rez was unsuccessful.

Implemented in OpenSim.Region.CoreModules.Framework.InventoryAccess.BasicInventoryAccessModule, and OpenSim.Region.CoreModules.Framework.InventoryAccess.HGInventoryAccessModule.

SceneObjectGroup OpenSim.Region.Framework.Interfaces.IInventoryAccessModule.RezObject ( IClientAPI  remoteClient,
InventoryItemBase  item,
UUID  assetID,
Vector3  RayEnd,
Vector3  RayStart,
UUID  RayTargetID,
byte  BypassRayCast,
bool  RayEndIsIntersection,
bool  RezSelected,
bool  RemoveItem,
UUID  fromTaskID,
bool  attachment 
)

Rez an object into the scene from the user's inventory

FIXME: It would be really nice if inventory access modules didn't also actually do the work of rezzing things to the scene. The caller should be doing that, I think.

Parameters
remoteClient
itemThe item from which the object asset came. Can be null, in which case pre and post rez item adjustment and checks are not performed.
assetIDThe asset id for the object to rez.
RayEnd
RayStart
RayTargetID
BypassRayCast
RayEndIsIntersection
RezSelected
RemoveItem
fromTaskID
attachment
Returns
The SceneObjectGroup rezzed or null if rez was unsuccessful.

Implemented in OpenSim.Region.CoreModules.Framework.InventoryAccess.BasicInventoryAccessModule.

void OpenSim.Region.Framework.Interfaces.IInventoryAccessModule.TransferInventoryAssets ( InventoryItemBase  item,
UUID  sender,
UUID  receiver 
)
bool OpenSim.Region.Framework.Interfaces.IInventoryAccessModule.UpdateInventoryItemAsset ( UUID  ownerID,
InventoryItemBase  item,
AssetBase  asset 
)

The documentation for this interface was generated from the following file: