OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule Class Reference

A module that holds commands for manipulating objects in the scene. More...

Inheritance diagram for OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule:
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 ()
 
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...
 

Detailed Description

A module that holds commands for manipulating objects in the scene.

Definition at line 50 of file RegionCommandsModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule.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 74 of file RegionCommandsModule.cs.

void OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule.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 69 of file RegionCommandsModule.cs.

void OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule.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 59 of file RegionCommandsModule.cs.

void OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule.PostInitialise ( )
inline

Definition at line 64 of file RegionCommandsModule.cs.

void OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule.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 117 of file RegionCommandsModule.cs.

void OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule.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 112 of file RegionCommandsModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule.Name
get

Definition at line 55 of file RegionCommandsModule.cs.

Type OpenSim.Region.CoreModules.World.Objects.Commands.RegionCommandsModule.ReplaceableInterface
get

Definition at line 57 of file RegionCommandsModule.cs.


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