RemoteAdmin:admin create region

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(→‎admin create region)
(→‎Required paramenters)
Line 11: Line 11:
 
== Paramenters ==
 
== Paramenters ==
 
=== Required paramenters ===
 
=== Required paramenters ===
−
{{multicol}}
+
These parameters are required
−
*''region_name'' - Name of the new region
+
{| cellspacing="0" cellpadding="4" border="1"
−
*''listen_ip'' - listen ip to be used by region
+
|-
−
*''listen_port'' - integer value of port
+
! parameter
−
*''external_address'' - external address to be used by the region
+
! Description
−
*''region_x'' - region x location in grid
+
|-
−
*''region_y'' - region y location in grid
+
| region_name
−
*''estate_name'' - estate name that the new region belongs to. Specify estate owner if the estate does not exist yet.
+
| Name of the new region
−
 
+
|-
−
{{multicol-end}}
+
| listen_ip
 +
| listen ip to be used by region
 +
|-
 +
| listen_port
 +
| integer value of port
 +
|-
 +
| external_address
 +
| external address to be used by the region
 +
|-
 +
| region_x'
 +
| region x location in grid
 +
|-
 +
| region_y
 +
| region y location in grid
 +
|-
 +
| estate_name
 +
| estate name that the new region belongs to. Specify estate owner if the estate does not exist yet
 +
|}
  
 
=== Optional paramenters ===
 
=== Optional paramenters ===

Revision as of 09:40, 8 October 2011

Contents

admin create region

admin_create_region remotely allows to create a new regions and add them to an estate.


Enabling admin create region

To use admin_create_region one needs to enable the function in the [RemoteAdmin] section 

enabled_methods = admin_create_region

Paramenters

Required paramenters

These parameters are required

parameter Description
region_name Name of the new region
listen_ip listen ip to be used by region
listen_port integer value of port
external_address external address to be used by the region
region_x' region x location in grid
region_y region y location in grid
estate_name estate name that the new region belongs to. Specify estate owner if the estate does not exist yet

Optional paramenters

  • region_id - region uuid to be used for new region
  • estate_owner_uuid - estate owner uuid (optionaly use estate_owner_first and estate_owner_last)
  • estate_owner_first - estate owners first name
  • estate_owner_last - estate owners last name
  • persist - saves new region configs to file e.g. region.ini
  • region_file - when using persist you can specify the file to save region configs to
  • public - enable/disable public access to new region [true, false]
  • enable_voice - enable/disable voice to new region [true, false]
  • heightmap_file - load a heightmap file once the new region has been created.

Notes

  • When adding a region to a known estate in the Database one does not need to specify the estate owner. If the estate is new and needs to be created first, then use the estate_owner_uuid or estate_owner_first + estate_owner_last.
  • When using the optional persist parameter the region configs will be saved to the default region file. You can specify a the file using region_file if you dont want to use the default

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_create_user (multiple parameters)
$parameters = array('region_name' => 'My Plaza', 'listen_ip' => '0.0.0.0', 'listen_port' => '9001', 'region_x' => '1000', 'region_y' => '1000', 'estate_name' => 'My Estate');
$myRemoteAdmin->SendCommand('admin_create_region', $parameters);
?>
Retrieved from "http://opensimulator.org/index.php?title=RemoteAdmin:admin_create_region&oldid=25930"
Personal tools
General
About This Wiki