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

Public Member Functions

void CopyAttachments (IScenePresence sp, AgentData ad)
 Copy attachment data from a ScenePresence into the AgentData structure for transmission to another simulator More...
 
void CopyAttachments (AgentData ad, IScenePresence sp)
 Copy attachment data from an AgentData structure into a ScenePresence. More...
 
void RezAttachments (IScenePresence sp)
 RezAttachments. This should only be called upon login on the first region. Attachment rezzings on crossings and TPs are done in a different way. More...
 
void DeRezAttachments (IScenePresence sp)
 Derez the attachements for a scene presence that is closing. More...
 
void DeleteAttachmentsFromScene (IScenePresence sp, bool silent)
 Delete all the presence's attachments from the scene This is done when a root agent leaves/is demoted to child (for instance, on logout, teleport or region cross). More...
 
bool AttachObject (IScenePresence sp, SceneObjectGroup grp, uint AttachmentPt, bool silent, bool addToInventory, bool append)
 Attach an object to an avatar. More...
 
ISceneEntity RezSingleAttachmentFromInventory (IScenePresence sp, UUID itemID, uint AttachmentPt)
 Rez an attachment from user inventory and change inventory status to match. More...
 
ISceneEntity RezSingleAttachmentFromInventory (IScenePresence presence, UUID itemID, uint AttachmentPt, XmlDocument doc)
 
void RezMultipleAttachmentsFromInventory (IScenePresence sp, List< KeyValuePair< UUID, uint >> rezlist)
 Rez multiple attachments from a user's inventory More...
 
void DetachSingleAttachmentToGround (IScenePresence sp, uint objectLocalID)
 Detach the given item to the ground. More...
 
void DetachSingleAttachmentToGround (IScenePresence sp, uint objectLocalID, Vector3 absolutePos, Quaternion absoluteRot)
 Detach the given item to the ground at the specified coordinates & rotation More...
 
void DetachSingleAttachmentToInv (IScenePresence sp, SceneObjectGroup grp)
 Detach the given attachment so that it remains in the user's inventory. More...
 
void UpdateAttachmentPosition (SceneObjectGroup sog, Vector3 pos)
 

Detailed Description

Definition at line 37 of file IAttachmentsModule.cs.

Member Function Documentation

bool OpenSim.Region.Framework.Interfaces.IAttachmentsModule.AttachObject ( IScenePresence  sp,
SceneObjectGroup  grp,
uint  AttachmentPt,
bool  silent,
bool  addToInventory,
bool  append 
)

Attach an object to an avatar.

Parameters
sp
grp
AttachmentPt
silent
addToInventoryIf true then add object to user inventory
appendAppend to attachment point rather than replace.
Returns
true if the object was successfully attached, false otherwise

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.CopyAttachments ( IScenePresence  sp,
AgentData  ad 
)

Copy attachment data from a ScenePresence into the AgentData structure for transmission to another simulator

Parameters
sp
ad

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.CopyAttachments ( AgentData  ad,
IScenePresence  sp 
)

Copy attachment data from an AgentData structure into a ScenePresence.

Parameters
ad
sp

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.DeleteAttachmentsFromScene ( IScenePresence  sp,
bool  silent 
)

Delete all the presence's attachments from the scene This is done when a root agent leaves/is demoted to child (for instance, on logout, teleport or region cross).

Parameters
sp
silent

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.DeRezAttachments ( IScenePresence  sp)

Derez the attachements for a scene presence that is closing.

Attachment changes are saved.

Parameters
spThe presence closing
saveChangedSave changed attachments.
saveAllScriptedSave attachments with scripts even if they haven't changed.

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.DetachSingleAttachmentToGround ( IScenePresence  sp,
uint  objectLocalID 
)

Detach the given item to the ground.

Parameters
sp
objectLocalID

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.DetachSingleAttachmentToGround ( IScenePresence  sp,
uint  objectLocalID,
Vector3  absolutePos,
Quaternion  absoluteRot 
)

Detach the given item to the ground at the specified coordinates & rotation

Parameters
sp
objectLocalID
absolutePos
absoluteRot

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.DetachSingleAttachmentToInv ( IScenePresence  sp,
SceneObjectGroup  grp 
)

Detach the given attachment so that it remains in the user's inventory.

Parameters
sp/param>
Parameters
grpThe attachment to detach.

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.RezAttachments ( IScenePresence  sp)

RezAttachments. This should only be called upon login on the first region. Attachment rezzings on crossings and TPs are done in a different way.

This is only actually necessary for viewers which do not have a current outfit folder (these viewers make their own attachment calls on login) and agents which have attachments but no viewer (e.g. NPCs).

Parameters
sp

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.RezMultipleAttachmentsFromInventory ( IScenePresence  sp,
List< KeyValuePair< UUID, uint >>  rezlist 
)

Rez multiple attachments from a user's inventory

Parameters
sp
rezlist

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

ISceneEntity OpenSim.Region.Framework.Interfaces.IAttachmentsModule.RezSingleAttachmentFromInventory ( IScenePresence  sp,
UUID  itemID,
uint  AttachmentPt 
)

Rez an attachment from user inventory and change inventory status to match.

Parameters
sp
itemID
AttachmentPt
Returns
The scene object that was attached. Null if the scene object could not be found

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.

ISceneEntity OpenSim.Region.Framework.Interfaces.IAttachmentsModule.RezSingleAttachmentFromInventory ( IScenePresence  presence,
UUID  itemID,
uint  AttachmentPt,
XmlDocument  doc 
)
void OpenSim.Region.Framework.Interfaces.IAttachmentsModule.UpdateAttachmentPosition ( SceneObjectGroup  sog,
Vector3  pos 
)

Update the position of an attachment.

Parameters
sog
pos

Implemented in OpenSim.Region.CoreModules.Avatar.Attachments.AttachmentsModule.


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