OsReplaceAgentEnvironment

From OpenSimulator

Revision as of 15:55, 24 November 2020 by Djphil (Talk | contribs)

Jump to: navigation, search
integer osReplaceAgentEnvironment(key agentKey, integer transition, string daycycle)
Forces a dayclycle on a agent. Will do nothing if the agent is using a viewer local environment
  • If parameter daycycle is NULL_KEY or "", agent will see normal environment for parcel or region,
  • daycycle can be a name of a daycycle asset on prim contents. If it is a UUID it can also be grid asset.
  • if return value is negative, it failed.
  • transition should be the viewer transition time to the new one. May not work on most viewers.
Threat Level Moderate
Permissions ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Extra Delay 0 seconds
Example(s)
//
// osReplaceAgentEnvironment Script Example
//
 
// Can be asset's name in object's inventory or the asset uuid
string daycycle_a = "A-12AM";
string daycycle_b = NULL_KEY;
integer transition = 3;
integer switch;
 
default
{
    state_entry()
    {
        llSay(PUBLIC_CHANNEL, "Touch to see osReplaceAgentEnvironment usage.");
    }
 
    touch_start(integer number)
    {
        key agentKey = llDetectedKey(0);
 
        llSay(PUBLIC_CHANNEL, "agentKey: " + (string)agentKey);
        llSay(PUBLIC_CHANNEL, "transition: " + (string)transition);
 
        if (switch =! switch)
        {
            osReplaceAgentEnvironment(agentKey, transition, daycycle_a);
            llSay(PUBLIC_CHANNEL, "daycycle_a: " + daycycle_a);
        }
 
        else
        {
            osReplaceAgentEnvironment(agentKey, transition, daycycle_b);
            llSay(PUBLIC_CHANNEL, "daycycle_b: " + daycycle_b);
        }
    }
}
//
// osReplaceAgentEnvironment Script Example
//
 
// Can be asset's name in object's inventory or the asset uuid
string daycycle = "A-12AM";
integer transition = 3;
 
default
{
    state_entry()
    {
        llSay(PUBLIC_CHANNEL, "Touch to see osReplaceAgentEnvironment usage.");
    }
 
    touch_start(integer number)
    {
        key agentKey = llDetectedKey(0);
 
        if (llGetAgentSize(agentKey) != ZERO_VECTOR)
        {
            integer result = osReplaceAgentEnvironment(agentKey, transition, daycycle);
 
            if (result == 1)
            {
                llRegionSayTo(agentKey, PUBLIC_CHANNEL, "Applying environment for " + osKey2Name(agentKey));
            }
 
            else
            {
                llRegionSayTo(agentKey, PUBLIC_CHANNEL, "Cannot apply environment for " + osKey2Name(agentKey) + " due to reason id : " + (string)result);
            }
        }
 
        else
        {
            llRegionSayTo(agentKey, PUBLIC_CHANNEL, "You need to be in the same region to change environment.");
        }
    }
}
Notes
This function was added in 0.9.2
Personal tools
General
About This Wiki