llMapBeacon

function

Function syntax

llMapBeacon(

string region_name,// Name of the region where the beacon is displayed.
vector pos,// Position vector in region coordinates to highlight.
list options// A list of options to configure the map beacon.

);

Delay: 1 s
Energy: 10

Displays an in-world beacon and optionally opens the world map for the avatar touching or wearing the object, centered on region_name with pos highlighted. Only works for attached scripts or during touch events.

Asks the viewer to create a beacon for the user and optionally opens the world map centered on the location.

llMapBeacon("", ZERO_VECTOR, []);

Specification

From the LSL definitions: MapBeaconParam (rule, then its arguments)

BEACON_MAP, integer open_map, integer focus_map  // Causes llMapBeacon to optionally display and focus the world map on the avatar's viewer.

Requests that a user’s viewer set a beacon in the world and optionally opens the world map centered on the specified location.

Constant	Type	Value	Description
`BEACON_MAP`	integer	`1`

Parameter		Return Values / Additional Parameters		Description
[ `BEACON_MAP`, integer `open_map`, integer `focus_map` ]		Requests viewer world map behavior. If the first parameter is `TRUE` the viewer should open the world map. If the second parameter is `TRUE` this function also requests that the map should receive focus. Note that setting both values to true mimics the behavior of `llMapDestination`. Also, the focus_map parameter is only meaningful if open_map is `TRUE`

Caveats

Since this function requests the client to perform a task, there is no way for script to know if it has failed.

Examples

The following example mimics the behavior of llMapDestination.

default
{
    touch_start(integer total_number)
    {
        llMapBeacon("WindSong", <185,140,29>, [BEACON_MAP, TRUE, TRUE]);
    }
}

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.

Known issues

From the issue templates included by the wiki article:

SVC-3455 (bug): llMapDestination ignores look_at parameter
SVC-1038 (fs): Throttle llMapDestination to prevent “map bombing”.
SVC-1795 (bug): llMapDestination in attachments opens a map on owner’s screen even when touched by someone else
VWR-2060 (bug): llMapDestination pos parameter is sometimes replaced with incorrect data (workaround included)
VWR-7331 (bug): height in pos is capped to 1000m (code patch included)