RemoteAdmin:admin save heightmap
From OpenSimulator
(Difference between revisions)
(→Required Parameters) |
(→Optional Parameters) |
||
| Line 28: | Line 28: | ||
=== Optional Parameters === | === Optional Parameters === | ||
| − | + | These parameters are optional | |
| − | + | {| cellspacing="0" cellpadding="4" border="1" | |
| + | |- | ||
| + | ! parameter | ||
| + | ! Description | ||
| + | ! Values | ||
| + | |- | ||
| + | | ''region_id'' | ||
| + | | region uuid (or region_name) | ||
| + | | | ||
| + | |} | ||
== Returned Parameters == | == Returned Parameters == | ||
Revision as of 08:31, 17 February 2012
admin_save_heightmap remotely allows to save a hight map of the regions to file.
Contents |
Enabling admin_save_heightmap
If not all functions are enabled, use admin_save_heightmap to enable the function in the [RemoteAdmin] section
enabled_methods = admin_save_heightmap,...
Parameters
Required Parameters
These parameters are required
| parameter | Description | Values |
|---|---|---|
| region_id | region uuid | |
| filename | save height map as file name |
Optional Parameters
These parameters are optional
| parameter | Description | Values |
|---|---|---|
| region_id | region uuid (or region_name) |
Returned Parameters
Returned Parameters
These parameters are returned by Remote Admin
| parameter | Description | Values |
|---|---|---|
| success | true when successfull | true |
Error messages
When an error occures the following error value are returned
Notes
- accepted is an returned parameter, probably used prior to success
Example
PHP
<?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_save_heightmap (multiple parameters) $parameters = array('regionid' => '000000-0000-0000-0000-00000000', 'filename' => 'my_terrain.raw'); $myRemoteAdmin->SendCommand('admin_save_heightmap', $parameters); ?>
