|
OpenSim
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
|
OpenSim
|
Simplest possible example of a non-shared region module. More...
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] |
 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... | |
Simplest possible example of a non-shared region module.
This module is the simplest possible example of a non-shared region module (a module where each scene/region in the simulator has its own copy). If anybody wants to create a more complex example in the future then please create a separate class.
This module is not active by default. If you want to see it in action, then just uncomment the line below starting with [Extension(Path...
When the module is enabled it will print messages when it receives certain events to the screen and the log file.
Definition at line 59 of file BareBonesNonSharedModule.cs.
|
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.
| scene | A Scene |
Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.
Definition at line 77 of file BareBonesNonSharedModule.cs.
|
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 72 of file BareBonesNonSharedModule.cs.
|
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.
| source | A IConfigSource |
Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.
Definition at line 67 of file BareBonesNonSharedModule.cs.
|
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.
| scene | A Scene |
Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.
Definition at line 87 of file BareBonesNonSharedModule.cs.
|
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.
| scene | A Scene |
Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.
Definition at line 82 of file BareBonesNonSharedModule.cs.
|
get |
Definition at line 63 of file BareBonesNonSharedModule.cs.
|
get |
Definition at line 65 of file BareBonesNonSharedModule.cs.
1.8.6