OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector:
Collaboration graph
[legend]

Public Member Functions

void Initialise (IConfigSource source)
 This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...
 
void PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void AddRegion (Scene scene)
 This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...
 
void RemoveRegion (Scene scene)
 This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...
 
void RegionLoaded (Scene scene)
 This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...
 
AvatarAppearance GetAppearance (UUID userID)
 Called by the login service More...
 
bool SetAppearance (UUID userID, AvatarAppearance appearance)
 Called by everyone who can change the avatar data (so, regions) More...
 
AvatarData GetAvatar (UUID userID)
 Called by the login service More...
 
bool SetAvatar (UUID userID, AvatarData avatar)
 Called by everyone who can change the avatar data (so, regions) More...
 
bool ResetAvatar (UUID userID)
 Not sure if it's needed More...
 
bool SetItems (UUID userID, string[] names, string[] values)
 These methods raison d'etre: No need to send the entire avatar data (SetAvatar) for changing attachments More...
 
bool RemoveItems (UUID userID, string[] names)
 

Properties

Type ReplaceableInterface [get]
 
string Name [get]
 
- Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string Name [get]
 
Type ReplaceableInterface [get]
 If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...
 

Detailed Description

Definition at line 45 of file LocalAvatarServiceConnector.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.AddRegion ( Scene  scene)
inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 119 of file LocalAvatarServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.Close ( )
inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 113 of file LocalAvatarServiceConnector.cs.

AvatarAppearance OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.GetAppearance ( UUID  userID)
inline

Called by the login service

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 143 of file LocalAvatarServiceConnector.cs.

AvatarData OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.GetAvatar ( UUID  userID)
inline

Called by the login service

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 153 of file LocalAvatarServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.Initialise ( IConfigSource  source)
inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 67 of file LocalAvatarServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.PostInitialise ( )
inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 107 of file LocalAvatarServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.RegionLoaded ( Scene  scene)
inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 133 of file LocalAvatarServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.RemoveItems ( UUID  userID,
string[]  names 
)
inline
void OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.RemoveRegion ( Scene  scene)
inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 127 of file LocalAvatarServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.ResetAvatar ( UUID  userID)
inline

Not sure if it's needed

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 163 of file LocalAvatarServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.SetAppearance ( UUID  userID,
AvatarAppearance  appearance 
)
inline

Called by everyone who can change the avatar data (so, regions)

Parameters
userID
appearance
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 148 of file LocalAvatarServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.SetAvatar ( UUID  userID,
AvatarData  avatar 
)
inline

Called by everyone who can change the avatar data (so, regions)

Parameters
userID
avatar
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 158 of file LocalAvatarServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.SetItems ( UUID  userID,
string[]  names,
string[]  values 
)
inline

These methods raison d'etre: No need to send the entire avatar data (SetAvatar) for changing attachments

Parameters
userID
attach
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 168 of file LocalAvatarServiceConnector.cs.

Property Documentation

string OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.Name
get

Definition at line 63 of file LocalAvatarServiceConnector.cs.

Type OpenSim.Region.CoreModules.ServiceConnectorsOut.Avatar.LocalAvatarServicesConnector.ReplaceableInterface
get

Definition at line 58 of file LocalAvatarServiceConnector.cs.


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