View source for User:Haravikk Mistral/LlCastRay

{{Issues/SVC-6442}}{{LSL_Function
|func_id|mode=request
|func_sleep=0.0
|func_energy=10.0
|func=llCastRay
|sort=CastRay
|p1_type=vector|p1_name=origin
|p2_type=vector|p2_name=normal
|p3_type=float|p3_name=range
|p4_type=integer|p4_name=type
|p5_type=list|p5_name=detect
|func_desc=Casts a ray from <code>origin</code> along the direction described by <code>normal</code> until either <code>range</code> is reached, the ray hits a region boundary, or the results limit is reached.
|return_text=
|constants={{User:Haravikk_Mistral/Sensor/Types}}
{{User:Haravikk_Mistral/DETECT*}}
|spec=* Results are filtered by <code>type</code> (see below), and the data to capture is described by <code>detect</code> (see below, default is <code>[DETECT_KEY, DETECT_TYPE]</code>).
*This function will trigger a [[sensor]]() event with any results found, or a [[no_sensor]]() event if no results were detected. The usable {{LSLGC|Detected|llDetected*}}() functions within the sensor event are determined by <code>detect</code>.
|caveats=* A <code>range</code> of 0.0 or less will be ignored. Under LSO-LSL the maximum value of float can be used for what is effectively an infinity value, while under Mono true infinity can be provided.
* This function will return a maximum of 16 results (the limit of the [[sensor]]() event). The results are ordered such that the nearest result is first, followed by the second, and so-on.
* Only a single ray-cast can be performed by a script at a time; calling this function again before the <code>sensor()</code> event is triggered will interrupt the in-progress ray-cast and begin a new one.
* The [[sensor]]() and [[no_sensor]]() events may not trigger (ray-cast silently fails) if your script is triggering too ray-casts. The simulator will make a best effort to complete requests, though these may be delayed depending upon script-lag for the region.
|examples=<lsl>default {
    state_entry() {
        llSetTimerEvent(30.0);
    }
    timer() {
        llCastRay(llRot2Fwd(llGetRot()), 20.0, AGENT, [DETECT_NAME]);
    }
    sensor(integer x) {
        string message = "Hi there"; integer first = TRUE;
        while ((--x) >= 0) {
            if (first) first = FALSE;
            else if (!x) message += " and ";
            else message += ", ";

            message += llDetectedName(x);
        }
        llSay(PUBLIC_CHANNEL, (message = "") + message + "!");
        // Produces a message such as:
        // "Hi there, Haravikk Mistral, Strife Onizuka and Kelly Linden!"
    }
}</lsl>
|helpers
|related
|also
|notes=To support this version of the [[llCastRay]]() implementation, please vote on {{jira|SVC-6442}}
}}