Resources

hippoTELEPORT User Guide


Welcome to hippoTELEPORT, a powerful intra-sim teleport system that enables you to quickly link together locations and control who can teleport between them. If you’re an owner of our popular hippoRENT rental system, you’ll also find it easy to grant tenants access to teleporters -- ideal, for example, if you’re renting skyhomes. ...

Here’s what this document describes for you ...

1. Quick Start Guide ... get your first two teleporters online in seconds

2. Using Teleporters

3. Configuring Via Notecard ... how to use all the advanced power the _config notecard unlocks

4. Using the Menu Commands ... a guide to each menu command in your teleporter

5. Connecting to a Rental Box for Tenant Use ... a simple step-by-step guide to connecting a teleporter to a rental box

6. Connecting Multiple Rental Boxes to a Teleporter ... how to use one teleporter to access multiple rental boxes, useful for a mall, for example.



1. QUICK START GUIDE

  1. In your hippoTELEPORT folder you’ll find three teleport types; a single panel “hippoTELEPORT Pad (1P)”, a multi-panel one “hippoTELEPORT Pad (4P)” and a panel-free one.. Start by rezzing the former. All are supplied as “phantom” prims, making it easier if somebody materialises in the middle of them; but each design is moddable, should you wish to change this.

  2. Right-click it, choose “Edit” (then More>>> if only the mini-build dialog box appears) and then click the “Contents” tab.

  3. Double-click the “_config” notecard to open and edit it.

  4. A few lines down you’ll see:

    CHANNEL: -400100
    PASSPHRASE: anystringoflettersandornumberswilldoreally
  1. Change the channel to any number (this is the “chat” channel teleporters will communicate on). A low negative number is good for reducing lag. Change the passphrase to something different -- it’s used to encrypt communications between your teleporters.

  2. Close and save the notecard and close the Second Life build dialog window.

  3. HOLD DOWN your left mouse button for a second or two whilst pointing at the teleporter pad. A menu will appear from which you should choose “Reset”.

  4. Once the teleporter has finished loading its _config notecard it will look for other teleporters and, of course, find none. So rez a second teleporter and repeat steps (b) to (g) ... this time the two teleporters will find each other.

  5. Right click either teleporter and choose “Teleport!” to teleport between them.

Congratulations! You’ve mastered the basics. In short, any teleporter rezzed anywhere in the same sim will find and network with any others you own, provided the channel and passphrase are set the same.

One last trick and this lesson is complete. Find a picture in your inventory (any snapshot or texture will do) and add it to the inventory of the first teleporter (CTRL dragging it is easiest). Watch what the second teleporter does ... the first image, alphabetically, found in a teleporter’s contents will be used by any others to display as a picture representing that location. Don’t want pictures? Then just keep the contents clear of images (or, if you’re really clever, modify the vendor design and delete the image panel to save a prim).



2. USING TELEPORTERS

Once you have two or more teleporters connected together, using them is very simple ...

  • Pick the destination you want (use the arrows and/or touch the panels)

  • If the teleporter is running in “open” access mode (see below) and the destination is in range, simply right click it and choose “Teleport”; otherwise click it to rez a teleport beam, then click that again.

  • Note, sometimes the Second Life camera can get “left behind” when you teleport, especially if you had it in an odd position before teleporting. If this happens to you, try waiting for a second or two; or try walking and/or hitting the escape key a couple of times after arrival to force the camera to reposition.

That’s all there is to it. Now read on to discover how to fully control your teleporter using its configuration notecard and menu system.



3. CONFIGURING VIA A NOTECARD

The _config notecard inside the teleporter’s contents, that you encountered in step 1c above contains a wide range of other commands that can be used to set up a teleporter to behave in exactly the way you would like. Each command is now described below. Once you’ve made any changes to a teleporter’s _config notecard, remember to close (and save it) then hold down your left mouse button over the teleporter until the menu appears then click ‘Reset’.

