libsecondlife API Developers Documentation
libsecondlife Namespace
Namespaceslibsecondlife
This is the root namespace for the libsecondlife library.
Declaration Syntax
C#Visual BasicVisual C++
namespace libsecondlife
Namespace libsecondlife
namespace libsecondlife
Types
All TypesClassesStructuresEnumerationsDelegates
IconTypeDescription
ParcelManager..::.AccessDeniedReason
Reasons agent is denied access to a parcel on the simulator

ParcelManager..::.AccessList
Flags used in the ParcelAccessListRequest packet to specify whether we want the access list (whitelist), ban list (blacklist), or both

AgentManager..::.AgentMovement..::.AgentCamera
Camera controls for the agent, mostly a thin wrapper around CoordinateFrame. This class is only responsible for state tracking and math, it does not send any packets

AgentManager..::.AgentDataCallback
Reply to an AgentData request

AgentManager..::.AgentFlags
Currently only used to hide your group title

AgentManager
Manager class for our own avatar

AgentManager..::.AgentMovement
Agent movement and camera control Agent movement is controlled by setting specific ControlFlags After the control flags are set, An AgentUpdate is required to update the simulator of the specified flags This is most easily accomplished by setting one or more of the AgentMovement properties Movement of an avatar is always based on a compass direction, for example AtPos will move the agent from West to East or forward on the X Axis, AtNeg will of course move agent from East to West or backward on the X Axis, LeftPos will be South to North or forward on the Y Axis The Z axis is Up, finer grained control of movements can be done using the Nudge properties

AgentManager..::.AgentMovementCallback
DirectoryManager..::.AgentSearchData
An Avatar returned from the dataserver

AgentManager..::.AgentState
Action state of the avatar, which can currently be typing and editing

AgentThrottle
Throttles the network traffic for various different traffic types. Access this class through SecondLife.Throttle

AppearanceManager..::.AgentWearablesCallback

AgentManager..::.AlertMessage
Fired when alert message received from simulator

Animations
Static pre-defined animations available to all agents

AgentManager..::.AnimationsChangedCallback
Triggered when the current agent animations change

AppearanceManager
Manager class to for agents appearance, both body parts and clothing

AppearanceManager..::.AppearanceUpdatedCallback

Asset
AssetBodypart
AssetClothing
AssetDownload

AssetManager

AssetNotecard
AssetPrim
AssetManager..::.AssetReceivedCallback

AssetScriptBinary
AssetScriptText
AssetSound
AssetTexture
AssetType
The different types of assets in Second Life

AssetUpload

AssetManager..::.AssetUploadedCallback

AssetWearable
SoundManager..::.AttachedSoundGainChangeCallback
AttachmentPoint
Attachment points for objects on avatar bodies

SoundManager..::.AttachSoundCallback
Avatar
Represents an avatar in Second Life (other than your own)

AvatarManager..::.AvatarAppearanceCallback
Triggered when AvatarAppearance is received

AvatarGroup
Holds group information for Avatars such as those you might find in a profile

AvatarManager..::.AvatarGroupsCallback
Triggered when an avatar group list is received (AvatarGroupsReply)

AvatarManager..::.AvatarInterestsCallback
Triggered when a response for avatar interests is returned

AvatarManager
Retrieve friend status notifications, and retrieve avatar names and profiles

AvatarManager..::.AvatarNamesCallback
Triggered when a UUIDNameReply is received

AvatarManager..::.AvatarNameSearchCallback
Triggered when a name search reply is received (AvatarPickerReply)

AvatarManager..::.AvatarPicksCallback
Callback returning a dictionary of avatar's picks

Avatar..::.AvatarProperties
Avatar properties including about text, profile URL, image IDs and publishing settings

AvatarManager..::.AvatarPropertiesCallback
Triggered when avatar properties are received (AvatarPropertiesReply)

ObjectManager..::.AvatarSitChanged
Called whenever the client avatar sits down or stands up

AgentManager..::.AvatarSitResponseCallback
Fired in response to a RequestSit()

AppearanceManager..::.BakeType

AgentManager..::.BalanceCallback
Triggered when the L$ account balance for this avatar changes

BitPack
Wrapper around a byte array that allows bit to be packed and unpacked one at a time or by a variable amount. Useful for very tightly packed data like LayerData packets

