RemoteAdmin:admin close region
From OpenSimulator
(Difference between revisions)
m (Robot: Cosmetic changes) |
(→PHP) |
||
| Line 78: | Line 78: | ||
== Example == | == Example == | ||
=== PHP === | === PHP === | ||
| + | This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here]. | ||
| + | |||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
Revision as of 16:00, 7 November 2013
admin_close_region remotely allows to close regions. No changes are done to the database. The region will be shutdown and removed from the map.
Contents |
Enabling admin_close_region
If not all functions are enabled, use admin_delete_region to enable the function in the [RemoteAdmin] section
enabled_methods = admin_close_region,...
Parameters
Required Parameters
These parameters are required
| parameter | Description | Values |
|---|---|---|
| region_name | Name of the region, optionaly use region_id |
Optional Parameters
These parameters are optional and do not need to be set
| parameter | Description | Values |
|---|---|---|
| region_id | region uuid of the region. |
Returned Parameters
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_name | name of region when using region_name | |
| region_id | name uuid of region when using region_id |
Error messages
When an error occures the following error value are returned
- region \"{REGION NAME}\" does not exist
- region \"{REGION UUID}\" does not exist
Notes
- use admin_delete_region if you also want to remove the region from the database
Example
PHP
This example needs the RemoteAdmin PHP Class file available here.
<?php // Including the RemoteAdmin PHP class. include('RemoteAdmin.php'); // Instantiate the class with parameters identical to the Python example above $myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret'); // Invoke admin_create_user (multiple parameters) $parameters = array('region_name' => 'My Plaza'); $myRemoteAdmin->SendCommand('admin_close_region', $parameters); ?>
