SCript to send a Heartbeat signal to the Teleport Database. More...

Functions
string	rdLocInfo2String (integer LocationInfo, integer Index)
integer	rdCalcCommsChannel ()
	find a pseudo random communications channel number
	rdShowStationDialog (key User)
	Display the Destination Teelport Menu.
	rdDoTeleport (key Agent, integer Index)
	Select the Correct Teleportation Routine.
	rdReadDestinationList ()
	Read the list of Teleportation Destinations from the Notecard.
	rdInitialiseTeleporter ()
	Initialise or re-initialise the Teleporter.

Variables
string	VERSION_STRING = "1.2.0"
	The Current version of the software.
string	CONFIG_NOTECARD_NAME = "brigadoon_teleporter.config"
	The name of the notecard containing the Teleport's Configuration.
string	CONFIG_DESTINATIONS_NAME = "teleport_destinations.config"
	The automatically generated list of teleporter destinations.
string	COMMENT_PREAMBLE = "//"
	Preamble for a comment line in the configuration file.
integer	COMMENT_PREAMBLE_LENGTH = 2
	THe number of characters in the comment preamble.
string	LOCATION_NAME = "LOCATION_NAME"
	THe Key Value for defining hte name of the location in the Config notecard.
float	TIME_TO_DECIDE = 60.0
	Time a Menu remains active.
float	TIMER_OFF = 0.0
	Settings a Zero Time will turn off the Timer.
string	location_world
	The Teleporter Location's World.
string	location_region
	Region holding the Teleporter.
list	menu_list
string	location_name
	The display name of the current location.
list	destination_name
	The list of Teleport location names.
list	destination_world
	The list of Teleport world addresses.
list	destination_region
	The list of Teleport region names.
list	destination_location
list	destination_look_at
list	destination_loc_type
	The list of location types.
list	destination_group
	Group to which the Location belongs.
integer	comms_channel
integer	listen_handle
integer	station_base = 0
integer	station_list_size
	The total number of Destinations available.
key	last_user
	the last user of the teleport menu
integer	DIALOG_STATION_LIMIT = 9
	The hard maximum number of Destinations on any menu page.
integer	LOCAL_FLAG = 1
	Number value of Local Location flag.
integer	REGION_FLAG = 2
	Number value of REgion Location flag.
integer	WORLD_FLAG = 4
	Number value of World Location flag.
integer	METAVERSE_FLAG = 8
	Number value of Metaverse Location flag.

Detailed Description

SCript to send a Heartbeat signal to the Teleport Database.

Version: 1.2.0

Date: 25-December-2025

Author: River Drifter @ little-sense.au:9000 \email river.nosp@m._dri.nosp@m.fter@.nosp@m.auss.nosp@m.iebro.nosp@m.adba.nosp@m.nd.co.nosp@m.m.au

NOTE: The file extension ".osl" indicates the script uses the Open Simulator Script language (OSSL) and will not function in the Second Life environment. If the script will function using just the Linden Scripting Language (LSL), it will have a a file extension of ".lsl".

Definition in file brigadoon_teleporter.osl.

Function Documentation

◆ rdCalcCommsChannel()

integer rdCalcCommsChannel ( )

find a pseudo random communications channel number

This random channel generator comes from the Second Life Wiki https://wiki.secondlife.com/wiki/LlFrand

Definition at line 245 of file brigadoon_teleporter.osl.

{
    integer random_value = 0x80000000 | (integer)llFrand(65536) | ((integer)llFrand(65536) << 16);
    return(random_value);
}

Referenced by rdInitialiseTeleporter().

Here is the caller graph for this function:

◆ rdDoTeleport()

rdDoTeleport	(	key	Agent,
		integer	Index )

Select the Correct Teleportation Routine.

Parameters

Agent	The user to be teleported
Index	The index into the list of possible Teleportation Destinations

Definition at line 316 of file brigadoon_teleporter.osl.

