OsLocalTeleportAgent
From OpenSimulator
| (27 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{osslfunc | {{osslfunc | ||
| − | |threat_level= | + | |threat_level=None |
| − | |permissions= | + | |permissions=see description |
| − | |delay= | + | |delay=0 |
|additional_info= | |additional_info= | ||
| − | |function_syntax= | + | |function_syntax= osLocalTeleportAgent(key agentID, vector newPosition, vector newVelocity, vector newLookat, integer optionFlags) |
|ossl_example=<source lang="lsl"> | |ossl_example=<source lang="lsl"> | ||
vector LandingPoint = <128,128,50>; // X,Y,Z landing point for avatar to arrive at | vector LandingPoint = <128,128,50>; // X,Y,Z landing point for avatar to arrive at | ||
| − | vector LookAt = <1,1, | + | vector TPvel = <0,0,0>; |
| + | vector LookAt = <1,1,0>; // which way they look at when arriving | ||
| + | |||
// | // | ||
default | default | ||
{ | { | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
state_entry() | state_entry() | ||
{ | { | ||
| − | llWhisper(0, "OS | + | llWhisper(0, "OS Local Teleport Active"); |
} | } | ||
touch_start(integer num_detected) | touch_start(integer num_detected) | ||
| Line 30: | Line 21: | ||
key avatar = llDetectedKey(0); | key avatar = llDetectedKey(0); | ||
llInstantMessage(avatar, "Teleporting you to : " + (string)LandingPoint); | llInstantMessage(avatar, "Teleporting you to : " + (string)LandingPoint); | ||
| − | osLocalTeleportAgent(avatar, LandingPoint, | + | osLocalTeleportAgent(avatar, LandingPoint, TPvel, LookAt, OS_LTPAG_USELOOKAT | OS_LTPAG_FORCEFLY); |
} | } | ||
}</source> | }</source> | ||
|description= | |description= | ||
| − | + | Teleports an avatar with uuid agentID to the specified newPosition within same region.<br> | |
| − | + | It ignores region teleport settings like Telehub or landpoint<br> | |
| − | + | ||
| − | Teleports an avatar with uuid agentID to the specified newPosition within same region.<br> | + | |
| − | + | ||
<br> | <br> | ||
| − | If newPosition is outside the region the target will be at nearest region border.<br> | + | The avatar must have rights to enter the target position.<br> |
| − | newVelocity, if selected | + | The avatar must had granted PERMISSION_TELEPORT to the script or the owner of the prim containing the script is also be owner of the parcel where the avatar is currently on.<br> |
| + | The function will fail silently if conditions are not meet.<br> | ||
| + | <br> | ||
| + | - If newPosition is outside the region the target will be at nearest region border.<br> | ||
| + | - newVelocity, if selected with optionFlags bit 0 set, 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 fast decay. This behavior will need future changes. If bit 0 is not set, current velocity is kept<br> | ||
| + | |||
| + | - newLookAt, if selected with optionFlags bit 1 set, changes the avatar look at direction. | ||
| + | |||
| + | Bit 2 can alternatively be used to align the look at to the velocity, if that is not zero vector. | ||
| + | |||
| + | Camera direction will depend on viewer camera state at teleport time (like camera attached to avatar or free). | ||
| + | |||
| + | Look at is the direction the avatar head will face. Body will face close to that, depending on viewers. Look At Z component is zero. | ||
| + | If both bits are not set, the look at direction will be the current camera direction<br> | ||
| − | OptionFlags is a bit field:<br> | + | - OptionFlags is a bit field:<br> |
| − | bit 0 ( | + | bit 0 (OS_LTPAG_USEVEL): use newVelocity<br> |
| − | bit 1 ( | + | bit 1 (OS_LTPAG_USELOOKAT): use newLookAt<br> |
| − | bit 2 ( | + | bit 2 (OS_LTPAG_ALGNLV): align lookat to velocity if it is not zero vector<br> |
| − | bit 3 ( | + | bit 3 (OS_LTPAG_FORCEFLY): force fly.<br> |
| − | bit 4 ( | + | bit 4 (OS_LTPAG_FORCENOFLY): force no fly. Will not work if viewer has fly after teleport option set<br> |
<br> | <br> | ||
if both bits 1 and 2 are set bit 2 is ignored<br> | if both bits 1 and 2 are set bit 2 is ignored<br> | ||
Latest revision as of 17:38, 16 September 2021
 |
Languages: |
|
osLocalTeleportAgent(key agentID, vector newPosition, vector newVelocity, vector newLookat, integer optionFlags)
| |
| Teleports an avatar with uuid agentID to the specified newPosition within same region. It ignores region teleport settings like Telehub or landpoint It will stop if the avatar collides with anything at destination or if the user presses a movement key. It also has a fast decay. This behavior will need future changes. If bit 0 is not set, current velocity is kept - newLookAt, if selected with optionFlags bit 1 set, changes the avatar look at direction. Bit 2 can alternatively be used to align the look at to the velocity, if that is not zero vector. Camera direction will depend on viewer camera state at teleport time (like camera attached to avatar or free). Look at is the direction the avatar head will face. Body will face close to that, depending on viewers. Look At Z component is zero. If both bits are not set, the look at direction will be the current camera direction - OptionFlags is a bit field: | |
| 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 TPvel = <0,0,0>; vector LookAt = <1,1,0>; // which way they look at when arriving // default { 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, TPvel, LookAt, OS_LTPAG_USELOOKAT | OS_LTPAG_FORCEFLY); } } | |