LOCATION NAME: <text>
e.g. LOCATION NAME: My First Teleporter
- By default, the name that a teleporter transmits to other teleporters is the prim name (to see this, right click the teleporter, choose ‘Edit’ and look in the General tab. If you wish, you can use this LOCATION NAME setting instead. If this is set, it will override the prim name.

LOCATION PASSWORD: <password text>
e.g. LOCATION PASSWORD: topsecret
- If you wish, you can enable password controlled access to this location. When somebody clicks another teleport station, they’ll be asked to supply the password (on a randomly chosen chat channel) before a teleport disc is rezzed for them to use.

CHANNEL: <number>
e.g. CHANNEL: -4000
- The chat channel that teleporter units within a sim communicate on. To reduce lag, very low negative numbers are best. See 1d and 1e above.

PASSPHRASE: <text and/or numbers>
e.g. PASSPHRASE: mysecretcodehandsoff
- The secret code used to encrypt communications between your teleporters. See 1d and 1e above.

The next five settings control the hovertext that appears over a teleporter ...

HOVERTEXT LOCATION COUNT: <Yes/No>
e.g. HOVERTEXT LOCATION COUNT: Yes
- If set to yes, the location count (e.g. “1 of 5”) will appear in the teleporter’s hovertext.

HOVERTEXT LOCATION NAME: <Yes/No>
e.g. HOVERTEXT LOCATION NAME: Yes
- If set to yes, the name of the currently selected location will appear in the teleporter’s hovertext.

HOVERTEXT LOCATION COORDS: <Yes/No>
e.g. HOVERTEXT LOCATION COORDS: Yes
- If set to yes, the location of the currently selected teleporter will appear in hovertext (e.g. “Rodeo (14, 27, 32)”).

HOVERTEXT LOCATION PARCEL NAME: <Yes/No>
e.g. HOVERTEXT LOCATION PARCEL NAME: Yes
- If set to yes, the name of the land parcel at the currently selected location will appear in the hovertext display.

DISABLE ALL HOVERTEXT: <Yes/No>
e.g. DISABLE ALL HOVERTEXT: Yes
- If set to yes, no hovertext at all will be displayed over the teleporter. This command offers a really quick and easy way to disable text without changing all of the above settings.

HOVERTEXT COLOUR: <colour name or vector>
e.g. HOVERTEXT COLOUR: Red
- Sets the colour of the hovertext. The teleporter knows the following colour names -- red, blue, green, yellow, pink, white and black. Alternatively, you may also use a colour vector if you wish, e.g. HOVERTEXT COLOUR: <0.34, 0.19, 0.56>. For more on colour vectors in Second Life and how they work, see http://www.lslwiki.net/lslwiki/wakka.php?wakka=color

RIGHT CLICK TEXT: <text>
e.g. RIGHT CLICK TEXT: Teleport!
- Defines the label that appears in the right click menu when somebody uses the teleport.

These next two commands control how movement between teleporters is handled ...

SHORT RANGE MOVEMENT: <Sit/Move/Map>
e.g. SHORT RANGE MOVEMENT: Sit
- Defines how somebody will be teleported if the destination is less than 300m away. (Sit: the teleporter’s “sit” position will be targetting on the destination, so a user merely has to right-click the teleporter and choose “Teleport”; Move: user must click the teleporter, a “beam disc” will appear, this can be then be clicked and it will transport the user by physically moving to the destination. Please note that if any land parcels between the two points are barred to you, your objects or your scripts, this movement method will fail; Map: clicking on the teleporter will open the Second Life map window, focussed on the destination so the user can then click the ‘Teleport’ button.

LONG RANGE MOVEMENT: <Move/Map>
e.g. LONG RANGE MOVEMENT: Move
- As above, but defines how somebody will be teleported if the destination is more than 300m. Note the “sit” method cannot be used here, as Second Life places a 300m limit on that method.

IMPORTANT NOTE The highest altitude that “move” type teleports can take somebody to is 9999m (although you may get odd effects at very high altitudes). For “map” type teleports, the limit is 1000m. The furthest distance a “sit” type teleport can transport somebody is 300m in any direction.

MODE: <Open/Restricted/Locked>
e.g. MODE: Open
- Specify the mode of operation to run this teleporter in. More details are given below under the menu commands section but, in short, “open” allows anybody to teleport out, “locked” allows only the owner to teleport out (or in) whilst “restricted” means that only the owner, managers (see below), anybody on the access list (see below) or tenants in any connected rental box can teleport out from here. Note that teleporters need to use their teleport beams to work in this mode, so you’ll need to click once to generate the beam, then click that to teleport.

TELEPORT BEAM DISC COLOUR: <colour name or vector>
e.g. TELEPORT BEAM DISC COLOUR: Blue
- Sets the colour of the pad rezzed when using either the “move” teleport mode (or “sit” teleport in restricted or locked mode). The teleporter knows the following colour names -- red, blue, green, yellow, pink, white and black. Alternatively, you may also use a colour vector if you wish, e.g. HOVERTEXT COLOUR: <0.34, 0.19, 0.56>. For more on colour vectors in Second Life and how they work, see http://www.lslwiki.net/lslwiki/wakka.php?wakka=color

These next two commands help control access to your teleporter ...

MANAGERS: <list of names, separated by commas>
e.g. MANAGERS: Sherlock Holmes, Father Brown, Endeavour Morse
- Managers whose names appear here can (a) use the teleporter menus (more on which below) and (b) teleport out when the teleporter is set to “restricted” access mode.

ACCESS LIST: <list of names, separated by commas>
e.g. ACCESS LIST: Fred Flintstone, Homer Simpson, Bugs Bunny
- People whose names appear here can teleport out when the teleport is set to “restricted” access mode. Note: you may have up 100 names on the access list (or 500 names if using hippoTELEPORT v1.8 and above). However, a line in the _config notecard is limited to 255 characters, due to Second Life restrictions. If you wish to add more names than this, just add a second ACCESS LIST notecard line.

USEFUL TIP If you want the teleporter to allow access by members of the same group as it is set to when it is in restricted mode, use Group as one of the names.

These next four commands are used if connecting a teleporter to a hippoRENT box (see section 5 for explanation of these commands and how they work) ...

HIPPORENT NETWORK CHANNEL: <text and/or numbers>
HIPPORENT NETWORK PASSPHRASE: <text and/or numbers>
TENANT CAN EDIT ACCESS LIST: <Yes/No>
RESET ACCESS LIST WHEN TENANT CHANGES: <Yes/No>

And, finally, there are seven advanced settings that some users may find helpful ...

ARRIVAL POINT OFFSET: <vector>
ARRIVAL POINT OFFSET: <0, 0, 0.5>
- By default, people arriving at a teleporter will arrive at the coordinates the teleporter is at inworld (the coordinates listed in the “Object” tab of the Second Life build window). However, you may want people to arrive at a position slightly different to that; in which case, use this offset function. Remember the vector you supply is an *offset*, so to have people arrive 5 metres above the teleporter, you’d use ARRIVAL POINT OFFSET: <0, 0, 5>.

BEAM REZ OFFSET: <vector>
e.g. BEAM REZ OFFSET: <0, 0, 0.05>
- Tells the teleporter where to rez the teleporter “beam”, used for the movement teleport type. If you make your own custom teleporter, for example, you might need to edit this value.

PANELS: <number>
e.g. PANELS: 1
- Specifies how many picture panels this teleporter has. Leave this alone unless you’re a very creative type making your own type of teleporter (in which case, ensure each sub-panel is prim is named “Panel <number>” eg. “Panel 1”, “Panel 2” etc. and that this command specifies how many panels in total. Then reset all the scripts once. Advanced tinkerers might also like to know you can change the sound made when somebody teleports; just replace the “transporter” sound found in the teleporter’s contents (and in the beam prim’s contents). The first sound alphabetically will be played.

PANEL CLICK TELEPORTS: <Yes/No>
e.g. PANEL CLICK TELEPORTS: No
- If this is set to yes, clicking on a picture panel works the same as clicking the teleport pad to teleport.

DISABLE SIT MODE WHEN RUNNING SECURELY: <Yes/No>
e.g. DISABLE SIT MODE WHEN RUNNING SECURELY: Yes
- We don’t recommend using “sit” type teleports if you’re running a fully secured system. There is a chance that a valid user could, for example, rez a teleport beam and then a sneaky person lurking nearby sit on it to teleport (Second Life can’t stop this). If you turn this option to “Yes”, then the teleporter, if in restricted or locked mode, will never rez a teleport beam that is set to run in “sit” mode.

AVATAR ROTATION ON ARRIVAL: <angle in degrees>
e.g. AVATAR ROTATION ON ARRIVAL: 90
- If you’d like to specify the direction an incoming avatar faces on arrival, use this setting. Bear in mind that SL can sometimes be a little pernickity and entirely ignore avatar rotations on sit, but most the time it should work.

TELEPORT OUT ONLY: <Yes/No>
e.g. TELEPORT OUT ONLY: Yes
- If set to “Yes”, the teleporter will not transmit its location to others; meaning you’ll be able to teleport “out” from it, but it won’t appear as a location on any other teleporters in the sim.

TELEPORT IN ONLY: <Yes/No> (Version 1.8 and above only)
e.g. TELEPORT IN ONLY: Yes
- If set to ”Yes”, the teleporter will act as an arrival station only; nobody will be able to use it to teleport out.

TELEPORT IN ONLY TEXT: <text> (Version 1.8 and above only)
e.g. TELEPORT IN TEXT: Arrival Point Only
- The hovertext to display over the teleport pad if it’s running in TELEPORT IN ONLY: Yes mode.

GIVE ITEM ON TELEPORT OUT: <inventory item> (Version 1.8 and above only)
e.g. GIVE ITEM ON TELEPORT OUT: Main Store Landmark
- By setting this option, you can choose to have a teleporter give the specified inventory item to every avatar who teleports out. (The item must reside in the teleporter’s inventory and you must have copy and transfer rights for it).

GIVE ITEM ON TELEPORT IN: <inventory item> (Version 1.8 and above only)
e.g. GIVE ITEM ON TELEPORT IN: Welcome to our shop
- As above, but the inventory will be given to any avatar who teleports in to the location from another teleporter.

IM ON TELEPORT OUT: <message> (Version 1.8 and above only)
e.g. IM ON TELEPORT OUT: Thanks, <NAME>, for making a simple teleporter very happy!
- Use this to have a teleporter send the text you choose (via instant message) to any avatar who teleports out from here. (Remember that IMs from objects appear in the chat history window in Second Life and if the recipient is in busy mode, they will simply never arrive.) You can also use “smart tags” in this command which will be replaced, on the fly, according to the context. The tags you can use are ...

  • <NAME> ... will be replaced by the name of the avatar being teleported
  • <SIM> ... will be replaced by the sim name
  • <TELEPORT_FROM> ... will be replaced by the sending teleporter object’s name
  • <TELEPORT_TO> ... will be replaced by the destination teleporter object’s name
  • <COORDS_FROM> ... will be replaced by the sending teleporter’s coordinates in the sim
  • <COORDS_TO> ... will be replaced by the destination teleporter’s coordinates in the sim
  • <PARCEL_FROM> ... will be replaced by the name of the land parcel where the sending teleporter is located
  • <PARCEL_TO> ... will be replaced by the name of the land parcel where the destination teleporter is located

IM ON TELEPORT IN: <message> (Version 1.8 and above only)
e.g. IM ON TELEPORT IN: Welcome to <SIM> <COORDS_END>. Enjoy your visit!
- As above, but the message will be IMed to avatars arriving at this teleporter from another.

USEFUL TIP If you’re using the “map” teleport method (rather than “sit” or “move”), then the destination teleporter will never be told when an avatar has arrived, since there’s no way the sending teleporter can know when (or if) an avatar has clicked on the “Teleport” button in the Second Life map window.

SORT LOCATIONS: <Off/Ascending/Descending> (Version 1.8 and above only)
e.g. SORT LOCATIONS: Ascending
- You can choose to have a teleport station sort its list of other teleporters alphabetically by name (into either ascending or descending alphabtical order). Please note that to help save lag, there’s a short delay (about 20 seconds) between a teleporter adding a new location to its list and the list being sorted (basically the teleporter is waiting to see if any other base stations will be added in that time frame, so that only one sort is required).

EXCLUDE LOCATIONS CONTAINING: <words>
(Version 1.9 and above only)e.g. EXCLUDE LOCATIONS CONTAINING: Shop
- There may be occasions when you wish to exclude particular locations from being shown by a teleporter. In which case, you can use this command. In the example abive, the teleporter would simply ignore any others containing the word “Shop” in their name. You can use multiple words by separating them with commas ... e.g. EXCLUDE LOCATIONS CONTAINING: Shop,Chocolate,Belgium.Want to exclude certain locations from a particular teleporter? Simply use the new EXCLUDE LOCATIONS CONTAINING: <words> command; e.g. EXCLUDE LOCATIONS CONTAINING: Shop

BLANK PANEL TEXTURE KEY: <texture key> (Version 1.9 and above only)
e.g. BLANK PANEL TETXURE KEY: ada503a1-f1fa-d87d-5113-b49ef7aef454
- Specifies the texture to use on blank panels (or if the teleporter is showing a location that doesn’t have a picture). You can get a texture’s key, provided you have full permissions for it, by right-clicking it in your inventory and choosing “Copy Asset UUID”.

MAP MODE MESSAGE: <text>
(Version 1.9 and above only)e.g. MAP MODE MESSAGE: Please click me a second time to open the Second Life map.
- Allows you to customize the message Add the new MAP MODE MESSAGE: <text>a teleporter unit chats when it opens the Second Life map window if running in map mode.

LANDMARK MODE: <Yes/No>
(Version 1.9 and above only)e.g. LANDMARK MODE: Yes
- A teleporter can be set to run off any landmarks in its inventory, rather than network with other teleport stations. Simply add some landmarks to a teleporter’s inventory, add the line LANDMARK MODE: Yes to a fresh line in its “_config” notecard then reset it. When running in this mode, locations can only be shown on the Second Life map, sit and/or move mode's won’t work. Finally, if you wish to have pictures accompany your landmark locations, just add some textures to the teleporter’s inventory — the first picture will be used with the first landmark, the second picture with the second location and so on.

AUTO TRANSMIT EVERY: <time in seconds> (Version 1.8 and above only)
e.g. AUTO TRANSMIT EVERY: 3600
- Causes * Self Healing Networks
a teleport station to automatically re-broadcast its details to other teleporters at the time interval you choose. This may help a teleport network survive a major sim crash/reboot. If you also edit the teleport station’s object description (use the Second Life build tool) so it reads autostart, then you’ll have a “self-healing” network: should a major sim crash reset the teleporter, it will “autostart” (read its “_config” card and power up) when its reset. We don’t recommend setting AUTO TRANSMIT EVERY too low as it can be quite laggy: if you use AUTO TRANSMIT EVERY: 3600 along with the “autostart” option, your network should recover itself within an hour following a major sim incident.

FORCED COMMS DELAY PERIOD: <time in seconds> (Version 1.8 and above only)
e.g. FORCED COMMS DELAY PERIOD: 5
- An extremely advanced setting most users can ignore. If you’re running a very large network of teleporters on a heavily used sim, you may find that communications between teleporters (when setting a network up, resetting all units etc.) is improved by using this setting. It introduces a time delay (a random value between 1 and whatever value you set here) before the teleport station transmits its details to others on the network. This can help avoid swamping the region chat channel if you’re using a very large number of teleporters.


4. USING THE MENU COMMANDS

Hold down the left mouse button whilst pointing at the teleport pad and you’ll get a menu (so will managers if you’ve added any; tenants, if you’ve connected a rental box and set the appropriate _config setting above, will get the white list menu, more on which below). Each menu command is now briefly described:

Main Menu ...

LOCATIONS - chats a list of each teleport location that is known. Up to 200 can be held in one teleporter.

STATUS - reports the status of the teleporter, including any managers or tenants in a connected rental box. You’ll also be told how many people have teleported out from and in to this location. (Note: this count can only track people teleporting in using sit or move mode, not map mode). To reset this counter, use the “Clear Counts” button in the tools menu.

ACCESS - opens the access menu (see below).

RESET - resets the teleporter and reloads the “_config” notecard. Use this command after you’ve made any changes to a _config notecard.

RESET ALL - resets any teleporter you own on the same channel/passphrase as this teleporter. (Please note that any other teleporters running in landmark mode won’t reset themselves).

LOGS - opens the logs menu (see below) if your teleporter is version 1.8 or higher.

TOOLS - opens the tools menu (see below) if your teleporter is version 1.2 or higher.

UNREGISTER - unregisters this teleporter (removes it from the memory of any other teleporters it was connected to).

HELP - gives out a fresh copy of this instruction notecard.


Access Menu ...

MODE - Allows you to switch the teleporter into open, restricted or locked mode (these are described above in the configuration notecard section).

ACCESS LIST - You can add a name (or names, separated by commas) to the access list, remove a name, list the names or wipe them. Remember, the access list determines who can use the teleporter to teleport out when the teleport is running in “restricted” access mode. If you want the teleporter to allow access by members of the same group as it is set to when it is in restricted mode, use Group as one of the names. The access list can hold up to 500 names if you’re using hippoTELEPORT v1.8 or later, or 100 names if an earlier version.


Logs Menu ...

If you’re using version 1.8 or higher of hippoTELEPORT it can log each person who teleports in and out to a teleport station. This menu lets you work with these logs. You have two options:

SHOW LOGS — Chats details of the last 100 people to teleport in or out. You’ll see the date, time, avatar name, the name of the teleport station they went to (or came from) and its location.

WIPE LOGS — Reset the logs.


Tools Menu ...

MAN DEST — Allows you to enter a destination manually. You’ll be asked to type the coordinates in the form <x, y, z>; e.g. <100, 200, 37>. The teleporter will then point to that location until you either reset it, or pick another destination in the usual way (click one of its arrows or panels).

CLEAR COUNTS - Reset the counter that tracks how many people have teleported out from and in to this teleport station.



5. CONNECTING TO A RENTAL BOX FOR TENANT USE

If you use our popular hippoRENT rental system, you can easily network a teleporter to a rental box. Once this is setup, tenants or managers on the rental box will be granted access rights to the teleporter --- merely flip it into “restricted” mode and you have a tenant-only teleport system. You can also, if you wish, allow tenants to add people to the access list and turn the teleport into “open” mode to invite friends to visit them, should you wish to do so.

Here are the steps to follow:

  1. Add the “PLUGIN_hippoTELEPORT” script that you will find in your hippoTELEPORT folder to the rental box you wish to attach this sign to. (You can drag it, holding down CTRL, or open the rental box’s ‘Content’ tab as you did in (1a) when setting up the teleporter, then drag the “PLUGIN_hippoTELEPORT” script from your inventory folder to the rental box.

    ADVANCED TIP (Version 1.9 and higher only)

    If you wsh to connect one teleporter to multiple rental boxes then instead you will want to add the
    PLUGIN_hippoTELEPORT_mk2 script to your rental boxes. Having done this, configuration will proceed in entirely the same way (steps 2-7 below, although please note that the RESET ACCESS LIST WHEN TENANT CHANGES command will be ignored by the teleporter. This is for obvious reasons: if you’ve got, say, three rental boxes networked to one teleporter, it would be extremely annoying for tenants one and two if the access list got wiped every time the third rental box got a new tenant). If you wish to use RESET ACCESS LIST WHEN TENANT CHANGES: Yes, then you’ll want to stick with the PLUGIN_hippoTELEPORT script.

  2. Open the rental box’s ‘Content’ tab if you haven’t already and double-click on the plugin script you have just added to edit it. At the top, you’ll see these settings:

    integer teleport_channel = -5736746;
    string passphrase = "pickanystringoflettersandornumbersreally";

  3. Choose a new channel number and a new secret passphrase, for example you might have the lines of the script look like this ...

    integer teleport_channel = -100401;
    string passphrase = "this is a top secret sentence nobody will guess";

  4. Check the script is set to “Running” (look at the very bottom-left hand corner of the script window and ensure that “Running” is ticked). Then close and save your script. If all is well, the rental box will whisper “hippoTELEPORT plugin loaded and running ok.”

  5. Now edit the teleporter’s _config notecard and find these two commands ....

    HIPPORENT NETWORK CHANNEL: 0
    HIPPORENT NETWORK PASSPHRASE: pickanystringoflettersandornumbersreally

    Change them so they have *exactly the same* settings as those you used in the script in step (3), so for example:

    HIPPORENT NETWORK CHANNEL: -100401
    HIPPORENT NETWORK PASSPHRASE: this is a top secret sentence nobody will guess


  6. If you want the tenant to be able to edit the access list menu, then also use:

    TENANT CAN EDIT ACCESS LIST: Yes

    Otherwise, use ...

    TENANT CAN EDIT ACCESS LIST: No

    And finally, if you wish the access list to wipe itself when the tenant leaves or is replaced, use:

    RESET ACCESS LIST WHEN TENANT CHANGES: Yes

  7. Close and save the _config card. Hold down your mouse over the teleporter pad until the menu appears and choose “Reset” to load your changes. Once the teleporter is ready, click the rental box and choose “Reset”. It will transmit any current tenant data to the teleport pad (and will do so again every two hours, or whenever a tenancy starts, ends, or money is paid). Remember: the “Status” menu command from the teleporter’s main menu will always tell you the names of any tenants in a connected rental box, a quick way to check.



6. CONNECTING SEVERAL RENTAL BOXES TO ONE TELEPORT ACTING AS A HUB

A second trick that the hippoRENT plugin script described in section (5) can perform is to allow a rental box to function as a “teleport location”. This means that you can hook up lots of rental boxes to once teleporter ... if you run a mall, for example, you could then have a teleporter board at the landing point so customers can quickly find the store they want. Again, once you’ve set up the plugin scripts in your rental boxes, everything stays automatically in touch and syncs itself. It’s a great feature and easy to use.

The first few steps are the same as those outlined in section (5) above ...

  1. (1) Add the “PLUGIN_hippoTELEPORT” script that you will find in your hippoTELEPORT folder to the rental box you wish to attach this sign to. (You can drag it, holding down CTRL, or open the rental box’s ‘Content’ tab as you did in (1a) when setting up the teleporter, then drag the “PLUGIN_hippoTELEPORT” script from your inventory folder to the rental box.

  2. (2) Open the rental box’s ‘Content’ tab if you haven’t already and double-click on the “PLUGIN_hippoTELEPORT” script to edit it. At the top, you’ll see these settings:

    integer teleport_channel = -5736746;
    string passphrase = "pickanystringoflettersandornumbersreally";

  3. Replace these with the teleporter channel and teleporter passphrase you setup in section (1) above. (Important Note: don’t confuse the teleport channel (the channel teleporters use to talk to one another, or to rental boxes acting as teleporters) with the networking channel described in section (5). Basically what we’ve described here in section (6) is how to make your rental box plugin *behave like a teleporter* by sending out its location details. Sounds complicated, but once you’ve set it up the first time, all will become clear).

    integer teleport_channel = -400100;
    string passphrase = "anystringoflettersandornumberswilldoreally";

  4. Now find the 17th line of the script which looks like this:

    integer act_as_arrival_location = FALSE;

    and change it this

    integer act_as_arrival_location = TRUE;

  5. If you want to have your teleport show a different picture when the property is rented (when free, it uses the picture specified in the rental box’s configuration as usual), then find line 27 which reads:

    string picture_key_when_rented = "";

    ... and replace it with the key of the picture you want. (You can right click the picture in your inventory and choose ‘Copy Asset ID’ to get it). For example:

    string picture_key_when_rented = "7469c63f-68fa-d78a-7c92-df893c345f39";

    Finally, if you’d prefer the rental box to be removed from the teleporter when rented, edit line 23 from ...

    integer not_available_when_rented = FALSE;

    ... to ...

    integer not_available_when_rented = TRUE;

  6. Check the script is set to “Running” (look at the very bottom-left hand corner of the script window and ensure that “Running” is ticked). Then close and save your script. If all is well, the rental box will whisper “hippoTELEPORT plugin loaded and running ok.”

  7. You should now find that the rental box appears on any teleporters operating with the same channel/passphrase as that in step (3) above.
IMPORTANT NOTE!

It is not possible to have one plugin script cause a rental box to appear on a teleporter and, simultaneously, unlock a teleporter for tenant use. If you wish one rental box to do both things, the easiest way is to add two copies of the PLUGIN_hippoTELEPORT script to a rental box and have each perform one of the two functions.


USEFUL TIP

If you add the command AUTO ADJUST MODE DEPENDING ON TENANCY: Yes to a teleporter’s “_config” notecard it will run in open mode (so anybody can use it) when it’s connected box is not rented, but automatically flip to restricted mode the moment there is a tenant. This can be very useful if you want prospective tenants to be able to look round e.g. a sky home before renting.

Please note: ensure you also have MODE: Open set in your “_config” notecard if using this function, or you'll get some odd results!

(Version 1.8 and above only)


We hope that you enjoy using your hippoTELEPORT system.

We recommend to all customers that they join the Hippo Technologies Users Group in Second Life. It’s a friendly community and lots of advice, tips and support can often be found by asking nicely!

<< Back