{
    // Get information about the Destination Location
    string the_world = llList2String(destination_world, Index);
    string the_region = llList2String(destination_region, Index);
    vector the_landing = (vector)llList2String(destination_location, Index);
    vector the_look_at = (vector)llList2String(destination_look_at, Index);
    
    // Update the current location of the Teleporter to select correct Teleportation Routine
    location_region = llGetRegionName();
    vector location_position = llGetPos();
    
    // If the Destination is not in this simulator, use a hop command to get there
    if (location_world != the_world)
    {
        osTeleportAgent(Agent, the_world + ":" + the_region, the_landing, the_look_at);
    }
    
    // If the Destination is not in this Region, use a Teleport command that specifies the Region
    else if (location_region != the_region)
    {
        osTeleportAgent(Agent, the_region, the_landing, the_look_at);
    }
    
    // If the destination is in this region, but not the landing location of this Teleporter us a local Teleport
    else if (location_position != the_landing)
    {
        osTeleportAgent(Agent, the_landing, the_look_at);
    }
} 

References destination_location, destination_look_at, destination_region, destination_world, location_region, and location_world.

◆ rdInitialiseTeleporter()

rdInitialiseTeleporter ( )

Initialise or re-initialise the Teleporter.

This routine will initialise the Teleporter by reconfiguring it from the configuration file, and then (re)load the destination file,

Definition at line 393 of file brigadoon_teleporter.osl.

{
        // Get the location of the current world 
        location_world = llGetSubString(osGetGridHomeURI(), 7, -1);
        
        // Get a Communications Channel. This can been overridden in the basic configuration
        comms_channel = rdCalcCommsChannel();
 
        // Read the Configuration File into a List of Lines
        string config = osGetNotecard(CONFIG_NOTECARD_NAME);
        list config_data = llParseString2List(config, ["\n"], []);
 
        // Process each line in the Configuration Data
        integer index = 0;
        integer list_length = llGetListLength(config_data);
        for (; index < list_length; ++index)
        {
            // Trim line of  Leading and Trailing Spaces
            string trimmed_line = llStringTrim(llList2String(config_data, index), STRING_TRIM);
            
            // Only Process lines that are not a comment line or blank
            if ( (llGetSubString(trimmed_line, 0, COMMENT_PREAMBLE_LENGTH - 1) != COMMENT_PREAMBLE) && (trimmed_line != "") )
            {
                // Parse Line for a Configuration Field.
                list key_value = llParseString2List(trimmed_line, ["="], []);
                 
                // Fold the Trimmed Key into upper case, to eliminate errors where the case is wrong in the config file.
                string key_object = llToUpper(llStringTrim(llList2String(key_value, 0), STRING_TRIM));
                 
                // Trim the Value to remove leading and training spaces
                string value_object = llStringTrim(llList2String(key_value, 1), STRING_TRIM);
                 
                // Process the Key-Value Pairs to Set Configuration
                if (key_object == LOCATION_NAME)   location_name = value_object; 
            }
            location_region = llGetRegionName();
        }
        
        // Initial Read of the teleportation Destnation List
        rdReadDestinationList();
}

References COMMENT_PREAMBLE, COMMENT_PREAMBLE_LENGTH, comms_channel, CONFIG_NOTECARD_NAME, LOCATION_NAME, location_name, location_region, location_world, rdCalcCommsChannel(), and rdReadDestinationList().

Here is the call graph for this function:

◆ rdLocInfo2String()

string rdLocInfo2String	(	integer	LocationInfo,
		integer	Index )

Definition at line 227 of file brigadoon_teleporter.osl.

{
    string location_area = "";
    
    if ((LocationInfo & LOCAL_FLAG)          != 0) location_area = destination_group[Index];
    else if ((LocationInfo & REGION_FLAG)    != 0) location_area = destination_region[Index];
    else if ((LocationInfo & WORLD_FLAG)     != 0) location_area = destination_region[Index];
    else if ((LocationInfo & METAVERSE_FLAG) != 0) location_area = destination_world[Index];
    return " [" + location_area + "]";
}

References destination_group, destination_region, destination_world, LOCAL_FLAG, METAVERSE_FLAG, REGION_FLAG, and WORLD_FLAG.

Referenced by rdShowStationDialog().

Here is the caller graph for this function:

◆ rdReadDestinationList()

rdReadDestinationList ( )

Read the list of Teleportation Destinations from the Notecard.

Definition at line 351 of file brigadoon_teleporter.osl.

