Difference between revisions of "HTTP API/Bot Commands/parcel info update"

From SmartBots Developers Docs
Jump to: navigation, search
Line 1: Line 1:
 
{{DISPLAYTITLE: parcel_info_update}}
 
{{DISPLAYTITLE: parcel_info_update}}
 
<onlyinclude>Update parcel details</onlyinclude>
 
<onlyinclude>Update parcel details</onlyinclude>
 +
 +
<syntaxhighlight lang="lsl">
 +
// See "LSL Helper Functions" page for this function
 +
smartbotsAPI("parcel_info_update", [
 +
  "x", 30,
 +
  "y", 60,
 +
  "name", "The new name of the parcel",
 +
  "sale", "on",
 +
  "saleprice", 1500,
 +
  "sellto", "cd93067e-7c4e-41c0-ba91-be01f4bafe35"
 +
]);
 +
</syntaxhighlight>
  
 
{{API Variables Table}}
 
{{API Variables Table}}

Revision as of 17:49, 26 June 2019

Update parcel details 

// See "LSL Helper Functions" page for this function
smartbotsAPI("parcel_info_update", [
  "x", 30,
  "y", 60,
  "name", "The new name of the parcel",
  "sale", "on",
  "saleprice", 1500,
  "sellto", "cd93067e-7c4e-41c0-ba91-be01f4bafe35"
]);

Variables

The following table shows input values (you send them with the API call) and returned output values.

Variable Required Description
Input basic parameters:
action yes = parcel_info_update
apikey yes Your personal developer's API key.
botname yes Your bot's SL login.
secret yes Bot access code of your bot.
dataType optional Set to "json" to get JSON reply instead of URL-encoded string
custom optional The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response.
Input:
x optional the X coordinate of the parcel (default - at bot's position)
y optional the Y coordinate of the parcel (default - at bot's position)
item1 yes the parcel entry to update (see the list below and examples)
item2 optional another entry
item3... optional and so on
Output:
(to be received in http_response LSL event, see docs for details)
result OK - command completed successfully
FAIL - command failed
resulttext Detailed reason for the failure.
custom The value from input "custom" parameter. See above.

Available parcel entries

The available parcel entries to update:

name
The parcel name
description
The parcel description
musicurl
The parcel music URL
sale
Set to "on" to set land for sale, "off" to stop selling
saleprice
The selling price
sellto
The person UUID allowed to purchase this parcel
sellobjects
Set to "on" to allow selling objects with the parcels ("off" to disallow)
snapshot
The UUID of the picture to be set as a parcel image
landingpoint
The parcel landing point, format: "X/Y/Z"
landingrouting
The landing restrictions on the parcel, one of:
Direct - land anywhere
LandingPoint - teleport to landing point only
None - teleport is blocked

Permissions

Your bot has to own the parcel, or have some of the permissions:

  • Parcel identity > "Change parcel name, description, and 'Moderate Content' setting"
  • Parcel settings > "Change music & media settings"
  • Parcel Management > "Set land for sale info"

IMPORTANT: SL requires you to re-log avatar when you change the parcel group abilities. Thus, relog bot after changing them.


Checking parcel update results

SL does not notify bot if parcel update was successful.

Thus, to ensure the results, bot

  1. updates the parcel,
  2. then re-reads the parcel details from SL and compares them with expected values.

If your bot lacks any permissions (for example, "Set landing point and set teleport routing"), then expected parcel data won't match the actual parcel details. And you get an error from API.


Return values

The command returns result=OK if parcel update succeed.


<< return back to Bot commands

(Miss an API call or parameter? Submit your request in forum)


Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=HTTP_API/Bot_Commands/parcel_info_update&oldid=1800"