OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.Framework.Interfaces.IScenePresence Interface Reference

An agent in the scene. More...

Inheritance diagram for OpenSim.Region.Framework.Interfaces.IScenePresence:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.Framework.Interfaces.IScenePresence:
Collaboration graph
[legend]

Public Member Functions

List< SceneObjectGroupGetAttachments ()
 The scene objects attached to this avatar. More...
 
List< SceneObjectGroupGetAttachments (uint attachmentPoint)
 The scene objects attached to this avatar at a specific attachment point. More...
 
bool HasAttachments ()
 Does this avatar have any attachments? More...
 
void AddAttachment (SceneObjectGroup gobj)
 
void RemoveAttachment (SceneObjectGroup gobj)
 
void ClearAttachments ()
 
- Public Member Functions inherited from OpenSim.Framework.ISceneAgent
void SendInitialDataToMe ()
 Send initial scene data to the client controlling this agent More...
 

Properties

List< string > InTransitScriptStates [get]
 Copy of the script states while the agent is in transit. This state may need to be placed back in case of transfer fail. More...
 
Object AttachmentsSyncLock [get]
 The AttachmentsModule synchronizes on this to avoid race conditions between commands to add and remove attachments. More...
 
- Properties inherited from OpenSim.Framework.ISceneAgent
IClientAPI ControllingClient [get]
 
PresenceType PresenceType [get]
 What type of presence is this? User, NPC, etc. More...
 
bool IsChildAgent [get]
 If true, then the agent has no avatar in the scene. The agent exists to relay data from a region that neighbours the current position of the user's avatar. Occasionally data is relayed, such as which a user clicks an item in a neighbouring region. More...
 
AvatarAppearance Appearance [get, set]
 Avatar appearance data. More...
 
Vector3 Lookat [get]
 
- Properties inherited from OpenSim.Framework.ISceneEntity
string Name [get, set]
 
UUID UUID [get]
 
uint LocalId [get]
 
Vector3 AbsolutePosition [get]
 

Detailed Description

An agent in the scene.

Interface is a work in progress. Please feel free to add other required properties and methods.

Definition at line 41 of file IScenePresence.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IScenePresence.AddAttachment ( SceneObjectGroup  gobj)
void OpenSim.Region.Framework.Interfaces.IScenePresence.ClearAttachments ( )
List<SceneObjectGroup> OpenSim.Region.Framework.Interfaces.IScenePresence.GetAttachments ( )

The scene objects attached to this avatar.

Returns
A copy of the list.

Do not change this list directly - use the attachments module.

Implemented in OpenSim.Region.Framework.Scenes.ScenePresence.

Here is the caller graph for this function:

List<SceneObjectGroup> OpenSim.Region.Framework.Interfaces.IScenePresence.GetAttachments ( uint  attachmentPoint)

The scene objects attached to this avatar at a specific attachment point.

Parameters
attachmentPoint
Returns

Implemented in OpenSim.Region.Framework.Scenes.ScenePresence.

bool OpenSim.Region.Framework.Interfaces.IScenePresence.HasAttachments ( )

Does this avatar have any attachments?

Returns

Implemented in OpenSim.Region.Framework.Scenes.ScenePresence.

void OpenSim.Region.Framework.Interfaces.IScenePresence.RemoveAttachment ( SceneObjectGroup  gobj)

Implemented in OpenSim.Region.Framework.Scenes.ScenePresence.

Here is the caller graph for this function:

Property Documentation

Object OpenSim.Region.Framework.Interfaces.IScenePresence.AttachmentsSyncLock
get

The AttachmentsModule synchronizes on this to avoid race conditions between commands to add and remove attachments.

All add and remove attachment operations must synchronize on this for the lifetime of their operations.

Definition at line 55 of file IScenePresence.cs.

List<string> OpenSim.Region.Framework.Interfaces.IScenePresence.InTransitScriptStates
get

Copy of the script states while the agent is in transit. This state may need to be placed back in case of transfer fail.

Definition at line 47 of file IScenePresence.cs.


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