RemoteAdmin:admin load heightmap

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Notes)
m
Line 1: Line 1:
'''admin_load_heightmap''' remotely allows to load a terrain file to a region
+
'''admin_load_heightmap''' remotely allows to load a hight map files to a region.
  
  

Revision as of 12:00, 9 December 2011

admin_load_heightmap remotely allows to load a hight map files to a region.


Contents

Enabling admin load_heightmap

If not all functions are enabled, use admin_load_heightmap to enable the function in the [RemoteAdmin] section

enabled_methods = admin_load_heightmap,...


Parameters

Required Parameters

These parameters are required

parameter Description Values
regionid region uuid
filename file name of terrain file


Optional Parameters

No optional parameters.


Returned Parameters

Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
success true when successfull true
error error message when not successfull


Error messages

When an error occures the following error value are returned

  • terrain module not available


Notes

  • Terrain files can also be loaded via web, were the filename is the full webadress.
  • 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_load_heightmap (multiple parameters)
$parameters = array('regionid' => '000000-0000-0000-0000-00000000', 'filename' => 'my_terrain.raw');
$myRemoteAdmin->SendCommand('admin_load_heightmap', $parameters);
?>
Personal tools
General
About This Wiki