RemoteAdmin:admin save heightmap

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(PHP)
m
Line 77: Line 77:
 
</source>
 
</source>
  
[[RemoteAdmin]]
+
 
[[RemoteAdmin:Commands]]
+
 
 +
[[Category:RemoteAdmin]]
 +
[[Category:RemoteAdmin Commands]]

Revision as of 16:29, 24 October 2015

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