OsAvatarPlayAnimation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (some syntax modification (may be major or minor))
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{osslfunc
 
{{osslfunc
 
|threat_level=VeryHigh
 
|threat_level=VeryHigh
|function_syntax=void osAvatarPlayAnimation(key avatar, string animation)  
+
|permissions=false
 +
|delay=0
 +
|function_syntax= osAvatarPlayAnimation(key avatar, string animation)  
 
|ossl_example=<source lang="lsl">
 
|ossl_example=<source lang="lsl">
//Example Usage: default {
+
//
 +
// osResetAllScripts Script Example
 +
//
  
     touch_start(integer num) {
+
default
      string anim = llGetInventoryName(INVENTORY_ANIMATION, 0);
+
{
      osAvatarPlayAnimation(llDetectedKey(0), anim);
+
     touch_start(integer num)
  }
+
    {
 
+
        // Get the name of the animation from the prim's inventory
}  
+
        string anim = llGetInventoryName(INVENTORY_ANIMATION, 0);
 +
       
 +
        // Play the animation on the avatar who touched the object
 +
        osAvatarPlayAnimation(llDetectedKey(0), anim);
 +
    }
 +
}
 
</source>
 
</source>
 
|description=This function causes an animation to be played on the specified avatar.  
 
|description=This function causes an animation to be played on the specified avatar.  
  
The variable ''animation'' can be either the name of an animation within the task inventory, or it can be the UUID of an animation.  
+
The variable ''animation'' must be the name of an animation within the task inventory. For security reasons, UUIDs are not allowed here.
  
'''osAvatarPlayAnimation''' does not perform any security checks or request animation permissions from the targeted avatar,  
+
Instead of the name of an animation in the prim's inventory, you can also use the names of the viewer's [http://wiki.secondlife.com/wiki/Internal_Animations built-in animations].
 +
 
 +
'''osAvatarPlayAnimation''' does not perform any security checks or request animation permissions from the targeted avatar.
 +
 
 +
|additional_info= When using this function in an object that requires the user to sit on the object (like a chair,or a poseball), you will need to stop the sit animation by including the following snippet:
 +
<source lang = "lsl">
 +
changed(integer change)
 +
{
 +
    // Check if there's a change in the link set
 +
    if (change & CHANGED_LINK)
 +
    {
 +
        // Get the key of the user sitting on the object
 +
        key user = llAvatarOnSitTarget();
 +
       
 +
        // Stop the sit animation
 +
        osAvatarStopAnimation(user, "sit");
 +
       
 +
        // Play the desired animation on the user
 +
        osAvatarPlayAnimation(user, anim);
 +
    }
 +
}
 +
</source>
 
|
 
|
 
}}
 
}}
 +
== See Also ==
 +
* [[osAvatarPlayAnimation]]
 +
* [[osAvatarStopAnimation]]
 +
* [[OSSL_Script_Library/OSSL_Poseball|OSSL_Poseball script]]

Latest revision as of 01:00, 7 March 2024

osAvatarPlayAnimation(key avatar, string animation)
This function causes an animation to be played on the specified avatar.

The variable animation must be the name of an animation within the task inventory. For security reasons, UUIDs are not allowed here.

Instead of the name of an animation in the prim's inventory, you can also use the names of the viewer's built-in animations.

osAvatarPlayAnimation does not perform any security checks or request animation permissions from the targeted avatar.

Threat Level VeryHigh
Permissions Use of this function is always disabled by default
Extra Delay 0 seconds
Example(s)
//
// osResetAllScripts Script Example
//
 
default
{
    touch_start(integer num)
    {
        // Get the name of the animation from the prim's inventory
        string anim = llGetInventoryName(INVENTORY_ANIMATION, 0);
 
        // Play the animation on the avatar who touched the object
        osAvatarPlayAnimation(llDetectedKey(0), anim);
    }
}
Notes
When using this function in an object that requires the user to sit on the object (like a chair,or a poseball), you will need to stop the sit animation by including the following snippet:
changed(integer change)
{
    // Check if there's a change in the link set
    if (change & CHANGED_LINK)
    {
        // Get the key of the user sitting on the object
        key user = llAvatarOnSitTarget();
 
        // Stop the sit animation
        osAvatarStopAnimation(user, "sit");
 
        // Play the desired animation on the user
        osAvatarPlayAnimation(user, anim);
    }
}


[edit] See Also

Personal tools
General
About This Wiki