Bumpiness
The type of bump-mapping applied to a face

AgentManager..::.CameraConstraintCallback
Fired when camera tries to view beyond its view limits

Caps
Capabilities is the name of the bi-directional HTTP REST protocol that Second Life uses to communicate transactions such as teleporting or group messaging

CapsEventDictionary
Registers, unregisters, and fires events generated by the Capabilities event queue

ChannelType

ChatAudibleLevel

AgentManager..::.ChatCallback
Triggered on incoming chat messages

ChatSourceType
Identifies the source of a chat message

ChatType
Conversion type to denote Chat Packet types in an easier-to-understand format

DirectoryManager..::.Classified
A classified ad in Second Life

DirectoryManager..::.ClassifiedCategories
The different categories a classified ad can be placed in

DirectoryManager..::.ClassifiedReplyCallback

NameValue..::.ClassType

ClickAction
Action associated with clicking on an object

GridManager..::.CoarseLocationUpdateCallback

CompressedFlags
Bitflag field for ObjectUpdateCompressed data blocks, describing which options are present for each object

NetworkManager..::.ConnectedCallback
Assigned by the OnConnected event. Raised when login was a success

AgentManager..::.ControlFlags
Used to specify movement actions for your agent

CoordinateFrame
RegistrationApi..::.CreateUserParam
see https://secure-web6.secondlife.com/developers/third_party_reg/#service_create_user or https://wiki.secondlife.com/wiki/RegAPIDoc for description

GroupManager..::.CurrentGroupsCallback
Callback for the list of groups the avatar is currently a member of

NetworkManager..::.CurrentSimChangedCallback
Triggered when CurrentSim changes

DeRezDestination
Possible destinations for DeRezObject request

DirectoryManager
Access to the Linden dataserver which allows searching for land, events, people, etc

DirectoryManager..::.DirectoryParcel
A parcel retrieved from the dataserver such as results from the "For-Sale" listings

DirectoryManager..::.DirFindFlags

DirectoryManager..::.DirGroupsReplyCallback

DirectoryManager..::.DirLandReplyCallback

DirectoryManager..::.DirPeopleReplyCallback

NetworkManager..::.DisconnectedCallback
Triggered when we are logged out of the grid due to a simulator request, client request, network timeout, or any other cause

NetworkManager..::.DisconnectType
Explains why a simulator or the grid disconnected from us

AvatarManager..::.EffectCallback

EffectType
Effect type used in ViewerEffect packets

EstateTools..::.EstateAccessDelta
Used by EstateOwnerMessage packets

EstateTools..::.EstateAccessReplyDelta
EstateTools..::.EstateBansReply
EstateTools..::.EstateCovenantReply
EstateTools..::.EstateGroupsReply
EstateTools..::.EstateManagersListReply
EstateTools..::.EstateManagersReply
Triggered when the list of estate managers is received for the current estate

EstateTools..::.EstateTask
Describes tasks returned in LandStatReply

EstateTools
Estate level administration and utilities

EstateTools..::.EstateUpdateInfoReply
FIXME - Enumerate all params from EstateOwnerMessage packet

EstateTools..::.EstateUsersReply
DirectoryManager..::.EventCategories
DirectoryManager..::.EventFlags
DirectoryManager..::.EventInfo
an Event returned from the dataserver

DirectoryManager..::.EventInfoCallback

Caps..::.EventQueueCallback
Triggered when an event is received via the EventQueueGet capability

NetworkManager..::.EventQueueRunningCallback
Triggered when an event queue makes the initial connection

DirectoryManager..::.EventReplyCallback

DirectoryManager..::.EventsSearchData
Response to "Events" search

Primitive..::.ExtraParamType
Extra parameters for primitives, these flags are for features that have been added after the original ObjectFlags that has all eight bits reserved already

Primitive..::.FaceType

FieldType

InventoryManager..::.FindObjectByPathCallback

Primitive..::.FlexibleData
Information on the flexible properties of a primitive

InventoryManager..::.FolderUpdatedCallback
Callback for an inventory folder updating

ParcelManager..::.ForceSelectObjects
Fired in response to SelectParcelObjects

FriendsManager..::.FriendFoundEvent
Triggered in response to a FindFriend request

