OpenMetaverse Protocol Library Developers API Documentation
Settings Class
NamespacesOpenMetaverseSettings
Class for controlling various system settings.
Declaration Syntax
C#
public 
class 
Settings
Members
All Members Constructors Properties Fields



Icon Member Description
Settings(GridClient)
Constructor

ADITI_LOGIN_SERVER
Beta grid login server

AGNI_LOGIN_SERVER
Main grid login server

ALWAYS_DECODE_OBJECTS
If true, all object update packets will be decoded in to native objects. If false, only updates for our own agent will be decoded. Registering an event handler will force objects for that type to always be decoded. If this is disabled the object tracking will have missing or partial prim and avatar information

ALWAYS_REQUEST_OBJECTS
If true, when a cached object check is received from the server the full object info will automatically be requested

ALWAYS_REQUEST_PARCEL_ACL
If true, an incoming parcel properties reply will automatically send a request for the parcel access list

ALWAYS_REQUEST_PARCEL_DWELL
if true, an incoming parcel properties reply will automatically send a request for the traffic count.

ASSET_CACHE_DIR
Path to store cached texture data

ASSET_CACHE_MAX_SIZE
Maximum size cached files are allowed to take on disk (bytes)

AVATAR_TRACKING
If true, currently visible avatars will be stored in dictionaries inside
  Copy imageCopy
Simulator.ObjectAvatars
. If false, a new Avatar or Primitive object will be created each time an object update packet is received

BIND_ADDR
IP Address the client will bind to

CACHE_PRIMITIVES
Primitives will be reused when falling in/out of interest list (and shared between clients) prims returning to interest list do not need re-requested Helps also in not re-requesting prim.Properties for code that checks for a Properties == null per client

CAPS_TIMEOUT
Number of milliseconds before a CAPS call will time out

CLIENT_IDENTIFICATION_TAG
UUID of a texture used by some viewers to indentify type of client used

DEFAULT_AGENT_UPDATE_INTERVAL
Number of milliseconds between sending camera updates

DEFAULT_EFFECT_COLOR
Default color used for viewer particle effects

DISABLE_AGENT_UPDATE_DUPLICATE_CHECK
If true, and
  Copy imageCopy
SEND_AGENT_UPDATES
is true, AgentUpdate packets will continuously be sent out to give the bot smoother movement and autopiloting

ENABLE_CAPS
Whether to establish connections to HTTP capabilities servers for simulators

ENABLE_INVENTORY_STORE
InventoryManager requests inventory information on login, GridClient initializes an Inventory store for main inventory.

ENABLE_LIBRARY_STORE
InventoryManager requests library information on login, GridClient initializes an Inventory store for the library.

ENABLE_SIMSTATS
Whether to decode sim stats

FETCH_MISSING_INVENTORY
If true, any reference received for a folder or item the library is not aware of will automatically be fetched

HTTP_INVENTORY
Use Caps for fetching inventory where available

INTERPOLATION_INTERVAL
Number of milliseconds between updating the current positions of moving, non-accelerating and non-colliding objects

LOG_ALL_CAPS_ERRORS
The capabilities servers are currently designed to periodically return a 502 error which signals for the client to re-establish a connection. Set this to true to log those 502 errors

LOG_DISKCACHE
Log disk cache misses and other info

LOG_LEVEL
Get or set the minimum log level to output to the console by default If the library is not compiled with DEBUG defined and this level is set to DEBUG You will get no output on the console. This behavior can be overriden by creating a logger configuration file for log4net

LOG_NAMES
Attach avatar names to log messages

LOG_RESENDS
Log packet retransmission info

LOGIN_SERVER
Login server to connect to

LOGIN_TIMEOUT
Number of milliseconds for xml-rpc to timeout

LOGOUT_TIMEOUT
Number of milliseconds before NetworkManager.Logout() will time out

MAP_REQUEST_TIMEOUT
Milliseconds to wait for a simulator info request through the grid interface

MAX_CONCURRENT_TEXTURE_DOWNLOADS
The maximum number of concurrent texture downloads allowed

