OsLocalTeleportAgent

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 40: Line 40:
 
The avatar must have rights to enter the target position.<br>
 
The avatar must have rights to enter the target position.<br>
 
The avatar must had granted PERMISSION_TELEPORT to the script or the owner of the prim containing the script must also be owner of the parcel where the avatar is currently on.<br>
 
The avatar must had granted PERMISSION_TELEPORT to the script or the owner of the prim containing the script must also be owner of the parcel where the avatar is currently on.<br>
−
The function will fails silently if conditions are not meet.<br>
+
The function will fail silently if conditions are not meet.<br>
 
<br>
 
<br>
 
- If newPosition is outside the region the target will be at nearest region border.<br>
 
- If newPosition is outside the region the target will be at nearest region border.<br>

Revision as of 14:16, 1 May 2019

Languages Languages: 

En.png English

void osLocalTeleportAgent(key agentID, vector newPosition, vector newVelocity, vector newLookat, integer optionFlags)

Caution ! still experimental, subject to changes

Teleports an avatar with uuid agentID to the specified newPosition within same region.
The avatar must have rights to enter the target position.
The avatar must had granted PERMISSION_TELEPORT to the script or the owner of the prim containing the script must also be owner of the parcel where the avatar is currently on.
The function will fail silently if conditions are not meet.

- If newPosition is outside the region the target will be at nearest region border.
- newVelocity, if selected in optionFlags bit 0, should set a avatar velocity, but may only work with ubOde Physics engine, even so results may be a bit unpredictable. It will stop if the avatar collides with anything at destination or if the user presses a movement key. It also has a strong drag. This behavior will need future changes.
- newLookAt, if selected in optionFlags bit 1, changes the camera look At direction. bit 2 can alternatively be used to align the look at to the velocity at arrival if this is not Zero. Final effect may depend on viewer and viewer camera state at teleport time (like camera attached to avatar or free)

- OptionFlags is a bit field:
bit 0 (mask 1): use newVelocity
bit 1 (mask 2): use newLookAt
bit 2 (mask 4): align lookat to velocity if it is not zero vector
bit 3 (mask 8): force fly
bit 4 (mask 16): force no fly

if both bits 1 and 2 are set bit 2 is ignored
if both bits 3 and 4 are set bit 4 is ignored

Threat Level None
Permissions see description
Extra Delay 0 seconds
Example(s) 
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 Local Teleport Active");
  }
  touch_start(integer num_detected) 
  {
    key avatar = llDetectedKey(0);
    llInstantMessage(avatar, "Teleporting you to : " + (string)LandingPoint);
    osLocalTeleportAgent(avatar, LandingPoint, ZEROVECTOR, <0,1,0>, 2); 
  }
}
Retrieved from "http://opensimulator.org/index.php?title=OsLocalTeleportAgent&oldid=47588"
Personal tools
General
About This Wiki