llReturnObjectsByOwner

function

Function syntax

integer llReturnObjectsByOwner(

key owner,// UUID of the avatar or group whose objects will be returned.
integer scope// OBJECT_RETURN_* scope flag (such as OBJECT_RETURN_PARCEL, OBJECT_RETURN_PARCEL_OWNER, or OBJECT_RETURN_REGION). Values: ReturnObjectsScope

);

Returns: integer
Energy: 10
Permission: PERMISSION_RETURN_OBJECTS

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.

If the return value is negative, it represents an error flag.

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

integer result = llReturnObjectsByOwner(NULL_KEY, 0);

Specification

Throttle

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

Constant	Type	Value	Description
`OBJECT_RETURN_PARCEL`	integer	`c=return all objects on the same parcel as the script which are owned by 'owner'`	return all objects on the same parcel as the script which are owned by ‘owner’
`OBJECT_RETURN_PARCEL_OWNER`	integer	`c=return all objects owned by 'owner' which are over parcels owned by the owner of the script.`	return all objects owned by ‘owner’ which are over parcels owned by the owner of the script.
`OBJECT_RETURN_REGION`	integer	`c=return all objects in the region owned by 'owner'`	return all objects in the region owned by ‘owner’

scope Flag		Description
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.
Return all objects owned by owner which are over parcels owned by the owner of the script.
Return all objects in the region owned by owner. The script must be owned by the estate owner or an estate manager.

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

Error Flags		Description

Caveats

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. If not transferable they are deleted.

Notes

For group-owned land you may want to explicitly code a group owner’s key into the script as there is no way to determine if a user is a group owner.

History

Date of Release 18/06/2013

Known issues

From the issue templates included by the wiki article:

SVC-6281 (fs): Shared group inventory