OsTeleportAgent

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (XEngine to OSSL)
(14 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{osslfunc|
+
{{osslfunc
threat_level = High
+
|threat_level=Severe
|
+
|permissions=${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
function_syntax = <source lang="lsl">
+
|delay=0.5
osTeleportAgent(key UUID, string regionName, vector position, vector lookAt)
+
|additional_info=
osTeleportAgent(key UUID, integer regionX, integer regionY, vector position, vector lookAt)
+
'''osTeleportAgent''' has a 0.5 second delay if the teleport is not allowed, or when the destination is to a location in the same region as the Agents current region.<br>
osTeleportAgent(key UUID, vector position, vector lookAt)
+
For teleports within region consider using [[osLocalTeleportAgent]]
</source>
+
|function_syntax= osTeleportAgent(key agent, integer regionX, integer regionY, vector position, vector lookat)<br />
|
+
osTeleportAgent(key agent, string regionName, vector position, vector lookat)<br />
ossl_example = <source lang="lsl">
+
osTeleportAgent(key agent, vector position, vector lookat)
 +
|ossl_example=<source lang="lsl">
 
// Example osTeleportAgent Script
 
// Example osTeleportAgent Script
 
//
 
//
Line 51: Line 52:
 
   }
 
   }
 
}</source>
 
}</source>
|  
+
|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.
additional_info = 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.
 
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]].
+
See also  [[osTeleportOwner]], and if you receive an error see [[OSSL Enabling Functions|how to enable OS functions]].
 
|
 
|
 
}}
 
}}

Revision as of 07:29, 7 November 2019

osTeleportAgent(key agent, integer regionX, integer regionY, vector position, vector lookat)

osTeleportAgent(key agent, string regionName, vector position, vector lookat)
osTeleportAgent(key agent, vector position, vector 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, and if you receive an error see how to enable OS functions.

Threat Level Severe
Permissions ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Extra Delay 0.5 seconds
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); 
  }
}
Notes
osTeleportAgent has a 0.5 second delay if the teleport is not allowed, or when the destination is to a location in the same region as the Agents current region.

For teleports within region consider using osLocalTeleportAgent

Personal tools
General
About This Wiki