{
    // Clear the Teleportation Lists
    destination_name = []; destination_world = []; destination_region = [];
    destination_location = []; destination_look_at = [];
    destination_loc_type = []; destination_group = [];
 
    // Loop though Destination Configuration File
    integer list_length = osGetNumberOfNotecardLines(CONFIG_DESTINATIONS_NAME);
    integer index = 0;
    do
    {
        // Get the Line
        string trimmed_line = llStringTrim(osGetNotecardLine(CONFIG_DESTINATIONS_NAME, index), STRING_TRIM);
 
        // Skip comment lines and blank lines
        if ( (llGetSubString(trimmed_line, 0, COMMENT_PREAMBLE_LENGTH - 1) != COMMENT_PREAMBLE) && (trimmed_line != "") )
        {    
            // Split the Teleportation Destination COmponents out.
            list destination      = llParseString2List(trimmed_line, ["|"], []);
            destination_name     += (string)destination[0];
            destination_world    += (string)destination[1];
            destination_region   += (string)destination[2];
            destination_location += (string)destination[3];
            destination_look_at  += (string)destination[4];
            destination_loc_type += (string)destination[5];
            destination_group    += (string)destination[6];
        }
    }
    while (++index < list_length);
    
    // Set the Size of teh Destination List for the Menu
    station_list_size = llGetListLength(destination_name);
}

References COMMENT_PREAMBLE, COMMENT_PREAMBLE_LENGTH, CONFIG_DESTINATIONS_NAME, destination_group, destination_loc_type, destination_location, destination_look_at, destination_name, destination_region, destination_world, and station_list_size.

Referenced by rdInitialiseTeleporter().

Here is the caller graph for this function:

◆ rdShowStationDialog()

rdShowStationDialog ( key User )

Display the Destination Teelport Menu.

Theis routine displays the dialog that displays the teleport destinations selections.

Definition at line 257 of file brigadoon_teleporter.osl.

{
    list button_list;
    menu_list = [];
    
    // Add the back button if necessary
    if (station_base > 0) button_list += "<<"; else button_list += " ";
 
    // Add Done Button
    button_list += "DONE";
    
    // Add the Forward button, if necessary
    if (station_list_size > (station_base + DIALOG_STATION_LIMIT)) button_list += ">>"; else button_list += " ";
 
    // Now select the next (up to) nine (9) locatiions to display on the menu
    string menu_header = "Destinations Available from " + location_name + "\n";
    integer index;
    for (index = 0; index < DIALOG_STATION_LIMIT; ++index)
    {
        // Increase the menu number to match the actual number in the destination list, rather than menu number
        integer station_pos = index + station_base;
        if (station_pos < station_list_size)
        {
            // Get the type of location this destination is
            integer loc_info = (integer)llList2String(destination_loc_type, station_pos);
            
            // Get name of the destination and the type of location it is
            string item_name =  llUnescapeURL(llList2String(destination_name, station_pos)) + rdLocInfo2String(loc_info, station_pos);
            string index_string = (string)(station_pos + 1);
            
            // Add the Index, Name and location type to the menu header
            menu_header += "[" + index_string + "] " + item_name + "\n";
            
            // Add the index to the Buuton List to be displayed
            button_list += index_string;
            
            // Add the index to the line that will be scanned to match selections
            menu_list += index_string;
        }
        
        // If there aren't enough destinations to fill the nine (9) spaces use blanks
        else
        {
            // Add to the button list, but not the menu list as we don'r want matches to empty buttons
            button_list += " ";
        }
    }
    
    // Display the Dialog Menu
    llDialog(User, menu_header, button_list, comms_channel);
}

References comms_channel, destination_loc_type, destination_name, DIALOG_STATION_LIMIT, location_name, menu_list, rdLocInfo2String(), station_base, and station_list_size.

Here is the call graph for this function:

Variable Documentation

◆ COMMENT_PREAMBLE

string COMMENT_PREAMBLE = "//"

Preamble for a comment line in the configuration file.

Any line starting with this is a comment.

The configuration file only allows comments which take up the complete lilne in the file.

Definition at line 40 of file brigadoon_teleporter.osl.

Referenced by rdInitialiseTeleporter(), rdReadConfigNotecard(), and rdReadDestinationList().

◆ COMMENT_PREAMBLE_LENGTH

integer COMMENT_PREAMBLE_LENGTH = 2

THe number of characters in the comment preamble.

THe number of characters in the comment preamble Menu Item = [17:16] Nothing Found!

