[This is preliminary documentation and is subject to change.]
Estate level administration and utilities
Namespace:
OpenMetaverseAssembly: OpenMetaverse (in OpenMetaverse.dll) Version: 1.0.0.20057
Syntax
| C# | Visual Basic | Visual C++ |
public class EstateTools
Public Class EstateTools
public ref class EstateTools
Members
| All Members | Constructors  | Fields  | Methods | Events  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| EstateTools(GridClient) |
Constructor for EstateTools class
|
| AddAllowedGroup(UUID, Boolean) |
Add's a group to the estate Allowed list |
| AddAllowedUser(UUID, Boolean) |
Add's an agent to the estate Allowed list |
| AddEstateManager(UUID, Boolean) |
Add estate manager |
| BanUser(UUID, Boolean) |
Ban an avatar from an estate |
| CancelRestart()()() |
Cancels a region restart
|
| EstateMessage(String) |
Send a message dialog to everyone in an entire estate
|
| EstateOwnerMessage(String, List<(Of <(String>)>)) |
Used for setting and retrieving various estate panel settings
|
| EstateOwnerMessage(String, String) | |
| GroundTextureLimits | Upper/lower texture boundaries for each corner of the sim |
| GroundTextures | Textures for each of the four terrain height levels |
| KickUser(UUID) |
Kick an avatar from an estate
|
| LandStatRequest(Int32, EstateTools..::.LandStatReportType, UInt32, String) |
Requests estate information such as top scripts and colliders
|
| OnGetAllowedGroups | Returned, along with other info, upon a successful .GetInfo() |
| OnGetAllowedUsers | Returned, along with other info, upon a successful .GetInfo() |
| OnGetCovenant | Triggered upon a successful .RequestCovenant() |
| OnGetEstateBans | Returned, along with other info, upon a successful .GetInfo() |
| OnGetEstateManagers | Returned, along with other info, upon a successful .GetInfo() |
| OnGetEstateUpdateInfo | Returned, along with other info, upon a successful .GetInfo() |
| OnGetTopColliders | Triggered upon a successful .GetTopColliders() |
| OnGetTopScripts | Triggered upon a successful .GetTopScripts() |
| RemoveAllowedGroup(UUID, Boolean) |
Removes a group from the estate Allowed list |
| RemoveAllowedUser(UUID, Boolean) |
Removes an agent from the estate Allowed list |
| RemoveEstateManager(UUID, Boolean) |
Remove estate manager |
| RequestCovenant()()() | Requests the estate covenant |
| RequestInfo()()() | Requests estate settings, including estate manager and access/ban lists |
| RequestTopColliders()()() | Requests the "Top Colliders" list for the current region |
| RequestTopScripts()()() | Requests the "Top Scripts" list for the current region |
| RestartRegion()()() |
Begin the region restart process
|
| SetRegionDebug(Boolean, Boolean, Boolean) | Estate panel "Debug" tab settings |
| SetRegionInfo(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Single, Single, Boolean) | Estate panel "Region" tab settings |
| SetRegionTerrain(UUID, UUID, UUID, UUID) | Used for setting the region's terrain textures for its four height levels |
| SetRegionTerrainHeights(Single, Single, Single, Single, Single, Single, Single, Single) | Used for setting sim terrain texture heights |
| SetTerrainVariables(Single, Single, Single, Boolean, Boolean, Single) |
Set several estate specific configuration variables
|
| SimulatorMessage(String) |
Send a message dialog to everyone in a simulator
|
| SimWideReturn(UUID, EstateTools..::.EstateReturnFlags, Boolean) |
Request return of objects owned by specified avatar
|
| TeleportHomeAllUsers()()() |
Teleports all users home in current Estate
|
| TeleportHomeUser(UUID) |
Send an avatar back to their home location
|
| UnbanUser(UUID, Boolean) | Unban an avatar from an estate |
| UploadTerrain(array<Byte>[]()[], String) |
Upload a terrain RAW file
|