FriendInfo
This class holds information about an avatar in the friends list. There are two ways to interface to this class. The first is through the set of boolean properties. This is the typical way clients of this class will use it. The second interface is through two bitmap properties. While the bitmap interface is public, it is intended for use the libsecondlife framework.

FriendsManager..::.FriendOfflineEvent
Triggered when an avatar in your friends list goes offline

FriendsManager..::.FriendOnlineEvent
Triggered when an avatar in your friends list comes online

FriendRights

FriendsManager..::.FriendRightsEvent
Triggered in response to a call to the FriendRights() method, or when a friend changes your rights

FriendsManager..::.FriendshipOfferedEvent
Triggered when someone offers you friendship

FriendsManager..::.FriendshipResponseEvent
Trigger when your friendship offer has been accepted or declined

FriendsManager..::.FriendshipTerminatedEvent
Trigger when someone terminates your friendship.

FriendsManager
This class is used to add and remove avatars from your friends list and to manage their permission.

EstateTools..::.GetTopCollidersReply
Triggered on LandStatReply when the report type is for "top colliders"

EstateTools..::.GetTopScriptsReply
Triggered on LandStatReply when the report type is for "top scripts"

Grass
Grass foliage types

GridAgentLocation
GridItem
GridManager..::.GridItemsCallback

GridItemType

GridLayer
Visual chunk of the grid map

GridManager..::.GridLayerCallback

GridLayerType

GridManager
Manages grid-wide tasks such as the world map

GridRegion
Information about a region on the grid map

GridManager..::.GridRegionCallback

EstateTools..::.GroundTextureRegion
Used by GroundTextureSettings

EstateTools..::.GroundTextureSettings
Ground texture settings for each corner of the region

Group
Represents a group in Second Life

GroupAccountDetails

GroupManager..::.GroupAccountDetailsCallback

GroupAccountSummary

GroupManager..::.GroupAccountSummaryCallback

GroupAccountTransactions

GroupManager..::.GroupAccountTransactionsCallback

AgentManager..::.GroupChatJoined
Fired when group chat session confirmed joined

AgentManager..::.GroupChatLeft
Fired when agent group chat session terminated

GroupManager..::.GroupCreatedCallback

AgentManager..::.GroupDroppedCallback
Informs the avatar that it is no longer a member of a group

GroupManager..::.GroupDroppedCallback

TerrainManager..::.GroupHeader
GroupManager..::.GroupJoinedCallback

GroupManager..::.GroupLeftCallback

GroupManager
Handles all network traffic related to reading and writing group information

GroupMember
Avatar group management

GroupManager..::.GroupMembersCallback
Callback for the member list of a group

GroupManager..::.GroupNamesCallback
Callback for a list of group names

GroupNotice
Struct representing a group notice

GroupPowers
GroupProfile
Profile of a group

GroupManager..::.GroupProfileCallback
Callback for the profile of a group

GroupProposal
GroupRole
Role manager for a group

GroupRolePowers
Group role powers flags

GroupManager..::.GroupRolesCallback
Callback for the role list of a group

GroupManager..::.GroupRolesMembersCallback
Callback for a pairing of roles to members

GroupRoleUpdate
Role update flags

DirectoryManager..::.GroupSearchData
Response to a "Groups" Search

GroupTitle
Class to represent Group Title

GroupManager..::.GroupTitlesCallback
Callback for the title list of a group

Helpers
Static helper functions and global variables

LLObject..::.HoleType
ImageDownload

AssetManager..::.ImageReceivedCallback

AssetManager..::.ImageReceiveProgressCallback

ImageRequest
ImageType

NetworkManager..::.IncomingPacket
Holds a simulator reference and a packet, these structs are put in the packet inbox for decoding

InstantMessage
Instant Message

AgentManager..::.InstantMessageCallback
Triggered on incoming instant messages

InstantMessageDialog
Special commands used in Instant Messages

InstantMessageOnline
Flag in Instant Messages, whether the IM should be delivered to offline avatars as well

Avatar..::.Interests
Avatar interests including spoken languages, skills, and "want to" choices

InternalDictionary<(Of <(TKey, TValue>)>)
The InternalDictionary class is used through the library for storing key/value pairs. It is intended to be a replacement for the generic Dictionary class and should be used in its place. It contains several methods for allowing access to the data from outside the library that are read only and thread safe.

