C# Class OpenSim.OpenSimBase

Common OpenSimulator simulator code

Inheritance: RegionApplicationBase

Show file Open project: N3X15/VoxelSim Class Usage Examples

Public Properties

Property	Type	Description
CreateAccount	ConsoleCommand
userStatsURI	string

Protected Properties

Property	Type	Description
m_applicationRegistry	IRegistryCore
m_autoCreateClientStack	bool
m_clientServers	List
m_config	OpenSimConfigSource
m_configLoader	ConfigurationLoader
m_configSettings	ConfigSettings
m_moduleLoader	ModuleLoader
m_plugins	List
proxyOffset	int
proxyUrl	string

Public Methods

Method	Description
CloseRegion ( Scene scene ) : void	Remove a region from the simulator without deleting it permanently.
CloseRegion ( string name ) : void	Remove a region from the simulator without deleting it permanently.
CreateRegion ( RegionInfo regionInfo, IScene &scene ) : IClientNetworkServer	Execute the region creation process. This includes setting up scene infrastructure.
CreateRegion ( RegionInfo regionInfo, bool portadd_flag, IScene &scene ) : IClientNetworkServer	Execute the region creation process. This includes setting up scene infrastructure.
CreateRegion ( RegionInfo regionInfo, bool portadd_flag, bool do_post_init, IScene &mscene ) : IClientNetworkServer	Execute the region creation process. This includes setting up scene infrastructure.
GetAvatarNumber ( int &usernum ) : void	Get the number of the avatars in the Region server
GetRegionNumber ( int &regionnum ) : void	Get the number of regions
GetRunTime ( string &starttime, string &uptime ) : void	Get the start time and up time of Region server
OpenSimBase ( IConfigSource configSource ) : System	Constructor.
PopulateRegionEstateInfo ( RegionInfo regInfo ) : void	Load the estate information for the provided RegionInfo object.
RemoveRegion ( Scene scene, bool cleanup ) : void
RemoveRegion ( string name, bool cleanUp ) : void
ShutdownSpecific ( ) : void	Performs any last-minute sanity checking and shuts down the region server
handleRestartRegion ( RegionInfo whichRegion ) : void

Protected Methods

Method	Description
AddPluginCommands ( ) : void
CreateClientStackManager ( ) : OpenSim.Region.ClientStack.ClientStackManager
CreateScene ( RegionInfo regionInfo, ISimulationDataService simDataService, IEstateDataService estateDataService, OpenSim.Framework.AgentCircuitManager circuitManager ) : Scene
GetHelpTopics ( ) : List
GetPhysicsScene ( string osSceneIdentifier ) : PhysicsScene
Initialize ( ) : void
LoadConfigSettings ( IConfigSource configSource ) : void
LoadPlugins ( ) : void
ReadExtraConfigSettings ( ) : void
SetupScene ( RegionInfo regionInfo, IClientNetworkServer &clientServer ) : Scene	Create a scene and its initial base structures.
SetupScene ( RegionInfo regionInfo, int proxyOffset, IConfigSource configSource, IClientNetworkServer &clientServer ) : Scene	Create a scene and its initial base structures.
ShutdownClientServer ( RegionInfo whichRegion ) : void
StartupSpecific ( ) : void	Performs startup specific to the region server, including initialization of the scene such as loading configuration from disk.

Private Methods

Method	Description
HandleCommanderCommand ( string module, string cmd ) : void
HandleCommanderHelp ( string module, string cmd ) : void
ShutdownRegion ( Scene scene ) : void

Method Details

AddPluginCommands() protected method

protected AddPluginCommands ( ) : void
return	void

CloseRegion() public method

Remove a region from the simulator without deleting it permanently.

public CloseRegion ( Scene scene ) : void
scene	OpenSim.Region.Framework.Scenes.Scene
return	void

CloseRegion() public method

Remove a region from the simulator without deleting it permanently.

public CloseRegion ( string name ) : void
name	string
return	void

CreateClientStackManager() protected method

protected CreateClientStackManager ( ) : OpenSim.Region.ClientStack.ClientStackManager
return	OpenSim.Region.ClientStack.ClientStackManager

CreateRegion() public method

Execute the region creation process. This includes setting up scene infrastructure.

public CreateRegion ( RegionInfo regionInfo, IScene &scene ) : IClientNetworkServer
regionInfo	RegionInfo
scene	IScene
return	IClientNetworkServer

CreateRegion() public method

Execute the region creation process. This includes setting up scene infrastructure.

public CreateRegion ( RegionInfo regionInfo, bool portadd_flag, IScene &scene ) : IClientNetworkServer
regionInfo	RegionInfo
portadd_flag	bool
scene	IScene
return	IClientNetworkServer

CreateRegion() public method

Execute the region creation process. This includes setting up scene infrastructure.

