Difference between revisions of "LlMapDestination"

From Second Life Wiki
Jump to navigation Jump to search
Line 1: Line 1:
{{Issues/SVC-3455}}{{Issues/SVC-1038}}{{Issues/SVC-1795}}{{Issues/VWR-2060}}{{Issues/VWR-7331}}{{LSL_Function
{{LSL_Function
|inject-2={{Issues/SVC-3455}}{{Issues/SVC-1038}}{{Issues/SVC-1795}}{{Issues/VWR-2060}}{{Issues/VWR-7331}}
{{LSL Function/position|pos|region=*}}
{{LSL Function/position|look_at|region=*}}
|func_id=309|func_sleep=1.0|func_energy=10.0
|func_id=309|func_sleep=1.0|func_energy=10.0
|func=llMapDestination|sort=MapDestination
|func=llMapDestination|sort=MapDestination
|p1_type=string|p1_name=simname|p1_desc=Region name
|p1_type=string|p1_name=simname|p1_desc=Region name
|p2_type=vector|p2_name=pos|p2_desc=[[Viewer_coordinate_frames#Region|Region]] coordinates
|p2_type=vector|p2_name=pos
|p3_type=vector|p3_name=look_at|p3_desc=not used
|p3_type=vector|p3_name=look_at|p3_desc= (not used)
|func_footnote=(NOTE: '''look_at''' currently does nothing)
|func_footnote=(NOTE: {{LSLP|look_at}} currently does nothing)
|func_desc=Opens world map centered on '''simname''' with '''pos''' highlighted.<br />Only works for scripts [[attach]]ed to avatar, or during {{LSLGC|Touch|touch}} events.
|func_desc=Opens world map centered on {{LSLP|simname}} with {{LSLP|pos}} highlighted.<br />Only works for scripts [[attach]]ed to avatar, or during {{LSLGC|Touch|touch}} events.
|return_text
|return_text
|spec
|spec
|caveats=
|caveats=
* if '''simname''' is {{HoverText|omitted|an empty string: {{String}}}} or invalid, the map will open centered on object, but '''pos''' will not be highlighted. Since this function requests the client to perform a task, there is no way for script to know if it has failed.
* if {{LSLP|simname}} is {{HoverText|omitted|an empty string: {{String}}}} or invalid, the map will open centered on object, but {{LSLP|pos}} will not be highlighted. Since this function requests the client to perform a task, there is no way for script to know if it has failed.
|constants
|constants
|examples=<lsl>//Click the object this script is in and your map opens up in the middle of Oasis.
|examples=<lsl>//Click the object this script is in and your map opens up in the middle of Oasis.
Line 65: Line 68:
|also_articles
|also_articles
|notes=
|notes=
* '''pos''' will work with [[Viewer_coordinate_frames#Region|Region]] coordinates not inside '''simname'''. (like those returned by [[llRequestInventoryData]])
* {{LSLP|pos}} will work with [[Viewer_coordinate_frames#Region|Region]] coordinates not inside {{LSLP|simname}}. (like those returned by [[llRequestInventoryData]])
* if called from non {{LSLGC|Touch|touch}} events, it only works for the {{LSLGC|Owner|owner}}.
* if called from non {{LSLGC|Touch|touch}} events, it only works for the {{LSLGC|Owner|owner}}.
* if called from touch, it may only work for the first or last touch in the event queue (example: num_touched > 1)
* if called from touch, it may only work for the first or last touch in the event queue (example: num_touched > 1)

Revision as of 11:27, 14 June 2012

Summary

Function: llMapDestination( string simname, vector pos, vector look_at );

Opens world map centered on simname with pos highlighted.
Only works for scripts attached to avatar, or during touch events.

• string simname Region name
• vector pos position in region coordinates
• vector look_at position in region coordinates (not used)

(NOTE: look_at currently does nothing)

Caveats

  • This function causes the script to sleep for 1.0 seconds.
  • if simname is omitted or invalid, the map will open centered on object, but pos will not be highlighted. Since this function requests the client to perform a task, there is no way for script to know if it has failed.

Important Issues

~ All Issues ~ Search JIRA for related Bugs
   llMapDestination ignores look_at parameter
   llMapDestination in attachments opens a map on owner's screen even when touched by someone else
   llMapDestination pos parameter is sometimes replaced with incorrect data (workaround included)
   height in pos is capped to 1000m (code patch included)

Examples

<lsl>//Click the object this script is in and your map opens up in the middle of Oasis. default {

    touch_start(integer num)
    {
         llMapDestination("Oasis", <128, 128, 0>, ZERO_VECTOR);
    }

}</lsl> <lsl> // Get a teleport map, via touch_start, from the name of the first landmark in inventory. // NOTE: Requires a landmark that contains name, region and position data. // The correct format is "name, region (x, y, z)". If a landmark's // name is too long the position data is truncated from the end, // which will cause the position to be wrong. default {

    touch_start(integer num)
    {
         // Parse the name of the first landmark found in inventory into a list using 
         // commas as separators.
         list lstTemp = llParseString2List(llGetInventoryName(
              INVENTORY_LANDMARK,0),[","],[]);
         // Get list length and subtract 3 to get the correct element containing
         // the region name.  Moving backward from the end of the list keeps
         // commas in the landmark name from giving us grief with misaligned
         // and incorrect data.
         integer intElement = llGetListLength(lstTemp)-3;
         // Get the region name from the list element, eliminating unneeded 
         // characters in the string and trimming leading/trailing spaces.
         string strSimname = llStringTrim(llGetSubString(llList2String(lstTemp,
              intElement),0,llSubStringIndex(llList2String(lstTemp,intElement),"(")-1),
              STRING_TRIM);    
         // The vector is pulled from the landmark name, based on the 
         // position of "(" in the string starting with the next 
         // character and ending with the second to the last character.
         vector vecVector = (vector)("<"+llGetSubString(llGetInventoryName(
              INVENTORY_LANDMARK,0),llSubStringIndex(llGetInventoryName(
              INVENTORY_LANDMARK,0),"(")+1,-2)+">");
         
         // Bring up the teleport map using the data we extracted.
         llMapDestination(strSimname,vecVector,ZERO_VECTOR);
    }
}</lsl>

Notes

  • pos will work with Region coordinates not inside simname. (like those returned by llRequestInventoryData)
  • if called from non touch events, it only works for the owner.
  • if called from touch, it may only work for the first or last touch in the event queue (example: num_touched > 1)
  • if called inside an attachment, it only works for the owner.

See Also

Functions

•  llRequestInventoryData

Deep Notes

All Issues

~ Search JIRA for related Issues
   llMapDestination ignores look_at parameter
   Throttle llMapDestination to prevent "map bombing".
   llMapDestination in attachments opens a map on owner's screen even when touched by someone else
   llMapDestination pos parameter is sometimes replaced with incorrect data (workaround included)
   height in pos is capped to 1000m (code patch included)

Signature

function void llMapDestination( string simname, vector pos, vector look_at );