InvalidOutfitException
Inventory
Responsible for maintaining inventory structure. Inventory constructs nodes and manages node children as is necessary to maintain a coherant hirarchy. Other classes should not manipulate or create InventoryNodes explicitly. When A node's parent changes (when a folder is moved, for example) simply pass Inventory the updated InventoryFolder and it will make the appropriate changes to its internal representation.

InventoryAnimation
InventoryAnimation Class, A bvh encoded object which animates an avatar

InventoryAttachment
InventoryAttachment Class, contains details on an attachable object

InventoryBase
Base Class for Inventory Items

InventoryCallingCard
InventoryCallingCard Class, contains information on another avatar

InventoryCategory
InventoryCategory Class

InventoryException
Exception class to identify inventory exceptions

InventoryFolder
A folder contains InventoryItems and has certain attributes specific to itself

InventoryGesture
InventoryGesture Class, details on a series of animations, sounds, and actions

InventoryItem
An Item in Inventory

InventoryLandmark
InventoryLandmark Class, contains details on a specific location

InventoryLSL
InventoryLSL Class, represents a Linden Scripting Language object

InventoryManager
Tools for dealing with agents inventory

InventoryNode
InventoryNodeDictionary
InventoryNotecard
InventoryNotecard Class, contains details on an encoded text document

InventoryObject
InventoryObject Class contains details on a primitive or coalesced set of primitives

Inventory..::.InventoryObjectAdded
Delegate to use for the OnInventoryObjectUpdated event.

Inventory..::.InventoryObjectRemoved
Delegate to use for the OnInventoryObjectRemoved event.

Inventory..::.InventoryObjectUpdated
Delegate to use for the OnInventoryObjectUpdated event.

InventoryManager..::.InventorySearch
InventorySnapshot
InventorySnapshot Class, an image taken with the viewer

InventorySortOrder
InventorySound
InventorySound Class representing a playable sound

InventoryTexture
InventoryTexture Class representing a graphical image

InventoryType
Inventory Item Types, eg Script, Notecard, Folder, etc

InventoryWearable
InventoryWearable Class, details on a clothing item or body part

InventoryManager..::.ItemCopiedCallback

InventoryManager..::.ItemCreatedCallback
Callback for inventory item creation finishing

InventoryManager..::.ItemCreatedFromAssetCallback
Callback for an inventory item being create from an uploaded asset

InventoryManager..::.ItemReceivedCallback

AgentManager..::.JoinGroupCallback
Reply to a request to join a group, informs whether it was successful or not

Primitive..::.JointType

ObjectManager..::.KillObjectCallback

TerrainManager..::.LandPatchCallback

EstateTools..::.LandStatReportType
Used in the ReportType field of a LandStatRequest

RegistrationApi..::.LastName
TerrainManager..::.LayerType
AgentManager..::.LeaveGroupCallback
Reply to a request to leave a group, informs whether it was successful or not

Primitive..::.LightData
Information on the light properties of a primitive

LLColor
An 8-bit color structure including an alpha channel

LLMatrix3
A 3x3 matrix

LLObject
Base class for primitives and avatars

LLQuaternion
A quaternion, used for rotations

LLUUID
A 128-bit Universally Unique Identifier, used throughout the Second Life networking protocol

LLVector2
A two-dimensional vector with floating-point values

LLVector3
A three-dimensional vector with floating-point values

LLVector3d
A double-precision three-dimensional vector

LLVector4
A four-dimensional vector

AgentManager..::.LoadURLCallback
Triggered when a script displays a URL via llLoadURL

Logger..::.LogCallback
Callback used for client apps to receive log messages from libsecondlife

Logger
Singleton logging class for libsecondlife

NetworkManager..::.LoginCallback

LoginParams

NetworkManager..::.LoginResponseCallback

LoginResponseData
LoginStatus

Helpers..::.LogLevel
Passed to SecondLife.Log() to identify the severity of a log entry

NetworkManager..::.LogoutCallback
Assigned by the OnLogoutReply callback. Raised upone receipt of a LogoutReply packet during logout process.

AvatarManager..::.LookAtCallback

LookAtType
The action an avatar is doing when looking at something, used in ViewerEffect packets for the LookAt effect

