RemoteAdmin:admin delete region

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 79: Line 79:
[[Category:RemoteAdmin Commands]]

Latest revision as of 15:26, 24 October 2015

admin_delete_region remotely allows to delete regions. All region data in the database will be removed. The region will be shutdown and removed from the map.


[edit] Enabling admin_delete_region

If not all functions are enabled, use admin_delete_region to enable the function in the [RemoteAdmin] section

enabled_methods = admin_delete_region,...

[edit] Parameters

[edit] Required Parameters

These parameters are required

parameter Description Values
region_name Name of the new region

[edit] Optional Parameters

There are no optional parameters for this function

[edit] Returned Parameters

[edit] Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
success true when successfull true, false
error error message when not successfull
region_id uuid of the region

[edit] Error messages

When an error occures the following error value are returned

  • region \"{REGION NAME}\" does not exist

[edit] Notes

  • If you just want to shutdown a region without removing the region from the database, use admin_close_region

[edit] Example

[edit] PHP

This example needs the RemoteAdmin PHP Class file available here.

// Including the RemoteAdmin PHP class.
// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('', 9000, 'secret');
// Invoke admin_create_user (multiple parameters)
$parameters = array('region_name' => 'My Plaza');
$myRemoteAdmin->SendCommand('admin_delete_region', $parameters);
Personal tools
About This Wiki