Inheritance diagram for OpenSim.Region.Framework.Interfaces.IRegionModuleBase:

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	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...

Properties
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 36 of file IRegionModuleBase.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IRegionModuleBase.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.

Parameters

scene A Scene

void OpenSim.Region.Framework.Interfaces.IRegionModuleBase.Close ( )

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

void OpenSim.Region.Framework.Interfaces.IRegionModuleBase.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.

Parameters

source A IConfigSource

void OpenSim.Region.Framework.Interfaces.IRegionModuleBase.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.

Parameters

scene A Scene

void OpenSim.Region.Framework.Interfaces.IRegionModuleBase.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.

Parameters

scene A Scene

Property Documentation

string OpenSim.Region.Framework.Interfaces.IRegionModuleBase.Name

get

The name of the module

Definition at line 41 of file IRegionModuleBase.cs.

Type OpenSim.Region.Framework.Interfaces.IRegionModuleBase.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.

Definition at line 55 of file IRegionModuleBase.cs.

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

Region/Framework/Interfaces/IRegionModuleBase.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation