[This is preliminary documentation and is subject to change.]

The Instance type exposes the following members.

Constructors

  NameDescription
InstanceOverloaded.

Methods

  NameDescription
Address
AvatarClick
AvatarLocation
AvatarReload
AvatarSet
BotgramSend
BotmenuSend
CameraSet
CavChange
CavDelete
CavRequest
CellNext
CheckRight
CheckRightAll
CitizenAdd
CitizenAttributesByName
CitizenAttributesByNumber
CitizenChange
CitizenDelete
CitizenNext
CitizenPrevious
ConsoleMessage
DeleteAllObjects
Dispose
Used to destroy the current Instance.
Enter
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Exit
Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetBool
Gets a boolean attribute for the current instance.
GetCAVData
Reads the CavDefinition attribute and returns the XML contained as a string.
GetData
Gets a data (Array of Byte) attribute for the current instance.
GetFloat
Gets a floating point attribute for the current instance.
GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
GetInt
Gets an integer attribute for the current instance.
GetString
Gets a string attribute for the current instance.
GetType
Gets the Type of the current instance.
(Inherited from Object.)
GetV4Object<(Of <(TV4Object>)>)
HasWorldRight
HasWorldRightAll
HudClear
HudClick
HudCreate
HudDestroy
LicenseAdd
LicenseAttributes
LicenseChange
LicenseDelete
LicenseNext
LicensePrevious
Login
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
MoverLinks
MoverRiderAdd
MoverRiderChange
MoverRiderDelete
MoverSetPosition
MoverSetState
Noise
ObjectAdd
ObjectBump
ObjectChange
ObjectClick
ObjectDelete
ObjectLoad
ObjectQuery
ObjectSelect
Query
Query5x5
SayOverloaded.
ServerWorldAdd
ServerWorldChange
ServerWorldDelete
ServerWorldInstanceAdd
ServerWorldInstanceDelete
ServerWorldInstanceSet
ServerWorldList
ServerWorldSet
ServerWorldStart
ServerWorldStop
SetBool
Sets a boolean attribute for the current instance.
SetCAVData
Takes a string value representing an XML Custom Avatar defition and sets the CavDefinition attribute accordingly.
SetData
Sets a data (Array of Byte) attribute for the current instance.
SetFloat
Sets a floating point attribute for the current instance.
SetInt
Sets an integer attribute for the current instance.
SetString
Sets a string attribute for the current instance.
SetV4Object<(Of <(TV4Object>)>)
StateChange
Teleport
TerrainDeleteAll
TerrainLoadNode
TerrainNext
TerrainQuery
TerrainSet
ToolbarClick
ToString
Returns a String that represents the current Object.
(Inherited from Object.)
TrafficCount
UniverseAttributesChange
UniverseEjectionAdd
UniverseEjectionDelete
UniverseEjectionLookup
UniverseEjectionNext
UniverseEjectionPrevious
UrlClick
UrlSend
UserList
WhisperOverloaded.
WorldAttributeGet
WorldAttributesChange
WorldAttributeSet
WorldAttributesReset
WorldAttributesSend
WorldCavChange
WorldCavDelete
WorldCavRequest
WorldEject
WorldEjectionAdd
WorldEjectionDelete
WorldEjectionLookup
WorldEjectionNext
WorldEjectionPrevious
WorldInstanceGet
WorldInstanceSet
WorldList
WorldReloadRegistry

Properties

  NameDescription
Bool
Allows for the access of boolean attributes using an indexed property.
Data
Allows for the access of data (Array of Byte) attributes using an indexed property.
Float
Allows for the access of float point attributes using an indexed property.
Int
Allows for the access of integer attributes using an indexed property.
IsDisposed
Indicates that the referenced Instance has been disposed of.
Session
Returns the session associated with the instance. This will change if connection is lost to the universe and re-established.
String
Allows for the access of string attributes using an indexed property.
UserData
Stores data set by the user, associated with the instance.

Events

  NameDescription
CallbackAddress
Handles AW_CALLBACK_ADDRESS from the C SDK.
CallbackAdmin
Handles AW_CALLBACK_ADMIN from the C SDK.
CallbackAdminWorldList
Handles AW_CALLBACK_ADMIN_WORLD_LIST from the C SDK.
CallbackAdminWorldResult
Handles AW_CALLBACK_ADMIN_WORLD_RESULT from the C SDK.
CallbackAttributesResetResult
Handles AW_CALLBACK_ATTRIBUTES_RESET_RESULT from the C SDK.
CallbackAvatarLocation
Handles AW_CALLBACK_AVATAR_LOCATION from the C SDK.
CallbackBotgramResult
Handles AW_CALLBACK_BOTGRAM_RESULT from the C SDK.
CallbackBotmenuResult
Handles AW_CALLBACK_BOTMENU_RESULT from the C SDK.
CallbackCav
Handles AW_CALLBACK_CAV from the C SDK.
CallbackCavResult
Handles AW_CALLBACK_CAV_RESULT from the C SDK.
CallbackCellResult
Handles AW_CALLBACK_CELL_RESULT from the C SDK.
CallbackCitizenAttributes
Handles AW_CALLBACK_CITIZEN_ATTRIBUTES from the C SDK.
CallbackCitizenResult
Handles AW_CALLBACK_CITIZEN_RESULT from the C SDK.
CallbackCreate
Handles AW_CALLBACK_CREATE from the C SDK.
CallbackDeleteAllObjectsResult
Handles AW_CALLBACK_DELETE_ALL_OBJECTS_RESULT from the C SDK.
CallbackEnter
Handles AW_CALLBACK_ENTER from the C SDK.
CallbackHudResult
Handles AW_CALLBACK_HUD_RESULT from the C SDK.
CallbackLicenseAttributes
Handles AW_CALLBACK_LICENSE_ATTRIBUTES from the C SDK.
CallbackLicenseResult
Handles AW_CALLBACK_LICENSE_RESULT from the C SDK.
CallbackLogin
Handles AW_CALLBACK_LOGIN from the C SDK.
CallbackObjectQuery
Handles AW_CALLBACK_OBJECT_QUERY from the C SDK.
CallbackObjectResult
Handles AW_CALLBACK_OBJECT_RESULT from the C SDK.
CallbackQuery
Handles AW_CALLBACK_QUERY from the C SDK.
CallbackQueryObject
Handles AW_CALLBACK_QUERY_OBJECT from the C SDK.
CallbackReloadRegistry
Handles AW_CALLBACK_RELOAD_REGISTRY from the C SDK.
CallbackTerrainDeleteAllResult
Handles AW_CALLBACK_TERRAIN_DELETE_ALL_RESULT from the C SDK.
CallbackTerrainLoadNodeResult
Handles AW_CALLBACK_TERRAIN_LOAD_NODE_RESULT from the C SDK.
CallbackTerrainNextResult
Handles AW_CALLBACK_TERRAIN_NEXT_RESULT from the C SDK.
CallbackTerrainSetResult
Handles AW_CALLBACK_TERRAIN_SET_RESULT from the C SDK.
CallbackUniverseEjection
Handles AW_CALLBACK_UNIVERSE_EJECTION from the C SDK.
CallbackUniverseEjectionResult
Handles AW_CALLBACK_UNIVERSE_EJECTION_RESULT from the C SDK.
CallbackUserList
Handles AW_CALLBACK_USER_LIST from the C SDK.
CallbackWorldCav
Handles AW_CALLBACK_WORLD_CAV from the C SDK.
CallbackWorldCavResult
Handles AW_CALLBACK_WORLD_CAV_RESULT from the C SDK.
CallbackWorldEjection
Handles AW_CALLBACK_WORLD_EJECTION from the C SDK.
CallbackWorldEjectionResult
Handles AW_CALLBACK_WORLD_EJECTION_RESULT from the C SDK.
CallbackWorldInstance
Handles AW_CALLBACK_WORLD_INSTANCE from the C SDK.
Disposing
Indicates that the instance is in the process of being disposed.
EventAdminWorldDelete
Handles AW_EVENT_ADMIN_WORLD_DELETE from the C SDK.
EventAdminWorldInfo
Handles AW_EVENT_ADMIN_WORLD_INFO from the C SDK.
EventAvatarAdd
Handles AW_EVENT_AVATAR_ADD from the C SDK.
EventAvatarChange
Handles AW_EVENT_AVATAR_CHANGE from the C SDK.
EventAvatarClick
Handles AW_EVENT_AVATAR_CLICK from the C SDK.
EventAvatarDelete
Handles AW_EVENT_AVATAR_DELETE from the C SDK.
EventAvatarReload
Handles AW_EVENT_AVATAR_RELOAD from the C SDK.
EventBotgram
Handles AW_EVENT_BOTGRAM from the C SDK.
EventBotmenu
Handles AW_EVENT_BOTMENU from the C SDK.
EventCavDefinitionChange
Handles AW_EVENT_CAV_DEFINITION_CHANGE from the C SDK.
EventCellBegin
Handles AW_EVENT_CELL_BEGIN from the C SDK.
EventCellEnd
Handles AW_EVENT_CELL_END from the C SDK.
EventCellObject
Handles AW_EVENT_CELL_OBJECT from the C SDK.
EventChat
Handles AW_EVENT_CHAT from the C SDK.
EventConsoleMessage
Handles AW_EVENT_CONSOLE_MESSAGE from the C SDK.
EventEntityAdd
Handles AW_EVENT_ENTITY_ADD from the C SDK.
EventEntityChange
Handles AW_EVENT_ENTITY_CHANGE from the C SDK.
EventEntityDelete
Handles AW_EVENT_ENTITY_DELETE from the C SDK.
EventEntityLinks
Handles AW_EVENT_ENTITY_LINKS from the C SDK.
EventEntityRiderAdd
Handles AW_EVENT_ENTITY_RIDER_ADD from the C SDK.
EventEntityRiderChange
Handles AW_EVENT_ENTITY_RIDER_CHANGE from the C SDK.
EventEntityRiderDelete
Handles AW_EVENT_ENTITY_RIDER_DELETE from the C SDK.
EventHudClick
Handles AW_EVENT_HUD_CLICK from the C SDK.
EventNoise
Handles AW_EVENT_NOISE from the C SDK.
EventObjectAdd
Handles AW_EVENT_OBJECT_ADD from the C SDK.
EventObjectBump
Handles AW_EVENT_OBJECT_BUMP from the C SDK.
EventObjectClick
Handles AW_EVENT_OBJECT_CLICK from the C SDK.
EventObjectDelete
Handles AW_EVENT_OBJECT_DELETE from the C SDK.
EventObjectSelect
Handles AW_EVENT_OBJECT_SELECT from the C SDK.
EventTeleport
Handles AW_EVENT_TELEPORT from the C SDK.
EventTerrainBegin
Handles AW_EVENT_TERRAIN_BEGIN from the C SDK.
EventTerrainChanged
Handles AW_EVENT_TERRAIN_CHANGED from the C SDK.
EventTerrainData
Handles AW_EVENT_TERRAIN_DATA from the C SDK.
EventTerrainEnd
Handles AW_EVENT_TERRAIN_END from the C SDK.
EventToolbarClick
Handles AW_EVENT_TOOLBAR_CLICK from the C SDK.
EventUniverseAttributes
Handles AW_EVENT_UNIVERSE_ATTRIBUTES from the C SDK.
EventUniverseDisconnect
Handles AW_EVENT_UNIVERSE_DISCONNECT from the C SDK.
EventUrl
Handles AW_EVENT_URL from the C SDK.
EventUrlClick
Handles AW_EVENT_URL_CLICK from the C SDK.
EventUserInfo
Handles AW_EVENT_USER_INFO from the C SDK.
EventWorldAttributes
Handles AW_EVENT_WORLD_ATTRIBUTES from the C SDK.
EventWorldCavDefinitionChange
Handles AW_EVENT_WORLD_CAV_DEFINITION_CHANGE from the C SDK.
EventWorldDisconnect
Handles AW_EVENT_WORLD_DISCONNECT from the C SDK.
EventWorldInfo
Handles AW_EVENT_WORLD_INFO from the C SDK.

See Also