Difference between revisions of "LlReturnObjectsByID"
Jump to navigation
Jump to search
m |
m (bad sort key) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
{{LSL_Function/permission|PERMISSION_RETURN_OBJECTS}} | {{LSL_Function/permission|PERMISSION_RETURN_OBJECTS}} | ||
|func_id=|func_sleep=0.0|func_energy= | |func_id=|func_sleep=0.0|func_energy= | ||
|func=llReturnObjectsByID|sort= | |func=llReturnObjectsByID|sort=ReturnObjectsByID | ||
|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 [[#{{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= | ||
==== Script Owner and Scope ==== | ==== Script Owner and Scope ==== | ||
If the script is owned by an estate owner or manager | 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 ==== | ==== Throttle ==== | ||
Throttled at max parcel land impact capacity region-wide per hour. | Throttled at max parcel land impact capacity region-wide per hour. | ||
|caveats=*Objects | |caveats=* Objects owned by other groups will be returned to their previous owner if the object is transferable, deleted otherwise. | ||
|constants={{LSL_Constants/ReturnError|table=*|sortable=*}} | |constants={{LSL_Constants/ReturnError|table=*|sortable=*}} | ||
|examples | |examples | ||
| Line 22: | Line 24: | ||
{{LSL DefineRow||[[llReturnObjectsByOwner]]|}} | {{LSL DefineRow||[[llReturnObjectsByOwner]]|}} | ||
{{LSL DefineRow||[[llGetParcelPrimOwners]]|}} | {{LSL DefineRow||[[llGetParcelPrimOwners]]|}} | ||
{{LSL DefineRow||[[llDie]]|}} | |||
|also_tests | |also_tests | ||
|also_events | |also_events | ||
| Line 29: | Line 32: | ||
|cat2=Region | |cat2=Region | ||
|cat3=Security<!--not really security but I think it's useful to have it in that category--> | |cat3=Security<!--not really security but I think it's useful to have it in that category--> | ||
|cat4 | |cat4=Cleanup | ||
|history = Date of Release [[ Release_Notes/Second_Life_Server/13#13.06.18.277494 | 18/06/2013 ]] | |||
}} | }} | ||
Latest revision as of 23:28, 17 July 2013
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Summary
Function: integer llReturnObjectsByID( list objects );
| 0.0 | Forced Delay |
| Energy |
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.
| • 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 |
|---|
|
- 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 | |||
| • | llDie |
Articles
| • | Script permissions |