MAX_HTTP_CONNECTIONS
Maximum number of HTTP connections to open to a particular endpoint.

MAX_PACKET_SIZE
Maximum size of packet that we want to send over the wire

MAX_PENDING_ACKS
Maximum number of queued ACKs to be sent before SendAcks() is forced

MAX_RESEND_COUNT
Maximum number of times to resend a failed packet

MAX_SEQUENCE
The maximum value of a packet sequence number before it rolls over back to one

MULTIPLE_SIMS
Should we connect to multiple sims? This will allow viewing in to neighboring simulators and sim crossings (Experimental)

NETWORK_TICK_INTERVAL
Millisecond interval between ticks, where all ACKs are sent out and the age of unACKed packets is checked

OBJECT_TRACKING
If true, currently visible avatars will be stored in dictionaries inside
  Copy imageCopy
Simulator.ObjectPrimitives
. If false, a new Avatar or Primitive object will be created each time an object update packet is received

PACKET_ARCHIVE_SIZE
The maximum size of the sequence number archive, used to check for resent and/or duplicate packets

PACKET_INBOX_SIZE
The initial size of the packet inbox, where packets are stored before processing

PARCEL_TRACKING
If true, parcel details will be stored in the
  Copy imageCopy
Simulator.Parcels
dictionary as they are received

PING_INTERVAL
Number of milliseconds between sending pings to each sim

PIPELINE_REFRESH_INTERVAL
The Refresh timer inteval is used to set the delay between checks for stalled texture downloads

PIPELINE_REQUEST_TIMEOUT
Textures taking longer than this value will be flagged as timed out and removed from the pipeline

POOL_PARCEL_DATA
Pool parcel data between clients (saves on requesting multiple times when all clients may need it)

RESEND_TIMEOUT
Milliseconds before a packet is assumed lost and resent

RESOURCE_DIR
The relative directory where external resources are kept

SEND_AGENT_APPEARANCE
Enable/disable automatically setting agent appearance at login and after sim crossing

SEND_AGENT_THROTTLE
Enable/disable automatically setting the bandwidth throttle after connecting to each simulator

SEND_AGENT_UPDATES
Enable/disable sending periodic camera updates

SEND_PINGS
Enable/disable the sending of pings to monitor lag and packet loss

SIMULATOR_POOL_TIMEOUT
How long to preserve cached data when no client is connected to a simulator The reason for setting it to something like 2 minutes is in case a client is running back and forth between region edges or a sim is comming and going

SIMULATOR_TIMEOUT
Milliseconds without receiving a packet before the connection to a simulator is assumed lost

SORT_INVENTORY
STATS_QUEUE_SIZE
Network stats queue length (seconds)

STORE_LAND_PATCHES
Enable/disable storing terrain heightmaps in the TerrainManager

TELEPORT_TIMEOUT
Number of milliseconds before a teleport attempt will time out

THROTTLE_OUTGOING_PACKETS
Throttle outgoing packet rate

TRACK_UTILIZATION
If true, utilization statistics will be tracked. There is a minor penalty in CPU time for enabling this option.

TRANSFER_TIMEOUT
Number of milliseconds before an asset transfer will time out

UPLOAD_COST
Cost of uploading an asset

USE_ASSET_CACHE
If true, images, and other assets downloaded from the server will be cached in a local directory

USE_HTTP_TEXTURES
Download textures using GetTexture capability when available

USE_INTERPOLATION_TIMER
If true, position and velocity will periodically be interpolated (extrapolated, technically) for objects and avatars that are being tracked by the library. This is necessary to increase the accuracy of speed and position estimates for simulated objects

USE_LLSD_LOGIN
Use XML-RPC Login or LLSD Login, default is XML-RPC Login

Remarks
Some values are readonly because they affect things that happen when the GridClient object is initialized, so changing them at runtime won't do any good. Non-readonly values may affect things that happen at login or dynamically
Inheritance Hierarchy
Object
Settings

Assembly: OpenMetaverse(Module: OpenMetaverse.dll) Version: 0.9.3.3318 (0.9.3.3318)