llChildPrims2List

From Second Life Wiki
Jump to navigation Jump to search
Emblem-important-yellow.png LSL Feature Request
The described function does not exist. This article is a feature request.

Summary

Function: list llChildPrims2List( integer start, integer end );
0.0 Forced Delay
10.0 Energy

Returns a list of child prim keys.

• integer start start index
• integer end end index

start & end support negative indexes.

Caveats

  • If either start or end are out of bounds the script continues to execute without an error message.
  • start & end will form an exclusion range when start is past end (Approximately: start > end).

Examples

list llChildPrims2List(integer start, integer end){//this probably doesn't work
    integer prims = (llGetNumberOfPrims() * !!llGetAttached()) + llGetObjectPrimCount(llGetKey());
    integer first = (prims != 1);
    integer last = prims - !first;
    if(start < 0)
        start += first + prims;
    if(end < 0)
        end += first + prims;
    
    list out;
    if(start > end) {
        if(end >= last) {
            do {
                out += llGetLinkKey(first);
            } while(last >= ++first);
        } else {
            while(first <= end){
                out += llGetLinkKey(first++);
            }
            while(start <= last){
                out += llGetLinkKey(start++);
            }
        }
    } else if(end >= first && start <= last) {
        if(start < first)
            start = first;
        if(end > last)
            end = last;
        do {
            out += llGetLinkKey(start);
        } while(end >= ++start);
    }
    return out;
}

Notes

Ranges & Indexes

The easiest way to explain how ranges work is to make all indexes positive. Negative indexes are just a way of counting from the tail end instead of the beginning, all negative indexes have a corresponding equivalent positive index (assuming they are in range). Positive indexes past length (after the last index), or negative indexes past the beginning (before the first index) are valid and the effects are predictable and reliable: the entries are treated as if they were there but were removed just before output.

  • If start <= end then the range operated on starts at start and ends at end. [start, end]
  • Exclusion range: If start > end then the range operated on starts at 0 and goes to end and then starts again at start and goes to -1. [0, end] + [start, -1]
    • If end is a negative index past the beginning, then the operating range would be [start, -1].
    • If end is a positive index past the end, then the operating range would be [0, end].
    • If both start and end are out of bounds then the function would have no operating range (effectively inverting what the function is supposed to do).

See negative indexes for more information. Should make it easier for scripters to get all child prim keys. Can be done using llGetLinkKey example is already provided.

See Also

Articles

•  Negative Index

Deep Notes

Signature

//function list llChildPrims2List( integer start, integer end );