RemoteAdmin:admin create region
From OpenSimulator
(Difference between revisions)
(→Required paramenters) |
(→Optional paramenters) |
||
| Line 45: | Line 45: | ||
|- | |- | ||
! parameter | ! parameter | ||
| − | ! Description | + | ! Description |
| + | ! Values | ||
|- | |- | ||
| ''region_id'' | | ''region_id'' | ||
| region uuid to be used for new region | | region uuid to be used for new region | ||
| + | | | ||
|- | |- | ||
| estate_owner_uuid | | estate_owner_uuid | ||
| estate owner uuid (optionaly use estate_owner_first and estate_owner_last) | | estate owner uuid (optionaly use estate_owner_first and estate_owner_last) | ||
| + | | | ||
|- | |- | ||
| ''estate_owner_first'' | | ''estate_owner_first'' | ||
| estate owners first name | | estate owners first name | ||
| + | | | ||
|- | |- | ||
| ''estate_owner_last'' | | ''estate_owner_last'' | ||
| estate owners last name | | estate owners last name | ||
| + | | | ||
|- | |- | ||
| ''persist'' | | ''persist'' | ||
| saves new region configs to file e.g. region.ini | | saves new region configs to file e.g. region.ini | ||
| + | | true, false | ||
|- | |- | ||
| ''region_file'' | | ''region_file'' | ||
| when using persist you can specify the file to save region configs to (requires ''persist'' to be used) | | when using persist you can specify the file to save region configs to (requires ''persist'' to be used) | ||
| + | | | ||
|- | |- | ||
| ''public'' | | ''public'' | ||
| − | | enable/disable public access to new region | + | | enable/disable public access to new region |
| + | | true, false | ||
|- | |- | ||
| ''enable_voice'' | | ''enable_voice'' | ||
| − | | enable/disable voice to new region | + | | enable/disable voice to new region |
| + | | true, false | ||
|- | |- | ||
| ''heightmap_file'' | | ''heightmap_file'' | ||
| load a heightmap file once the new region has been created | | load a heightmap file once the new region has been created | ||
| + | | | ||
|} | |} | ||
Revision as of 07:07, 9 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
These parameters are optional and do not need to be set
| parameter | Description | Values |
|---|---|---|
| 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 | true, false |
| region_file | when using persist you can specify the file to save region configs to (requires persist to be used) | |
| 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
|
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); ?>