The length of the comment preamble.

Definition at line 46 of file brigadoon_teleporter.osl.

Referenced by rdInitialiseTeleporter(), rdReadConfigNotecard(), and rdReadDestinationList().

◆ comms_channel

integer comms_channel

Definition at line 157 of file brigadoon_teleporter.osl.

Referenced by rdInitialiseTeleporter(), and rdShowStationDialog().

◆ CONFIG_DESTINATIONS_NAME

string CONFIG_DESTINATIONS_NAME = "teleport_destinations.config"

The automatically generated list of teleporter destinations.

Notecard holding the Teleport Destination Locations.

This notecard is generated by the teleporter_heartbeat.osl script based on the settings in the CONFIG_NOTECARD_NAME notecard. If you want to place teleporter destinations in this file, you will need to disable the teleporter_destinations.osl script which periodically erases this file and replaces it withe the lastest values from the Database.

Definition at line 32 of file brigadoon_teleporter.osl.

Referenced by rdReadDestinationList(), and rdSaveNewTeleportNotecard().

◆ CONFIG_NOTECARD_NAME

string CONFIG_NOTECARD_NAME = "brigadoon_teleporter.config"

The name of the notecard containing the Teleport's Configuration.

Script(s) Configuration Notecard.

The name of the script configuration Notecard.

This notecard is used to configure the brigadoon_teleporter.osl and the teleporter_heartbeat.osl scripts.

Definition at line 26 of file brigadoon_teleporter.osl.

Referenced by rdInitialiseTeleporter(), and rdStateEntry().

◆ destination_group

list destination_group

Group to which the Location belongs.

Definition at line 151 of file brigadoon_teleporter.osl.

Referenced by rdLocInfo2String(), and rdReadDestinationList().

◆ destination_loc_type

list destination_loc_type

The list of location types.

Definition at line 145 of file brigadoon_teleporter.osl.

Referenced by rdReadDestinationList(), and rdShowStationDialog().

◆ destination_location

list destination_location

Definition at line 132 of file brigadoon_teleporter.osl.

Referenced by rdDoTeleport(), and rdReadDestinationList().

◆ destination_look_at

list destination_look_at

Definition at line 138 of file brigadoon_teleporter.osl.

Referenced by rdDoTeleport(), and rdReadDestinationList().

◆ destination_name

list destination_name

The list of Teleport location names.

Definition at line 114 of file brigadoon_teleporter.osl.

Referenced by rdReadDestinationList(), and rdShowStationDialog().

◆ destination_region

list destination_region

The list of Teleport region names.

Definition at line 126 of file brigadoon_teleporter.osl.

Referenced by rdDoTeleport(), rdLocInfo2String(), and rdReadDestinationList().

◆ destination_world

list destination_world

The list of Teleport world addresses.

Definition at line 120 of file brigadoon_teleporter.osl.

Referenced by rdDoTeleport(), rdLocInfo2String(), and rdReadDestinationList().

◆ DIALOG_STATION_LIMIT

integer DIALOG_STATION_LIMIT = 9

The hard maximum number of Destinations on any menu page.

Definition at line 190 of file brigadoon_teleporter.osl.

Referenced by rdShowStationDialog().

◆ last_user

key last_user

the last user of the teleport menu

If the current user is not the same as the last user, the station base will be reset.

Definition at line 184 of file brigadoon_teleporter.osl.

◆ listen_handle

integer listen_handle

\The commujications Channel handle

Definition at line 163 of file brigadoon_teleporter.osl.

◆ LOCAL_FLAG

integer LOCAL_FLAG = 1

Number value of Local Location flag.

Definition at line 197 of file brigadoon_teleporter.osl.

Referenced by rdLocInfo2String().

◆ LOCATION_NAME

string LOCATION_NAME = "LOCATION_NAME"

THe Key Value for defining hte name of the location in the Config notecard.

The Configuration File Identifier for the Name of the LOcation.

\string LOCATION_NAME

Definition at line 58 of file brigadoon_teleporter.osl.

Referenced by rdInitialiseTeleporter().

◆ location_name

string location_name

The display name of the current location.

The location name display by the Teleporter.

This name will be displayed in the Teleporter Menu as the location to be visited.

Definition at line 108 of file brigadoon_teleporter.osl.

