Difference between revisions of "LlReturnObjectsByID"

Revision as of 20:48, 14 June 2013

Function: integer llReturnObjectsByID( list objects );


0.0	Forced Delay
	Energy

Returns an integer that is the number of items successfully returned 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.

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.

Do not depend upon the auto-grant status of permissions. Always use the run_time_permissions event.
If the script lacks the permission PERMISSION_RETURN_OBJECTS, the script will shout an error on DEBUG_CHANNEL and the operation fails (but the script continues to run).

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.

Signature
function integer llReturnObjectsByID( list objects );

@@ 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)
 |return_type=integer
-|func_footnote
+|func_footnote=If the return value is negative, it represents an error flag.
 |func_desc
-|return_text=that is the number of items returned or an [[#{{anchorencode:Error Flags}}|ERR_*]] flag (if the value is negative, it's an error flag).
+|return_text=that is the number of items successfully returned or an [[#{{anchorencode:Error Flags}}|ERR_*]] flag.
 |spec
 |caveats

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