RemoteAdmin:admin save heightmap

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Optional Parameters)
(5 intermediate revisions by 4 users not shown)
Line 18: Line 18:
 
! Values
 
! Values
 
|-
 
|-
| ''region_id''
+
| ''region_name''
| region uuid
+
| Name of the region, optionaly use ''region_id''
 
|
 
|
 
|-
 
|-
Line 36: Line 36:
 
|-
 
|-
 
| ''region_id''
 
| ''region_id''
| region uuid (or region_name)
+
| region uuid of the region.
 
|
 
|
 
|}
 
|}
Line 54: Line 54:
 
| true
 
| true
 
|}
 
|}
 
 
=== Error messages ===
 
When an error occures the following error value are returned
 
 
*
 
 
  
 
== Notes ==
 
== Notes ==
*''accepted'' is an returned parameter, probably used prior to ''success''
+
* ''accepted'' is an returned parameter, probably used prior to ''success''
  
 
== 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
Line 77: Line 72:
  
 
// Invoke admin_save_heightmap (multiple parameters)
 
// Invoke admin_save_heightmap (multiple parameters)
$parameters = array('regionid' => '000000-0000-0000-0000-00000000', 'filename' => 'my_terrain.raw');
+
$parameters = array('region_id' => '000000-0000-0000-0000-00000000', 'filename' => 'my_terrain.raw');
 
$myRemoteAdmin->SendCommand('admin_save_heightmap', $parameters);
 
$myRemoteAdmin->SendCommand('admin_save_heightmap', $parameters);
 
?>
 
?>
 
</source>
 
</source>
  
[[RemoteAdmin]]
+
 
[[RemoteAdmin:Commands]]
+
 
 +
[[Category:RemoteAdmin]]
 +
[[Category:RemoteAdmin Commands]]

Revision as of 18:39, 23 August 2017

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_name Name of the region, optionaly use region_id
filename save height map as file name

Optional Parameters

These parameters are optional

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

Notes

  • accepted is an returned parameter, probably used prior to success

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_save_heightmap (multiple parameters)
$parameters = array('region_id' => '000000-0000-0000-0000-00000000', 'filename' => 'my_terrain.raw');
$myRemoteAdmin->SendCommand('admin_save_heightmap', $parameters);
?>
Personal tools
General
About This Wiki