OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Properties | List of all members
OpenSim.Framework.RegionInfo Class Reference
Collaboration diagram for OpenSim.Framework.RegionInfo:
Collaboration graph
[legend]

Public Member Functions

 RegionInfo (string description, string filename, bool skipConsoleConfig, IConfigSource configSource)
 
 RegionInfo (string description, string filename, bool skipConsoleConfig, IConfigSource configSource, string configName)
 
 RegionInfo (string description, XmlNode xmlNode, bool skipConsoleConfig, IConfigSource configSource)
 
 RegionInfo (uint legacyRegionLocX, uint legacyRegionLocY, IPEndPoint internalEndPoint, string externalUri)
 
 RegionInfo ()
 
void SetDefaultRegionSize ()
 
void SetEndPoint (string ipaddr, int port)
 
string GetSetting (string key)
 
void SetExtraSetting (string key, string value)
 
void SaveRegionToFile (string description, string filename)
 
void loadConfigurationOptionsFromMe ()
 
void loadConfigurationOptions ()
 
bool handleIncomingConfiguration (string configuration_key, object configuration_result)
 
void SaveLastMapUUID (UUID mapUUID)
 
OSDMap PackRegionInfoData ()
 
void UnpackRegionInfoData (OSDMap args)
 
int getInternalEndPointPort ()
 
Dictionary< string, object > ToKeyValuePairs ()
 

Static Public Member Functions

static RegionInfo Create (UUID regionID, string regionName, uint regX, uint regY, string externalHostName, uint httpPort, uint simPort, uint remotingPort, string serverURI)
 

Public Attributes

bool commFailTF = false
 
ConfigurationMember configMember
 
string DataStore = String.Empty
 
string RegionFile = String.Empty
 
bool isSandbox = false
 
bool Persistent = true
 
UUID originRegionID = UUID.Zero
 
string proxyUrl = ""
 
int ProxyOffset = 0
 
string regionSecret = UUID.Random().ToString()
 
string osSecret
 
UUID lastMapUUID = UUID.Zero
 
string lastMapRefresh = "0"
 
bool m_allow_alternate_ports
 
UUID RegionID = UUID.Zero
 
string RemotingAddress
 
UUID ScopeID = UUID.Zero
 
uint WorldLocX = 0
 
uint WorldLocY = 0
 
uint WorldLocZ = 0
 
uint RegionSizeX = Constants.RegionSize
 X dimension of the region. More...
 
uint RegionSizeY = Constants.RegionSize
 X dimension of the region. More...
 
uint RegionSizeZ = Constants.RegionHeight
 Z dimension of the region. More...
 

Protected Attributes

uint m_httpPort
 
string m_serverURI
 
string m_regionName = String.Empty
 
bool Allow_Alternate_Ports
 
string m_externalHostName
 
IPEndPoint m_internalEndPoint
 
uint m_remotingPort
 

Properties

EstateSettings EstateSettings [get, set]
 
RegionSettings RegionSettings [get, set]
 
RegionLightShareData WindlightSettings [get, set]
 
float NonphysPrimMin [get]
 
int NonphysPrimMax [get]
 
float PhysPrimMin [get]
 
int PhysPrimMax [get]
 
bool ClampPrimSize [get]
 
int ObjectCapacity [get]
 
int MaxPrimsPerUser [get]
 
int LinksetCapacity [get]
 
int AgentCapacity [get, set]
 
byte AccessLevel [get]
 
string RegionType [get]
 
UUID MaptileStaticUUID [get]
 
string MaptileStaticFile [get, set]
 
uint HttpPort [get, set]
 The port by which http communication occurs with the region (most noticeably, CAPS communication) More...
 
string ServerURI [get, set]
 A well-formed URI for the host region server (namely "http://" + ExternalHostName) More...
 
string RegionName [get, set]
 
uint RemotingPort [get, set]
 
IPEndPoint ExternalEndPoint [get, set]
 
string ExternalHostName [get, set]
 
IPEndPoint InternalEndPoint [get, set]
 
uint RegionLocX [get, set]
 The x co-ordinate of this region in map tiles (e.g. 1000). Coordinate is scaled as world coordinates divided by the legacy region size and is thus is the number of legacy regions. More...
 
uint RegionLocY [get, set]
 The y co-ordinate of this region in map tiles (e.g. 1000). Coordinate is scaled as world coordinates divided by the legacy region size and is thus is the number of legacy regions. More...
 
ulong RegionHandle [get]
 

Detailed Description

Definition at line 100 of file RegionInfo.cs.

Constructor & Destructor Documentation

OpenSim.Framework.RegionInfo.RegionInfo ( string  description,
string  filename,
bool  skipConsoleConfig,
IConfigSource  configSource 
)
inline

Definition at line 190 of file RegionInfo.cs.

