OsAgentSaveAppearance

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
 
(8 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
|function_syntax=key osAgentSaveAppearance(key agentId, string notecard)<br>
 
|function_syntax=key osAgentSaveAppearance(key agentId, string notecard)<br>
 
key osAgentSaveAppearance(key agentId, string notecard, integer includeHuds)
 
key osAgentSaveAppearance(key agentId, string notecard, integer includeHuds)
 +
|description=Save an arbitrary avatar's appearance to a notecard in the prim's inventory.
 +
 +
This includes body part data, clothing items and attachments. If a notecard with the same name already exists then it is replaced.
 +
 +
The avatar must be present in the region when this function is invoked.
 +
 +
The baked textures for the avatar (necessary to recreate appearance on the NPC) are saved permanently.<br>
  
−
|description=Save an arbitrary avatar's appearance to a notecard in the prim's inventory. This includes body part data, clothing items and attachments. If a notecard with the same name already exists then it is replaced. The avatar must be present in the region when this function is invoked. The baked textures for the avatar (necessary to recreate appearance on the NPC) are saved permanently.<br>
 
 
The first variant will include HUDs, the second variant allows control that. incluceHuds  1 (TRUE) will include 0(FALSE) will not
 
The first variant will include HUDs, the second variant allows control that. incluceHuds  1 (TRUE) will include 0(FALSE) will not
 
|threat_level=VeryHigh
 
|threat_level=VeryHigh
Line 9: Line 15:
 
|delay=0
 
|delay=0
 
|ossl_example=
 
|ossl_example=
−
|additional_info=This function was added in 0.7.2-post-fixes, huds control  added in 0.9.2
 
 
|ossl_example=<source lang="lsl">
 
|ossl_example=<source lang="lsl">
 
//
 
//
 
// osAgentSaveAppearance Script Example
 
// osAgentSaveAppearance Script Example
−
// GPLv3 license attributed to the Wizardry and Steamworks group at http://was.fm/opensim:npc
+
// Author: djphil
−
// touch to save your XML to a notecard named appearance for use with NPC follower and NPC puppeteer script.
+
 
//
 
//
 
   
 
   
 
default
 
default
 
{
 
{
−
     touch_start(integer num)
+
     state_entry()
 
     {
 
     {
−
         osAgentSaveAppearance(llDetectedKey(0), "appearance");
+
         // Display a message prompting users to touch the object to see how osAgentSaveAppearance is used
 +
        llSay(PUBLIC_CHANNEL, "Touch to see osAgentSaveAppearance usage.");
 +
    }
 +
 
 +
    touch_start(integer number)
 +
    {
 +
        // Get the key of the avatar who touched the object
 +
        key toucher = llDetectedKey(0);
 +
 
 +
        // Check if the avatar's size is not zero vector (i.e., if the avatar is present in the same region)
 +
        if (llGetAgentSize(toucher) != ZERO_VECTOR)
 +
        {
 +
            // Attempt to save the avatar's appearance to a notecard using osAgentSaveAppearance
 +
            key result = osAgentSaveAppearance(toucher, (string)toucher);
 +
 
 +
            // Check if the result is successful
 +
            if (result && result != NULL_KEY)
 +
            {
 +
                llSay(PUBLIC_CHANNEL, "Notecard \"" + (string)toucher + "\" saved with success.");
 +
            }
 +
            else
 +
            {
 +
                llSay(PUBLIC_CHANNEL, "Notecard \"" + (string)toucher + "\" saved without success.");
 +
            }
 +
        }
 +
        else
 +
        {
 +
            // Send an instant message to the avatar indicating that they need to be in the same region to use the function
 +
            llInstantMessage(toucher, "You need to be in the same region to use this function ...");
 +
        }
 
     }
 
     }
 
}
 
}
 
</source>
 
</source>
 +
'''And with "includeHuds"'''
 +
<source lang="lsl">
 +
//
 +
// osAgentSaveAppearance (with option) Script Example
 +
// Author: djphil
 +
//
 +
 +
// Define a variable to specify whether to include HUD attachments in appearance save
 +
integer includeHuds = TRUE;
 +
 +
default
 +
{
 +
    state_entry()
 +
    {
 +
        // Display a message prompting users to touch the object to see how osAgentSaveAppearance is used with an option
 +
        llSay(PUBLIC_CHANNEL, "Touch to see osAgentSaveAppearance (with option) usage.");
 +
    }
 +
 +
    touch_start(integer number)
 +
    {
 +
        // Get the key of the avatar who touched the object
 +
        key toucher = llDetectedKey(0);
 +
 +
        // Check if the avatar's size is not zero vector (i.e., if the avatar is present in the same region)
 +
        if (llGetAgentSize(toucher) != ZERO_VECTOR)
 +
        {
 +
            key result;
 +
 +
            // Check the includeHuds variable to determine whether to include HUD attachments in appearance save
 +
            if (includeHuds == TRUE)
 +
            {
 +
                result = osAgentSaveAppearance(toucher, (string)toucher, TRUE);
 +
            }
 +
            else
 +
            {
 +
                result = osAgentSaveAppearance(toucher, (string)toucher, FALSE);
 +
            }
 +
 +
            // Check if the result is successful
 +
            if (result && result != NULL_KEY)
 +
            {
 +
                llSay(PUBLIC_CHANNEL, "Notecard \"" + (string)toucher + "\" saved with success.");
 +
            }
 +
            else
 +
            {
 +
                llSay(PUBLIC_CHANNEL, "Notecard \"" + (string)toucher + "\" saved without success.");
 +
            }
 +
        }
 +
        else
 +
        {
 +
            // Send an instant message to the avatar indicating that they need to be in the same region to use the function
 +
            llInstantMessage(toucher, "You need to be in the same region to use this function ...");
 +
        }
 +
    }
 +
}
 +
</source>
 +
|additional_info=This function was added in 0.7.2-post-fixes, huds control  added in 0.9.2
 
}}
 
}}
 +
