OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Attributes | Properties | List of all members
OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule:
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 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...
 
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...
 
UUID CreateCallingCard (UUID userID, UUID creatorID, UUID folderID)
 
IClientAPI FindClientObject (UUID agentID)
 

Protected Attributes

List< Scenem_Scenes = new List<Scene>()
 
bool m_Enabled = true
 

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 44 of file CallingCardModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.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 57 of file CallingCardModule.cs.

void OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.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 92 of file CallingCardModule.cs.

UUID OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.CreateCallingCard ( UUID  userID,
UUID  creatorID,
UUID  folderID 
)
inline

Implements OpenSim.Framework.ICallingCardModule.

Definition at line 162 of file CallingCardModule.cs.

IClientAPI OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.FindClientObject ( UUID  agentID)
inline

Definition at line 255 of file CallingCardModule.cs.

void OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.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 50 of file CallingCardModule.cs.

void OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.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 88 of file CallingCardModule.cs.

void OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.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 81 of file CallingCardModule.cs.

void OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.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 67 of file CallingCardModule.cs.

Member Data Documentation

bool OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.m_Enabled = true
protected

Definition at line 48 of file CallingCardModule.cs.

List<Scene> OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.m_Scenes = new List<Scene>()
protected

Definition at line 47 of file CallingCardModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.Name
get

Definition at line 102 of file CallingCardModule.cs.

Type OpenSim.Region.CoreModules.Avatar.Friends.CallingCardModule.ReplaceableInterface
get

Definition at line 97 of file CallingCardModule.cs.


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