Referenced by rdInitialiseTeleporter(), rdSendHeartbeatMessage(), and rdShowStationDialog().

◆ location_region

string location_region

Region holding the Teleporter.

This information is read from the teleporter

Definition at line 94 of file brigadoon_teleporter.osl.

Referenced by rdAdjustPosition(), rdDoTeleport(), and rdInitialiseTeleporter().

◆ location_world

string location_world

The Teleporter Location's World.

This is the address of the world in which this script resides.

This string is what the teleporter display will show as the name of this location. The contents of this string are set in the object's description field.

NOTE: This value will default to "DUMMY" to indicate that the Hypergrid is not available. This value can be over-written in the "teleporter.config" notecard to provide an actual virtual world

This location can be used to limit the scans to the current world. This allows different update rates to be set on different worlds, if desired.

Definition at line 86 of file brigadoon_teleporter.osl.

Referenced by rdAdjustPosition(), rdDoTeleport(), rdInitialiseTeleporter(), rdSendHeartbeatMessage(), rdsScanDestinationDatabase(), and rdStateEntry().

◆ menu_list

list menu_list

Definition at line 101 of file brigadoon_teleporter.osl.

Referenced by rdShowStationDialog().

◆ METAVERSE_FLAG

integer METAVERSE_FLAG = 8

Number value of Metaverse Location flag.

Numeric identifier of a Metaverse Location.

Definition at line 218 of file brigadoon_teleporter.osl.

Referenced by rdLocInfo2String(), and rdSetLocationType().

◆ REGION_FLAG

integer REGION_FLAG = 2

Number value of REgion Location flag.

Numeric identifier of a REgion Location.

Definition at line 204 of file brigadoon_teleporter.osl.

Referenced by rdLocInfo2String(), and rdSetLocationType().

◆ station_base

integer station_base = 0

Definition at line 169 of file brigadoon_teleporter.osl.

Referenced by rdShowStationDialog().

◆ station_list_size

integer station_list_size

The total number of Destinations available.

Definition at line 175 of file brigadoon_teleporter.osl.

Referenced by rdReadDestinationList(), and rdShowStationDialog().

◆ TIME_TO_DECIDE

float TIME_TO_DECIDE = 60.0

Time a Menu remains active.

This is the time period during which the script will respond to the Menu. After that time, the script will ignore menu responses.

Definition at line 67 of file brigadoon_teleporter.osl.

◆ TIMER_OFF

float TIMER_OFF = 0.0

Settings a Zero Time will turn off the Timer.

Set the Timer delay to 0.0 which turns off the timer events.

Definition at line 73 of file brigadoon_teleporter.osl.

◆ VERSION_STRING

string VERSION_STRING = "1.2.0"

The Current version of the software.

The Version number as a sring.

Definition at line 20 of file brigadoon_teleporter.osl.

Referenced by rdsScanDestinationDatabase(), and rdWriteStatusNotercard().

◆ WORLD_FLAG

integer WORLD_FLAG = 4

Number value of World Location flag.

Definition at line 211 of file brigadoon_teleporter.osl.

Referenced by rdLocInfo2String(), and rdSetLocationType().

Functions

Variables

Detailed Description

Function Documentation

◆ rdCalcCommsChannel()

◆ rdDoTeleport()

◆ rdInitialiseTeleporter()

◆ rdLocInfo2String()

◆ rdReadDestinationList()

◆ rdShowStationDialog()

Variable Documentation

◆ COMMENT_PREAMBLE

◆ COMMENT_PREAMBLE_LENGTH

◆ comms_channel

◆ CONFIG_DESTINATIONS_NAME

◆ CONFIG_NOTECARD_NAME

◆ destination_group

◆ destination_loc_type

◆ destination_location

◆ destination_look_at

◆ destination_name

◆ destination_region

◆ destination_world

◆ DIALOG_STATION_LIMIT

◆ last_user

◆ listen_handle

◆ LOCAL_FLAG

◆ LOCATION_NAME

◆ location_name

◆ location_region

◆ location_world

◆ menu_list

◆ METAVERSE_FLAG

◆ REGION_FLAG

◆ station_base

◆ station_list_size

◆ TIME_TO_DECIDE

◆ TIMER_OFF

◆ VERSION_STRING

◆ WORLD_FLAG