Difference between revisions of "LlReturnObjectsByID"

From Second Life Wiki
Jump to navigation Jump to search
m
m
Line 6: Line 6:
|p1_type=list|p1_name=objects|p1_desc=list of object [[UUID|uuids]] (keys)|p1_hover=list of object uuids (keys)
|p1_type=list|p1_name=objects|p1_desc=list of object [[UUID|uuids]] (keys)|p1_hover=list of object uuids (keys)
|return_type=integer
|return_type=integer
|func_footnote=If the return value is negative, it represents an error flag.
|func_footnote=If the return value is negative, it represents an [[#{{anchorencode:Error Flags}}|error]] flag.
|func_desc
|func_desc
|return_text=that is the number of items successfully returned or an [[#{{anchorencode:Error Flags}}|ERR_*]] flag.
|return_text=that is the number of objects successfully returned to their owners or an [[#{{anchorencode:Error Flags}}|ERR_*]] flag.
|spec
|spec=
=== Script Owner ===
If the script is owned by an estate owner or manager then any object in the region can be returned. Otherwise the script can return any object over land owned by the owner of the script.
=== Throttle ===
Throttled at max parcel land impact capacity region-wide per hour.
|caveats
|caveats
|constants={{LSL_Constants/ReturnError|table=*|sortable=*}}
|constants={{LSL_Constants/ReturnError|table=*|sortable=*}}
Line 21: Line 25:
|also_articles
|also_articles
|notes
|notes
|cat1
|cat1=Parcel
|cat2
|cat2=Region
|cat3
|cat3
|cat4
|cat4
}}
}}

Revision as of 20:54, 14 June 2013

Summary

Function: integer llReturnObjectsByID( list objects );

Returns an integer that is the number of objects successfully returned to their owners or an ERR_* flag.

• list objects list of object uuids (keys)

To run this function the script must request the PERMISSION_RETURN_OBJECTS permission with llRequestPermissions. If the return value is negative, it represents an error flag.

Specification

Script Owner

If the script is owned by an estate owner or manager then any object in the region can be returned. Otherwise the script can return any object over land owned by the owner of the script.

Throttle

Throttled at max parcel land impact capacity region-wide per hour.

Error Flags Description
ERR_GENERIC -1 A nebulous and inexplicable error, nothing is known about it.
ERR_PARCEL_PERMISSIONS -2 Permission lacked to perform task on specified parcel.
ERR_MALFORMED_PARAMS -3 Parameters are malformed.
ERR_RUNTIME_PERMISSIONS -4 Script lacks the runtime permission to perform the requested task.
ERR_THROTTLED -5 Task has been throttled. Try again later.

Caveats

Permissions
  • Once the PERMISSION_RETURN_OBJECTS permission is granted there is no way to revoke it except from inside the script (for example, with a new llRequestPermissions call) or the script is reset or deleted.
  • While anyone may grant PERMISSION_RETURN_OBJECTS this function will only work properly if one of the following is true:
    • The land is owned by the prim owner and this permission has been granted by the land owner.
    • The land is group owned and this permission has been granted by a group member filling the group "Owners" role.

Examples

See Also

Events

•  run_time_permissions Permission receiving event

Functions

•  llGetPermissions Get the permissions granted
•  llGetPermissionsKey Get the agent who granted permissions
•  llRequestPermissions Request permissions
•  llReturnObjectsByOwner
•  llGetParcelPrimOwners

Articles

•  Script permissions

Deep Notes

Signature

function integer llReturnObjectsByID( list objects );