OsTeleportAgent

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
'''Syntax:'''
+
{|  width="100%" style="border: thin solid black"
 +
| colspan="2" align="center" style=background:orange | '''{{SUBPAGENAME}}'''
 +
|- valign="top"
 +
|'''Threat Level''' || High
  
'''osTeleportAgent(key UUID, string destinationTarget, vector position, vector lookAt)''' <br />
+
|- valign="top"
'''osTeleportAgent(key UUID, integer regionX, integer regionY, vector position, vector lookAt)''' <br />
+
|'''Function Syntax''' || <source lang="lsl">
'''osTeleportAgent(key UUID, vector position, vector lookAt)'''
+
osTeleportAgent(key UUID, string destinationTarget, vector position, vector lookAt)
 
+
osTeleportAgent(key UUID, integer regionX, integer regionY, vector position, vector lookAt)
'''Returns:'''
+
osTeleportAgent(key UUID, vector position, vector lookAt)
 
+
</source>
Nothing
+
|- valign="top"
 
+
|'''Example(s)||<source lang="lsl">// Example osTeleportAgent Script
'''Threat level:'''
+
 
+
High
+
 
+
'''Description:'''
+
 
+
Teleports an agent to the specified location. The first variant is able to teleport to any addressable region, including [[hypergrid]] destinations. The second variant teleports to a region in the local grid; the region coordinates are specified as region cells (not as global coordinates based on meters). The third variant teleports within the current region.
+
 
+
For osTeleportAgent() to work, the owner of the prim containing the script must be the same as the parcel that the avatar is currently on.  If this isn't the case then the function fails silently.
+
 
+
These functions have a [[threat level]] of ''High'' and must be allowed in OpenSim.ini for operation (see [[OSSL Enabling Functions]] for examples). Also see [[osTeleportOwner]].
+
 
+
'''Example:'''
+
<source lang="lsl">// Example osTeleportAgent Script
+
 
//
 
//
 
// Set Destination as described below, There are a Few Options depending on Application:
 
// Set Destination as described below, There are a Few Options depending on Application:
Line 66: Line 55:
  
  
 +
|}
 +
 +
Teleports an agent to the specified location. The first variant is able to teleport to any addressable region, including [[hypergrid]] destinations. The second variant teleports to a region in the local grid; the region coordinates are specified as region cells (not as global coordinates based on meters). The third variant teleports within the current region.
 +
 +
For osTeleportAgent() to work, the owner of the prim containing the script must be the same as the parcel that the avatar is currently on.  If this isn't the case then the function fails silently.
 +
 +
See also  [[osTeleportOwner]].
  
[[Category:OSSL]]
+
[[Category:OSSL Functions]]

Revision as of 12:29, 11 June 2011

OsTeleportAgent
Threat Level High
Function Syntax
osTeleportAgent(key UUID, string destinationTarget, vector position, vector lookAt)
osTeleportAgent(key UUID, integer regionX, integer regionY, vector position, vector lookAt)
osTeleportAgent(key UUID, vector position, vector lookAt)
Example(s)
// Example osTeleportAgent Script
//
// Set Destination as described below, There are a Few Options depending on Application:
// IN GRID Teleport 
// Destination = "1000,1000"; = Using In-Grid Map XXXX,YYYY coordinates
// Destination = "RegionName"; = Using RegionName
// HyperGrid Teleport (region must be HG Enabled)
// Destination = "TcpIpAddr:Port:RegionName"; = Using the Target/Destination IP Address
// Destination = "DNSname:Port:RegionName"; = Using the Target/Detination DNSname
// Note: RegionName is Optionally Specified to deliver Avatar to specific region in an instance.
// 
// ========================================================================================
// === SET DESTINATION INFO HERE ===
//
string Destination = "LBSA Plaza"; // your target destination here (SEE NEXT LINES) Can Be
vector LandingPoint = <128,128,50>; // X,Y,Z landing point for avatar to arrive at
vector LookAt = <1,1,1>; // which way they look at when arriving
//
default
{
  on_rez(integer start_param)
  {
    llResetScript();
  }
  changed(integer change) // something changed, take action
  {
    if(change & CHANGED_OWNER)
      llResetScript();
    else if (change & 256) // that bit is set during a region restart
      llResetScript();
  }
  state_entry()
  {
    llWhisper(0, "OS Teleportal Active");
  }
  touch_start(integer num_detected) 
  {
    key avatar = llDetectedKey(0);
    llInstantMessage(avatar, "Teleporting you to : "+Destination);
    osTeleportAgent(avatar, Destination, LandingPoint, LookAt); 
  }
}


Teleports an agent to the specified location. The first variant is able to teleport to any addressable region, including hypergrid destinations. The second variant teleports to a region in the local grid; the region coordinates are specified as region cells (not as global coordinates based on meters). The third variant teleports within the current region.

For osTeleportAgent() to work, the owner of the prim containing the script must be the same as the parcel that the avatar is currently on. If this isn't the case then the function fails silently.

See also osTeleportOwner.

Personal tools
General
About This Wiki