MapBlock

MapField

MapPacket

MappingType
The texture mapping style used for a face

LLObject..::.MaterialType
Material type for a primitive

AgentManager..::.MeanCollisionCallback
Triggered when an object or avatar forcefully collides with our agent

MeanCollisionType

AgentManager..::.MoneyBalanceReplyCallback
Triggered on Money Balance Reply

MoneyTransactionType
Money transaction types

NameValue
A Name Value pair with additional settings, used in the protocol primarily to transmit avatar names and active group in object packets

NetworkManager
NetworkManager is responsible for managing the network layer of libsecondlife. It tracks all the server connections, serializes outgoing traffic and deserializes incoming traffic, and provides instances of delegates for network-related events.

ObjectManager..::.NewAttachmentCallback

ObjectManager..::.NewAvatarCallback

ObjectManager..::.NewFoliageCallback

ObjectManager..::.NewPrimCallback

NotConnectedException
This exception is thrown whenever a network operation is attempted without a network connection.

InventoryManager..::.NotecardUploadedAssetCallback

LLObject..::.ObjectData

LLObject..::.ObjectFlags
Primary parameters for primitives such as Physics Enabled or Phantom

ObjectManager
Handles all network traffic related to prims and avatar positions and movement.

InventoryManager..::.ObjectOfferedCallback
Callback for when an inventory item is offered to us by another avatar or an object

ObjectPoolBase<(Of <(T>)>)
LLObject..::.ObjectProperties

ObjectManager..::.ObjectPropertiesCallback

LLObject..::.ObjectPropertiesFamily

ObjectManager..::.ObjectPropertiesFamilyCallback

ParcelManager..::.ObjectReturnType
Type of return to use when returning objects from a parcel

ObjectType
Each inventory AssetType will have its own set of flags, these are the known flags for AssetType=Object

ObjectUpdate
Contains the variables sent in an object update packet for objects. Used to track position and movement of prims and avatars

ObjectManager..::.ObjectUpdatedCallback
Called whenever an object disappears

PacketBufferPool
NetworkManager..::.PacketCallback
Coupled with RegisterCallback(), this is triggered whenever a packet of a registered type is received

PacketEventDictionary
Registers, unregisters, and fires events generated by incoming packets

PacketFrequency

Parcel
Parcel of land, a portion of virtual real estate in a simulator

ParcelManager..::.ParcelAccessEntry
Parcel Accesslist

ParcelManager..::.ParcelAccessFlags
Blacklist/Whitelist flags used in parcels Access List

ParcelManager..::.ParcelAccessListReplyCallback

Parcel..::.ParcelCategory
Category parcel is listed in under search

ParcelManager..::.ParcelDwellCallback

Parcel..::.ParcelFlags
Various parcel properties

ParcelInfo
Some information about a parcel of land returned from a DirectoryManager search

ParcelManager..::.ParcelInfoCallback

ParcelManager
Parcel (subdivided simulator lots) subsystem

ParcelManager..::.ParcelObjectOwnersListReplyCallback
Responses to a request for prim owners on a parcel

ParcelManager..::.ParcelPrimOwners
Owners of primitives on parcel

ParcelManager..::.ParcelPropertiesCallback

ParcelManager..::.ParcelResult
The result of a request for parcel properties

Parcel..::.ParcelStatus
Parcel ownership status

Primitive..::.ParticleSystem..::.ParticleDataFlags
Particle Data Flags

Primitive..::.ParticleSystem..::.ParticleFlags
Particle Flags Enum

Primitive..::.ParticleSystem
Complete structure for the particle system

TerrainManager..::.Patch
TerrainManager..::.PatchHeader
LLObject..::.PathCurve
PCode
Identifier code for object types

AppearanceManager..::.PendingAssetDownload
PermissionMask

Permissions

PermissionWho

AvatarManager..::.PickInfoCallback
Callback returning a details of a specifick pick

DirectoryManager..::.PlacesReplyCallback

DirectoryManager..::.PlacesSearchData
Response to a "Places" Search Note: This is not DirPlacesReply

Helpers..::.Platform
Operating system enumeration

AvatarManager..::.PointAtCallback

PointAtType
The action an avatar is doing when pointing at something, used in ViewerEffect packets for the PointAt effect