== See Also ==
 +
* [[osNpcLoadAppearance]]
 +
* [[osNpcSaveAppearance]]
 +
* [[osAgentSaveAppearance]]

Latest revision as of 00:56, 7 March 2024

Languages Languages: 

En.png English

key osAgentSaveAppearance(key agentId, string notecard)

key osAgentSaveAppearance(key agentId, string notecard, integer includeHuds)

Save an arbitrary avatar's appearance to a notecard in the prim's inventory.

This includes body part data, clothing items and attachments. If a notecard with the same name already exists then it is replaced.

The avatar must be present in the region when this function is invoked.

The baked textures for the avatar (necessary to recreate appearance on the NPC) are saved permanently.

The first variant will include HUDs, the second variant allows control that. incluceHuds 1 (TRUE) will include 0(FALSE) will not

Threat Level VeryHigh
Permissions ESTATE_MANAGER,ESTATE_OWNER
Extra Delay 0 seconds
Example(s) 
//
// osAgentSaveAppearance Script Example
// Author: djphil
//
 
default
{
    state_entry()
    {
        // Display a message prompting users to touch the object to see how osAgentSaveAppearance is used
        llSay(PUBLIC_CHANNEL, "Touch to see osAgentSaveAppearance usage.");
    }
 
    touch_start(integer number)
    {
        // Get the key of the avatar who touched the object
        key toucher = llDetectedKey(0);
 
        // Check if the avatar's size is not zero vector (i.e., if the avatar is present in the same region)
        if (llGetAgentSize(toucher) != ZERO_VECTOR)
        {
            // Attempt to save the avatar's appearance to a notecard using osAgentSaveAppearance
            key result = osAgentSaveAppearance(toucher, (string)toucher);
 
            // Check if the result is successful
            if (result && result != NULL_KEY)
            {
                llSay(PUBLIC_CHANNEL, "Notecard \"" + (string)toucher + "\" saved with success.");
            }
            else
            {
                llSay(PUBLIC_CHANNEL, "Notecard \"" + (string)toucher + "\" saved without success.");
            }
        }
        else
        {
            // Send an instant message to the avatar indicating that they need to be in the same region to use the function
            llInstantMessage(toucher, "You need to be in the same region to use this function ...");
        }
    }
}

And with "includeHuds" 

//
// osAgentSaveAppearance (with option) Script Example
// Author: djphil
//
 
// Define a variable to specify whether to include HUD attachments in appearance save
integer includeHuds = TRUE;
 
default
{
    state_entry()
    {
        // Display a message prompting users to touch the object to see how osAgentSaveAppearance is used with an option
        llSay(PUBLIC_CHANNEL, "Touch to see osAgentSaveAppearance (with option) usage.");
    }
 
    touch_start(integer number)
    {
        // Get the key of the avatar who touched the object
        key toucher = llDetectedKey(0);
 
        // Check if the avatar's size is not zero vector (i.e., if the avatar is present in the same region)
        if (llGetAgentSize(toucher) != ZERO_VECTOR)
        {
            key result;
 
            // Check the includeHuds variable to determine whether to include HUD attachments in appearance save
            if (includeHuds == TRUE)
            {
                result = osAgentSaveAppearance(toucher, (string)toucher, TRUE);
            }
            else
            {
                result = osAgentSaveAppearance(toucher, (string)toucher, FALSE);
            }
 
            // Check if the result is successful
            if (result && result != NULL_KEY)
            {
                llSay(PUBLIC_CHANNEL, "Notecard \"" + (string)toucher + "\" saved with success.");
            }
            else
            {
                llSay(PUBLIC_CHANNEL, "Notecard \"" + (string)toucher + "\" saved without success.");
            }
        }
        else
        {
            // Send an instant message to the avatar indicating that they need to be in the same region to use the function
            llInstantMessage(toucher, "You need to be in the same region to use this function ...");
        }
    }
}
Notes
This function was added in 0.7.2-post-fixes, huds control added in 0.9.2


[edit] See Also

Retrieved from "http://opensimulator.org/index.php?title=OsAgentSaveAppearance&oldid=54066"
Personal tools
General
About This Wiki