RemoteAdmin:admin close region
From OpenSimulator
(Difference between revisions)
JeffKelley (Talk | contribs) m (→PHP: Fixed broken Google Code link, replacing with internal page) |
|||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 68: | Line 68: | ||
When an error occures the following error value are returned | When an error occures the following error value are returned | ||
| − | *region \"{REGION NAME}\" does not exist | + | * region \"{REGION NAME}\" does not exist |
| − | *region \"{REGION UUID}\" does not exist | + | * region \"{REGION UUID}\" does not exist |
== Notes == | == Notes == | ||
| − | *use admin_delete_region if you also want to remove the region from the database | + | * use admin_delete_region if you also want to remove the region from the database |
== Example == | == Example == | ||
=== PHP === | === PHP === | ||
| + | This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]]. | ||
| + | |||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
| Line 93: | Line 95: | ||
</source> | </source> | ||
| − | [[Category: | + | |
| + | |||
| + | [[Category:RemoteAdmin]] | ||
| + | [[Category:RemoteAdmin Commands]] | ||
Latest revision as of 11:38, 16 March 2021
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 |
[edit] 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,...
[edit] Parameters
[edit] Required Parameters
These parameters are required
| parameter | Description | Values |
|---|---|---|
| region_name | Name of the region, optionaly use region_id |
[edit] Optional Parameters
These parameters are optional and do not need to be set
| parameter | Description | Values |
|---|---|---|
| region_id | region uuid of the region. |
[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_name | name of region when using region_name | |
| region_id | name uuid of region when using region_id |
[edit] Error messages
When an error occures the following error value are returned
- region \"{REGION NAME}\" does not exist
- region \"{REGION UUID}\" does not exist
[edit] Notes
- use admin_delete_region if you also want to remove the region from the database
[edit] Example
[edit] 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); ?>
