Difference between revisions of "LlDetectedName"

From Second Life Wiki
Jump to navigation Jump to search
m
m
Line 1: Line 1:
{{LSL_Function/detected|item|name|error={{LSL Constant/NULL KEY}}}}{{LSL_Function
{{LSL_Function
|inject-2={{LSL_Function/detected|item|name|error={{LSL Constant/NULL KEY}}}}
|func_id=31|func_sleep=0.0|func_energy=10.0
|func_id=31|func_sleep=0.0|func_energy=10.0
|sort=DetectedName
|sort=DetectedName
|func=llDetectedName|return_type=string|p1_type=integer|p1_name=item
|func=llDetectedName|return_type=string|p1_type=integer|p1_name=item
|func_footnote=Returns {{LSL Constant/NULL KEY}} if '''{{LSL Param|item}}''' is not valid.<br>
|func_footnote=Returns {{LSL Constant/NULL KEY}} if {{LSLP|item}} is not valid.<br>
If the item detected is an avatar then the {{LSLGC|Avatar/Name|legacy name}} is returned.
If the item detected is an avatar then the {{LSLGC|Avatar/Name|legacy name}} is returned.
|func_desc
|func_desc
|return_text=that is the name of the {{LSLGC|Detected|detected}} '''{{LSL Param|item}}'''.  
|return_text=that is the name of the {{LSLGC|Detected|detected}} {{LSLP|item}}.  
|spec
|spec
|caveats
|caveats

Revision as of 11:28, 7 June 2012

Summary

Function: string llDetectedName( integer item );

Returns a string that is the name of the detected item.

• integer item Index of detection information

item does not support negative indexes. Returns NULL_KEY if item is not valid.
If the item detected is an avatar then the legacy name is returned.

Specification

llDetected* functions only work if called from within Detection events (collision, collision_start, collision_end, sensor, touch, touch_start, touch_end) or in functions called by Detection events. They will fail silently and return unusable values if called during other events.

Caveats

  • If item is out of bounds this function returns NULL_KEY and the script continues to execute without an error message.
  • Events that enable the llDetected* functions always return at least one detected item.
    • Detection events are not raised if there is nothing detected.[1]
    • The detection event's items detected parameter is initially never less than 1.[2]
All Issues ~ Search JIRA for related Bugs

Examples

<lsl> default {

   touch_start(integer num)
   {
       integer i = 0;
       do
           llSay(0, llDetectedName(i) + "'s key is " + (string) llDetectedKey(i));
       while(num > ++i);
   }

}

</lsl>

See Also

Articles

•  Detected

Deep Notes

Search JIRA for related Issues

Footnotes

  1. ^ The exception is no_sensor but it doesn't enable llDetected* functions.
  2. ^ Like all event parameters, the user can overwrite the initial value.

Signature

function string llDetectedName( integer item );