RemoteAdmin:admin load heightmap

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m
m (PHP: Fixed broken Google Code link, replacing with internal page)
 
(7 intermediate revisions by 4 users not shown)
Line 18: Line 18:
 
! Values
 
! Values
 
|-
 
|-
| ''regionid''
+
| ''region_name''
| region uuid
+
| Name of the region, optionaly use ''region_id''
 
|
 
|
 
|-
 
|-
Line 26: Line 26:
 
|
 
|
 
|}
 
|}
 
  
 
=== Optional Parameters ===
 
=== Optional Parameters ===
No optional parameters.
+
These parameters are optional and do not need to be set
 
+
{| cellspacing="0" cellpadding="4" border="1"
 +
|-
 +
! parameter
 +
! Description
 +
! Values
 +
|-
 +
| ''region_id''
 +
| region uuid of the region.
 +
|
 +
|}
  
 
== Returned Parameters ==
 
== Returned Parameters ==
Line 55: Line 63:
 
When an error occures the following error value are returned
 
When an error occures the following error value are returned
  
*terrain module not available
+
* terrain module not available
  
  
 
== Notes ==
 
== Notes ==
*Terrain files can also be loaded via web, were the filename is the full webadress.
+
* 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''
+
* ''accepted'' is an returned parameter, probably used prior to ''success''
  
 
== Example ==
 
== Example ==
 
=== PHP ===
 
=== PHP ===
 +
This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]].
 +
 
<source lang="php">
 
<source lang="php">
 
<?php
 
<?php
Line 79: Line 89:
 
</source>
 
</source>
  
[[Category:Development]]
+
 
 +
 
 +
[[Category:RemoteAdmin]]
 +
[[Category:RemoteAdmin Commands]]

Latest revision as of 12:37, 16 March 2021

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


Contents

[edit] 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,...


[edit] Parameters

[edit] 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

[edit] Optional Parameters

These parameters are optional and do not need to be set

parameter Description Values
region_id region uuid of the region.

[edit] Returned Parameters

[edit] Returned Parameters

These parameters are returned by Remote Admin

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


[edit] Error messages

When an error occures the following error value are returned

  • terrain module not available


[edit] 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

[edit] Example

[edit] 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_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