OpenSim.Framework.RegionInfo.RegionInfo ( string  description,
string  filename,
bool  skipConsoleConfig,
IConfigSource  configSource,
string  configName 
)
inline

Definition at line 194 of file RegionInfo.cs.

OpenSim.Framework.RegionInfo.RegionInfo ( string  description,
XmlNode  xmlNode,
bool  skipConsoleConfig,
IConfigSource  configSource 
)
inline

Definition at line 247 of file RegionInfo.cs.

OpenSim.Framework.RegionInfo.RegionInfo ( uint  legacyRegionLocX,
uint  legacyRegionLocY,
IPEndPoint  internalEndPoint,
string  externalUri 
)
inline

Definition at line 258 of file RegionInfo.cs.

OpenSim.Framework.RegionInfo.RegionInfo ( )
inline

Definition at line 269 of file RegionInfo.cs.

Member Function Documentation

static RegionInfo OpenSim.Framework.RegionInfo.Create ( UUID  regionID,
string  regionName,
uint  regX,
uint  regY,
string  externalHostName,
uint  httpPort,
uint  simPort,
uint  remotingPort,
string  serverURI 
)
inlinestatic

Definition at line 1228 of file RegionInfo.cs.

Here is the caller graph for this function:

int OpenSim.Framework.RegionInfo.getInternalEndPointPort ( )
inline

Definition at line 1242 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.GetSetting ( string  key)
inline

Definition at line 526 of file RegionInfo.cs.

bool OpenSim.Framework.RegionInfo.handleIncomingConfiguration ( string  configuration_key,
object  configuration_result 
)
inline

Definition at line 1050 of file RegionInfo.cs.

void OpenSim.Framework.RegionInfo.loadConfigurationOptions ( )
inline

Definition at line 986 of file RegionInfo.cs.

void OpenSim.Framework.RegionInfo.loadConfigurationOptionsFromMe ( )
inline

Definition at line 912 of file RegionInfo.cs.

OSDMap OpenSim.Framework.RegionInfo.PackRegionInfoData ( )
inline

Definition at line 1144 of file RegionInfo.cs.

void OpenSim.Framework.RegionInfo.SaveLastMapUUID ( UUID  mapUUID)
inline

Definition at line 1138 of file RegionInfo.cs.

void OpenSim.Framework.RegionInfo.SaveRegionToFile ( string  description,
string  filename 
)
inline

Definition at line 889 of file RegionInfo.cs.

void OpenSim.Framework.RegionInfo.SetDefaultRegionSize ( )
inline

Definition at line 501 of file RegionInfo.cs.

void OpenSim.Framework.RegionInfo.SetEndPoint ( string  ipaddr,
int  port 
)
inline

Definition at line 519 of file RegionInfo.cs.

void OpenSim.Framework.RegionInfo.SetExtraSetting ( string  key,
string  value 
)
inline

Definition at line 536 of file RegionInfo.cs.

Dictionary<string, object> OpenSim.Framework.RegionInfo.ToKeyValuePairs ( )
inline

Definition at line 1247 of file RegionInfo.cs.

void OpenSim.Framework.RegionInfo.UnpackRegionInfoData ( OSDMap  args)
inline

Definition at line 1174 of file RegionInfo.cs.

Member Data Documentation

bool OpenSim.Framework.RegionInfo.Allow_Alternate_Ports
protected

Definition at line 141 of file RegionInfo.cs.

bool OpenSim.Framework.RegionInfo.commFailTF = false

Definition at line 106 of file RegionInfo.cs.

ConfigurationMember OpenSim.Framework.RegionInfo.configMember

Definition at line 107 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.DataStore = String.Empty

Definition at line 108 of file RegionInfo.cs.

bool OpenSim.Framework.RegionInfo.isSandbox = false

Definition at line 111 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.lastMapRefresh = "0"

Definition at line 126 of file RegionInfo.cs.

UUID OpenSim.Framework.RegionInfo.lastMapUUID = UUID.Zero

Definition at line 125 of file RegionInfo.cs.

bool OpenSim.Framework.RegionInfo.m_allow_alternate_ports

Definition at line 142 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.m_externalHostName
protected

Definition at line 143 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.m_httpPort
protected

Definition at line 138 of file RegionInfo.cs.

IPEndPoint OpenSim.Framework.RegionInfo.m_internalEndPoint
protected

Definition at line 144 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.m_regionName = String.Empty
protected

Definition at line 140 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.m_remotingPort
protected

Definition at line 145 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.m_serverURI
protected

Definition at line 139 of file RegionInfo.cs.

UUID OpenSim.Framework.RegionInfo.originRegionID = UUID.Zero

Definition at line 118 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.osSecret

Definition at line 123 of file RegionInfo.cs.

bool OpenSim.Framework.RegionInfo.Persistent = true