public CreateRegion ( RegionInfo regionInfo, bool portadd_flag, bool do_post_init, IScene &mscene ) : IClientNetworkServer
regionInfo	RegionInfo
portadd_flag	bool
do_post_init	bool
mscene	IScene
return	IClientNetworkServer

CreateScene() protected method

protected CreateScene ( RegionInfo regionInfo, ISimulationDataService simDataService, IEstateDataService estateDataService, OpenSim.Framework.AgentCircuitManager circuitManager ) : Scene
regionInfo	RegionInfo
simDataService	ISimulationDataService
estateDataService	IEstateDataService
circuitManager	OpenSim.Framework.AgentCircuitManager
return	OpenSim.Region.Framework.Scenes.Scene

GetAvatarNumber() public method

Get the number of the avatars in the Region server

public GetAvatarNumber ( int &usernum ) : void
usernum	int	The first out parameter describing the number of all the avatars in the Region server
return	void

GetHelpTopics() protected method

protected GetHelpTopics ( ) : List
return	List

GetPhysicsScene() protected method

protected GetPhysicsScene ( string osSceneIdentifier ) : PhysicsScene
osSceneIdentifier	string
return	PhysicsScene

GetRegionNumber() public method

Get the number of regions

public GetRegionNumber ( int &regionnum ) : void
regionnum	int	The first out parameter describing the number of regions
return	void

GetRunTime() public method

Get the start time and up time of Region server

public GetRunTime ( string &starttime, string &uptime ) : void
starttime	string	The first out parameter describing when the Region server started
uptime	string	The second out parameter describing how long the Region server has run
return	void

Initialize() protected method

protected Initialize ( ) : void
return	void

LoadConfigSettings() protected method

protected LoadConfigSettings ( IConfigSource configSource ) : void
configSource	IConfigSource
return	void

LoadPlugins() protected method

protected LoadPlugins ( ) : void
return	void

OpenSimBase() public method

Constructor.

public OpenSimBase ( IConfigSource configSource ) : System
configSource	IConfigSource
return	System

PopulateRegionEstateInfo() public method

Load the estate information for the provided RegionInfo object.

public PopulateRegionEstateInfo ( RegionInfo regInfo ) : void
regInfo	RegionInfo	/// A ///
return	void

ReadExtraConfigSettings() protected method

protected ReadExtraConfigSettings ( ) : void
return	void

RemoveRegion() public method

public RemoveRegion ( Scene scene, bool cleanup ) : void
scene	OpenSim.Region.Framework.Scenes.Scene
cleanup	bool
return	void

RemoveRegion() public method

public RemoveRegion ( string name, bool cleanUp ) : void
name	string
cleanUp	bool
return	void

SetupScene() protected method

Create a scene and its initial base structures.

protected SetupScene ( RegionInfo regionInfo, IClientNetworkServer &clientServer ) : Scene
regionInfo	RegionInfo
clientServer	IClientNetworkServer
return	Scene

SetupScene() protected method

Create a scene and its initial base structures.

protected SetupScene ( RegionInfo regionInfo, int proxyOffset, IConfigSource configSource, IClientNetworkServer &clientServer ) : Scene
regionInfo	RegionInfo
proxyOffset	int
configSource	IConfigSource
clientServer	IClientNetworkServer
return	Scene

ShutdownClientServer() protected method

protected ShutdownClientServer ( RegionInfo whichRegion ) : void
whichRegion	RegionInfo
return	void

ShutdownSpecific() public method

Performs any last-minute sanity checking and shuts down the region server

public ShutdownSpecific ( ) : void
return	void

StartupSpecific() protected method

Performs startup specific to the region server, including initialization of the scene such as loading configuration from disk.

protected StartupSpecific ( ) : void
return	void

handleRestartRegion() public method

public handleRestartRegion ( RegionInfo whichRegion ) : void
whichRegion	RegionInfo
return	void

Property Details

CreateAccount public property

public ConsoleCommand CreateAccount
return	ConsoleCommand

m_applicationRegistry protected property

protected IRegistryCore m_applicationRegistry
return	IRegistryCore

m_autoCreateClientStack protected property

protected bool m_autoCreateClientStack
return	bool

m_clientServers protected property

protected List m_clientServers
return	List

m_config protected property

protected OpenSimConfigSource m_config
return	OpenSimConfigSource

m_configLoader protected property

protected ConfigurationLoader m_configLoader
return	ConfigurationLoader

m_configSettings protected property

protected ConfigSettings m_configSettings
return	ConfigSettings

m_moduleLoader protected property

protected ModuleLoader m_moduleLoader
return	ModuleLoader

m_plugins protected property

protected List m_plugins
return	List

proxyOffset protected property

protected int proxyOffset
return	int

proxyUrl protected property

protected string proxyUrl
return	string

userStatsURI public property

public string userStatsURI
return	string