RemoteAdmin:admin load heightmap

From OpenSimulator

Jump to: navigation, search

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


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,...


Required Parameters

These parameters are required

parameter Description Values
region_name Name of the region, optionaly use region_id
filename file name of terrain file

Optional Parameters

These parameters are optional and do not need to be set

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
error error message when not successfull

Error messages

When an error occures the following error value are returned

  • terrain module not available


  • 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



This example needs the RemoteAdmin PHP Class file available here.

// Including the RemoteAdmin PHP class.
// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('', 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
About This Wiki