MPP - Teleport Hybrid Pro Script V1.8.1 - Documentation

Teleports your visitors to another Sansar experience (an Atlas link) or to a spot in the same scene, when they click an object or walk into a trigger volume. Optional Yes/No confirmation popup, optional countdown sound, delay before the jump, and a per-visitor anti-spam cooldown with a private "please wait" message.

This script is standalone - it does not require any other MPP script to function.

New in V1.8: each visitor has their own teleport flow, so someone who leaves during the delay, or a teleport that fails, no longer blocks the teleporter for the others, and two visitors can use it at the same time. The cooldown is now per visitor, with a private "please wait" message for a click that comes too soon. In volume mode, leaving the volume and VR hands no longer trigger anything. Sound Volume 0 is silent. Warnings in the script console for a missing World URL or a wrong setup. Settings grouped by category (Activation/, Destination/, Sound/, Debug/) and a Debug Logging switch. V1.8.1 only renames a few labels. Your settings are kept when you update: see "Updating from V1.7.2".

Quick Start

1. After purchase, the script is in your Inventory in Build mode. Add it to the object that will be the teleporter: a pad, a door, a portal, a sign.
2. To another experience: keep Destination/Teleport To World On and paste the Atlas link of the destination in Destination/World URL (for example https://atlas.sansar.com/experiences/creator-handle/experience-name).
3. To a spot in this scene: turn Destination/Teleport To World Off and enter the landing coordinates in Destination/Local Position (read them on any object placed where visitors should land).
4. Write the text of the confirmation popup in Destination/Location Name, for example Teleport to the Main Store?.
5. Build and visit: click the object, answer Yes, and you are teleported after a short delay.

That is all most teleporters need. The rest of this guide details every option.

How It Works

Every visitor goes through these steps on their own: the popup, the delay and the cooldown belong to that visitor only. If the visitor leaves the scene at any point, their teleport is simply cancelled.

In the Build panel the settings are grouped by category: Activation/, Destination/, Sound/ and Debug/.

Activation

Click mode (default)

Activation/Use Click On: the object highlights on hover and shows Activation/Hover Text (default "Teleport"). A click starts the flow. Leave the hover text empty for a highlight without text.

With Activation/Hover Shows Location Name On, the hover text is the Destination/Location Name instead: the visitor reads where the object leads before clicking.

Volume or contact mode

Activation/Use Click Off: no click. The flow starts when an avatar enters the object:

• If the object's collider is a trigger volume, entering it starts the flow. Leaving it does nothing.
• If the collider is a normal one, touching the object starts the flow (walking onto a pad, for example).
• VR hands and the desktop grab point are ignored: only the avatar's body counts.
• The object needs a RigidBody component. Without one, a warning is written in the script console and the teleporter cannot be triggered.

In this mode the object has no hover text, unless Hover Shows Location Name is On: the Location Name then shows on hover, but a click still does nothing.

Confirmation Popup

With Activation/Require Confirmation On (default), the visitor sees a Yes/No popup whose text is Destination/Location Name. Write the whole question there, for example Go to the beach? or Teleport to MPP-Mainstore?.

• Yes starts the delay, then the teleport. No, or a popup closed without an answer, cancels the teleport; the cooldown then starts (see below).
• A click by the same visitor while their popup is open, or during their delay, is ignored without a message.
• With Require Confirmation Off, the delay starts right away, without a popup. Use it for pads inside your own scene, where a wrong click costs nothing.

Delay and Sound

After the confirmation (or right after the click when there is none), the script waits before teleporting:

• Without a sound (Sound/Play Sound Off, or no sound assigned): the wait is Activation/Delay Seconds (default 1, 0 to 30; 0 = immediate).
• With a sound (Sound/Play Sound On and a sound in Sound/Teleport Sound): the sound is played from the object Sound/Repeat Count times (1 to 10), one play every Sound/Sound Duration Seconds (0.1 to 30), and the teleport happens when the last play ends: after Repeat Count x Sound Duration Seconds. Delay Seconds is not used.
• Sound/Sound Volume goes from 0 to 200 percent (100 = the sound as recorded). At 0 the sound is silent but the timing stays the same: the teleport still waits Repeat Count x Sound Duration Seconds.

Set Sound Duration Seconds to the real length of your sound so the repeats do not overlap. A countdown beep with Repeat Count 3 and Sound Duration Seconds 1 gives three beeps and a jump at the third second.

Destination

Another experience

Destination/Teleport To World On and Destination/World URL = the Atlas link of the destination, as shown in the Sansar Atlas or the "Share" button of the experience: https://atlas.sansar.com/experiences/<creator-handle>/<experience-name>.

• The link must start with https:// or http://. Anything else gets a warning in the script console at start.
• With an empty World URL the teleporter does nothing at all (no popup), with a warning at start.

A spot in this scene

Destination/Teleport To World Off:

• Destination/Local Position = the landing coordinates in the scene, in meters. A position left at <0,0,0> (the origin of the scene) gets a warning at start: it is rarely what you want.
• Destination/Local Forward = the direction the avatar faces after landing, as a vector: <1,0,0> looks towards +X, <0,-1,0> towards -Y. Leave <0,0,0> to keep the avatar's current heading. The vertical part (Z) is ignored: avatars always land upright.

Tip: place a small object where visitors should land and turn it the way they should face, then copy its position into Local Position and its forward direction into Local Forward.

Cooldown (anti-spam)

Activation/Cooldown Seconds (default 2, 0 to 30) is the time a visitor must wait after using the teleporter before using it again. It counts from the end of their last use: the teleport, a No answer, or a cancelled flow. Each visitor has their own cooldown; other visitors are never blocked.

• A click during the cooldown is ignored and, with Activation/Cooldown Notice On (default), the visitor receives a private message, only visible to them: by default "Please wait 2 seconds before using this teleporter again." At most one message every 3 seconds per visitor, and none when the wait is under half a second. Write your own text in Activation/Cooldown Notice Text: {time} becomes the remaining time with its unit ("2 seconds", "1 minute 5 seconds"), {seconds} the whole number of seconds. Empty text, or the notice Off, = silent.
• In volume or contact mode, an entry during the cooldown is ignored without a message: the visitor simply walks through.
• With Cooldown Seconds at 0, a silent safety of a tenth of a second remains, so a double click never teleports twice.

Editor Properties Reference (19 total)

Activation

Destination

Sound

Debug

Version Notes

Updating from V1.7.2

• Your values carry over: the 16 settings of V1.7.2 keep their internal names and their values. As with any update, take a screenshot of the Build panel first, update one teleporter and check its panel before doing the others.
• Labels: the settings now have plain names in four groups. Same settings, same values:

• Three new settings at their defaults: Activation/Cooldown Notice (On), Activation/Cooldown Notice Text and Debug/Debug Logging (Off).
• What behaves differently: the cooldown is now per visitor (in V1.7.2 one use blocked the teleporter for everyone), and a click during it gets the private "please wait" message (turn Cooldown Notice Off for the V1.7.2 silence). A visitor who leaves during the delay no longer blocks the teleporter. In volume mode, leaving the volume no longer opens a second popup after a No, and VR hands are ignored. Sound Volume 0 is now really silent, with the same timing.

Recipes

A - A portal to another experience. Defaults, plus your Atlas link in Destination/World URL and the question in Destination/Location Name ("Teleport to the Main Store?").

B - A pad inside your scene, instant. Destination/Teleport To World Off, Local Position set, Activation/Require Confirmation Off, Activation/Delay Seconds 0. Click and jump.

C - A walk-in portal. Put the script on a trigger volume (a box with a RigidBody set to Trigger Volume), Activation/Use Click Off. Walking in opens the popup. Hover Shows Location Name On lets visitors read the destination on hover before stepping in.

D - A countdown before the jump. Sound/Play Sound On, a short beep in Teleport Sound, Repeat Count 3, Sound Duration Seconds 1: three beeps, then the teleport.

E - Several destinations. Copy the object as many times as you have destinations: each copy keeps its own settings.

Troubleshooting

Limits

• The cooldown is per visitor: there is no way to limit the teleporter to one use per minute for everyone.
• The popup shows one line of text; keep Location Name short.
• The hover text is cut at 128 characters.
• Sansar may refuse a teleport when it is asked too often in the whole scene; the script then writes a warning and the visitor can try again after the cooldown.

Related MPP Items

MPP - My Pretty Pixels. Teleport Hybrid Pro Script V1.8.1 (script MPP - Teleport Hybrid Pro). Store: https://www.sansar.com/store/listings/792acd86-6980-4995-9fb1-813aed8fc8bb/teleport-hybrid-pro-script