Definition at line 112 of file RegionInfo.cs.

int OpenSim.Framework.RegionInfo.ProxyOffset = 0

Definition at line 120 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.proxyUrl = ""

Definition at line 119 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.RegionFile = String.Empty

Definition at line 110 of file RegionInfo.cs.

UUID OpenSim.Framework.RegionInfo.RegionID = UUID.Zero

Definition at line 146 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.regionSecret = UUID.Random().ToString()

Definition at line 121 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.RegionSizeX = Constants.RegionSize

X dimension of the region.

If this is a varregion then the default size set here will be replaced when we load the region config.

Definition at line 161 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.RegionSizeY = Constants.RegionSize

X dimension of the region.

If this is a varregion then the default size set here will be replaced when we load the region config.

Definition at line 169 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.RegionSizeZ = Constants.RegionHeight

Z dimension of the region.

XXX: Unknown if this accounts for regions with negative Z.

Definition at line 177 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.RemotingAddress

Definition at line 147 of file RegionInfo.cs.

UUID OpenSim.Framework.RegionInfo.ScopeID = UUID.Zero

Definition at line 148 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.WorldLocX = 0

Definition at line 151 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.WorldLocY = 0

Definition at line 152 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.WorldLocZ = 0

Definition at line 153 of file RegionInfo.cs.

Property Documentation

byte OpenSim.Framework.RegionInfo.AccessLevel
get

Definition at line 362 of file RegionInfo.cs.

int OpenSim.Framework.RegionInfo.AgentCapacity
getset

Definition at line 359 of file RegionInfo.cs.

bool OpenSim.Framework.RegionInfo.ClampPrimSize
get

Definition at line 340 of file RegionInfo.cs.

EstateSettings OpenSim.Framework.RegionInfo.EstateSettings
getset

Definition at line 275 of file RegionInfo.cs.

IPEndPoint OpenSim.Framework.RegionInfo.ExternalEndPoint
getset

This accessor can throw all the exceptions that Dns.GetHostAddresses can throw.

XXX Isn't this really doing too much to be a simple getter, rather than an explict method?

Definition at line 427 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.ExternalHostName
getset

Definition at line 468 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.HttpPort
getset

The port by which http communication occurs with the region (most noticeably, CAPS communication)

Definition at line 382 of file RegionInfo.cs.

IPEndPoint OpenSim.Framework.RegionInfo.InternalEndPoint
getset

Definition at line 474 of file RegionInfo.cs.

int OpenSim.Framework.RegionInfo.LinksetCapacity
get

Definition at line 355 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.MaptileStaticFile
getset

Definition at line 376 of file RegionInfo.cs.

UUID OpenSim.Framework.RegionInfo.MaptileStaticUUID
get

Definition at line 372 of file RegionInfo.cs.

int OpenSim.Framework.RegionInfo.MaxPrimsPerUser
get

Definition at line 350 of file RegionInfo.cs.

int OpenSim.Framework.RegionInfo.NonphysPrimMax
get

Definition at line 325 of file RegionInfo.cs.

float OpenSim.Framework.RegionInfo.NonphysPrimMin
get

Definition at line 320 of file RegionInfo.cs.

int OpenSim.Framework.RegionInfo.ObjectCapacity
get

Definition at line 345 of file RegionInfo.cs.

int OpenSim.Framework.RegionInfo.PhysPrimMax
get

Definition at line 335 of file RegionInfo.cs.

float OpenSim.Framework.RegionInfo.PhysPrimMin
get

Definition at line 330 of file RegionInfo.cs.

ulong OpenSim.Framework.RegionInfo.RegionHandle
get

Definition at line 515 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.RegionLocX
getset

The x co-ordinate of this region in map tiles (e.g. 1000). Coordinate is scaled as world coordinates divided by the legacy region size and is thus is the number of legacy regions.

Definition at line 485 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.RegionLocY
getset

The y co-ordinate of this region in map tiles (e.g. 1000). Coordinate is scaled as world coordinates divided by the legacy region size and is thus is the number of legacy regions.

Definition at line 496 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.RegionName
getset

Definition at line 410 of file RegionInfo.cs.

RegionSettings OpenSim.Framework.RegionInfo.RegionSettings
getset

Definition at line 290 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.RegionType
get

Definition at line 367 of file RegionInfo.cs.

uint OpenSim.Framework.RegionInfo.RemotingPort
getset

Definition at line 416 of file RegionInfo.cs.

string OpenSim.Framework.RegionInfo.ServerURI
getset

A well-formed URI for the host region server (namely "http://" + ExternalHostName)

Definition at line 392 of file RegionInfo.cs.

RegionLightShareData OpenSim.Framework.RegionInfo.WindlightSettings
getset

Definition at line 305 of file RegionInfo.cs.


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