Difference between revisions of "LlReturnObjectsByOwner"
Jump to navigation
Jump to search
m (added date of release) |
|||
| (4 intermediate revisions by 3 users not shown) | |||
| 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= | ||
| Line 18: | Line 18: | ||
* Parcel owner, estate owner and estate managers can not have their objects returned by this method. | * 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 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 | ** Objects owned by other groups will be returned to their previous owner if the object is transferable. If not transferable they are deleted. | ||
|constants= | |constants= | ||
<div style="display:inline-block; vertical-align: top;"> | <div style="display:inline-block; vertical-align: top;"> | ||
| Line 44: | Line 44: | ||
{{LSL DefineRow||[[llReturnObjectsByID]]|}} | {{LSL DefineRow||[[llReturnObjectsByID]]|}} | ||
{{LSL DefineRow||[[llGetParcelPrimOwners]]|}} | {{LSL DefineRow||[[llGetParcelPrimOwners]]|}} | ||
{{LSL DefineRow||[[llDie]]|}} | |||
|also_tests | |also_tests | ||
|also_events | |also_events | ||
|also_articles | |also_articles | ||
|notes | |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. | ||
|cat1=Parcel | |cat1=Parcel | ||
|cat2=Region | |cat2=Region | ||
|cat3=Owner | |cat3=Owner | ||
|cat4=Security<!--not really security but I think it's useful to have it in that category--> | |cat4=Security<!--not really security but I think it's useful to have it in that category--> | ||
|cat5=Cleanup | |||
|history = Date of Release [[ Release_Notes/Second_Life_Server/13#13.06.18.277494 | 18/06/2013 ]] | |history = Date of Release [[ Release_Notes/Second_Life_Server/13#13.06.18.277494 | 18/06/2013 ]] | ||
}} | }} | ||
Latest revision as of 18:08, 11 May 2016
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Summary
Function: integer llReturnObjectsByOwner( key owner, integer scope );
| 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.
| • 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 |
|---|
|
- 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.
Examples
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.
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 | |||
| • | llDie |
Articles
| • | Script permissions |
Deep Notes
History
Date of Release 18/06/2013
Signature |
|---|
function integer llReturnObjectsByOwner( key owner, integer scope ); |