Difference between revisions of "LlReturnObjectsByOwner"

From Second Life Wiki
Jump to navigation Jump to search
m (added date of release)
Line 10: Line 10:
|return_type=integer
|return_type=integer
|func_footnote=If the return value is negative, it represents an [[#{{anchorencode:Error Flags}}|error]] flag.
|func_footnote=If the return value is negative, it represents an [[#{{anchorencode:Error Flags}}|error]] flag.
|func_desc
|func_desc=If the script is owned by an agent, [[PERMISSION_RETURN_OBJECTS]] may be granted by the owner.  If the script is owned by a group, this permission may be granted by an agent belonging to the group;s "Owners" role.
|return_text=that is the number of objects successfully returned to their owners 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=

Revision as of 14:31, 25 June 2013

Summary

Function: integer llReturnObjectsByOwner( key owner, integer scope );

If the script is owned by an agent, PERMISSION_RETURN_OBJECTS may be granted by the owner. If the script is owned by a group, this permission may be granted by an agent belonging to the group;s "Owners" role.
Returns an integer that is the number of objects successfully returned to their owners or an ERR_* flag.

• key owner avatar or group UUID
• integer scope OBJECT_RETURN_* flag

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

Throttle

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

scope Flag Description
OBJECT_RETURN_PARCEL Return all objects on the same parcel as the script which are owned by owner.
The script must be owned by an estate manager or over a parcel owned by the owner of the script.
OBJECT_RETURN_PARCEL_OWNER Return all objects owned by owner which are over parcels owned by the owner of the script.
OBJECT_RETURN_REGION Return all objects in the region owned by owner.
The script must be owned by the estate owner or an estate manager.
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.
  • Parcel owner, estate owner and estate managers can not have their objects returned by this method.
  • Objects which are owned by the group the land is set to will not be returned by this method.
    • 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
•  llReturnObjectsByID
•  llGetParcelPrimOwners

Articles

•  Script permissions

Deep Notes

History

Date of Release 18/06/2013

Signature

function integer llReturnObjectsByOwner( key owner, integer scope );