llReturnObjectsByID

From Second Life Wiki
Revision as of 11:53, 24 June 2013 by Maestro Linden (talk | contribs) (Added information about inability to return objects owned by parcel owners or estate managers)
Jump to navigation Jump to search

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 and Scope

If the script is owned by an estate owner or manager, this function works for objects located on any parcel in the region. Otherwise, the script can return objects located over land owned by the owner of the script.

As a security measure, parcel owner, estate owner, and estate managers can not have their objects returned by this method, except when the object returns itself.

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.
  • Objects owned by other groups will be returned to their previous owner if the object is transferable, deleted otherwise.

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 );