Difference between revisions of "LlReturnObjectsByOwner"
Jump to navigation
Jump to search
m (Created page with "{{LSL_Function |inject-2= {{Issues/SVC-6281}} {{LSL_Function/permission|PERMISSION_RETURN_OBJECTS}} {{LSL_Function/avatar|owner|group=*}} |func_id=|func_sleep=0.0|func_energy= |f…") |
m |
||
| Line 7: | Line 7: | ||
|func=llReturnObjectsByOwner|sort=ReturnObjectsByOwner | |func=llReturnObjectsByOwner|sort=ReturnObjectsByOwner | ||
|p1_type=key|p1_name=owner | |p1_type=key|p1_name=owner | ||
|p2_type=integer|p2_name=scope | |p2_type=integer|p2_name=scope|p2_desc=OBJECT_RETURN_* flag | ||
|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. | ||
| Line 13: | Line 13: | ||
|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= | ||
==== 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= | ||
|constants={{{!}} | * 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 deleted, not returned. <!-- verify please, might cause ERR_GENERIC instead --> | ||
|constants= | |||
<div style="display:inline-block; vertical-align: top;"> | |||
{{{!}} class="sortable" {{prettytable|style=margin: 0px 10px 10px 0pt;}} | |||
{{!}}- {{hl2}} | |||
! class="sortable" {{!}} {{LSLPT|scope}} Flag | |||
! title="Value" class="sortable" {{!}} | |||
!{{!}} Description | |||
{{!}}- | |||
{{LSL ConstTB|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 {{LSLPT|owner}}. <br/> The script must be owned by an estate manager or over a parcel owned by the owner of the script. | |||
{{!}}- | |||
{{LSL ConstTB|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 {{LSLPT|owner}} which are over parcels owned by the owner of the script. | |||
{{!}}- | |||
{{LSL ConstTB|OBJECT_RETURN_REGION|integer||c=return all objects in the region owned by 'owner'}} | |||
{{!}} Return all objects in the region owned by {{LSLPT|owner}}. <br/> The script must be owned by the estate owner or an estate manager. | |||
{{!}}} | {{!}}} | ||
</div><div style="display:inline-block; vertical-align: top;"> | |||
{{LSL_Constants/ReturnError|table=*|sortable=*}} | {{LSL_Constants/ReturnError|table=*|sortable=*}} | ||
</div> | |||
|examples | |examples | ||
|helpers | |helpers | ||
| Line 36: | Line 50: | ||
|cat1=Parcel | |cat1=Parcel | ||
|cat2=Region | |cat2=Region | ||
|cat3 | |cat3=Owner | ||
|cat4 | |cat4 | ||
}} | }} | ||
Revision as of 22:47, 14 June 2013
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Summary
Function: integer llReturnObjectsByOwner( key owner, integer scope );
| ? | Function ID |
| 0.0 | Forced Delay |
| Energy |
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 deleted, not returned.
Important Issues
~ All Issues ~ Search JIRA for related Bugs
|
|
SVC-6281 | A | Shared group inventory |
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 |
Articles
| • | Script permissions |
Deep Notes
All Issues
~ Search JIRA for related Issues|
|
|
SVC-6281 | A | Shared group inventory |
Signature |
|---|
function integer llReturnObjectsByOwner( key owner, integer scope ); |