SoundManager..::.PreloadSoundCallback
Primitive
Particle system specific enumerators, flags and methods.

LLObject..::.PrimType
LLObject..::.ProfileCurve
Avatar..::.ProfileFlags
Avatar profile flags

ProfilePick
Holds group information on an individual profile pick

ProtocolManager

AgentManager..::.RegionCrossedCallback
Triggered when the agent physically moves in to a neighboring region

Simulator..::.RegionFlags
Simulator (region) properties

RegistrationApi
LLObject..::.ObjectPropertiesFamily..::.RequestFlagsType

SaleType
Item Sale Status

AgentManager..::.ScriptControlCallback
Fired when a script wants to give or release controls.

ScriptControlChange
Flags sent when a script takes or releases a control

AgentManager..::.ScriptDialogCallback
Triggered when a script pops up a dialog box

ScriptPermission
Permission request flags, asked when a script wants to control an Avatar

AgentManager..::.ScriptQuestionCallback
Triggered when a script asks for permissions

AgentManager..::.ScriptSensorReplyCallback
Fired when script sensor reply is received

AgentManager..::.ScriptSensorTypeFlags
Primitive..::.SculptData
Information on the sculpt properties of a sculpted primitive

Primitive..::.SculptType

DirectoryManager..::.SearchTypeFlags
Land types to search dataserver for

SecondLife
Main class to expose Second Life functionality to clients. All of the classes needed for sending and receiving data are accessible through this class.

NameValue..::.SendtoType

ParcelManager..::.SequenceStatus
Simulator sent Sequence IDs for ParcelPropertiesReply packets (sent when avatar tries to cross parcel border)

Settings
Class for controlling various system settings.

Shininess
The level of shininess applied to a face

Simulator..::.SimAccess

NetworkManager..::.SimConnectedCallback
Triggered when a new connection to a simulator is established

NetworkManager..::.SimConnectingCallback
Triggered before a new connection to a simulator is established

NetworkManager..::.SimDisconnectedCallback
Triggered when a simulator other than the simulator that is currently being occupied disconnects for whatever reason

ParcelManager..::.SimParcelsDownloaded
Fired when all parcels are downloaded from simulator

Simulator..::.SimStats
Simulator Statistics

Simulator

SoundManager
SoundManager..::.SoundTriggerCallback
Primitive..::.ParticleSystem..::.SourcePattern
Particle source pattern

SourceType

Avatar..::.Statistics
Positive and negative ratings

StatusCode

TargetType

InventoryManager..::.TaskInventoryReplyCallback
Reply received after calling
RequestTaskInventory
, contains a filename that can be used in an asset download request

InventoryManager..::.TaskItemReceivedCallback
Callback when an inventory object is accepted and received from a task inventory. This is the callback in which you actually get the ItemID, as in ObjectOfferedCallback it is null when received from a task.

AgentManager..::.TeleportCallback
Triggered for any status updates of a teleport (progress, failed, succeeded)

AgentManager..::.TeleportFlags

AgentManager..::.TeleportLureFlags

AgentManager..::.TeleportStatus
Current teleport status

ParcelManager..::.TerraformAction
ParcelManager..::.TerraformBrushSize
TerrainManager
Primitive..::.TextureAnimation
Controls the texture animation of a particular prim

Primitive..::.TextureAnimMode

TextureAttributes
Flags in the TextureEntry block that describe which properties are set

TextureCache
Class that handles the local image cache

LLObject..::.TextureEntry
Represents all of the texturable faces for an object

LLObject..::.TextureEntryFace
A single textured face. Don't instantiate this class yourself, use the methods in TextureEntry

AppearanceManager..::.TextureIndex

Transaction
A single transaction made by a group

TransactionFlags

Transfer

Tree
Tree foliage types

UDPBase

UDPPacketBuffer
UpdateType
Specific Flags for MultipleObjectUpdate requests

AssetManager..::.UploadProgressCallback

NameValue..::.ValueType
Type of the value

VisualParam
A single visual characteristic of an avatar mesh, such as eyebrow height

VisualParams
Holds the Params array of all the avatar appearance parameters

Vote
A group Vote

AppearanceManager..::.WearableData
WearableType

WrappedObject<(Of <(T>)>)
XferDownload
AssetManager..::.XferReceivedCallback