OsReplaceAgentEnvironment
From OpenSimulator
(Difference between revisions)
(Add of errors returned) |
m (Typo) |
||
Line 9: | Line 9: | ||
* if return value is negative, it failed. | * if return value is negative, it failed. | ||
* transition should be the viewer transition time to the new one. May not work on most viewers. | * transition should be the viewer transition time to the new one. May not work on most viewers. | ||
− | ''' The errors | + | ''' The errors returned are: ''' |
return 0 : Never 0 for now | return 0 : Never 0 for now | ||
return 1 : if daycycle applied with success | return 1 : if daycycle applied with success |
Revision as of 11:02, 21 December 2020
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
The errors returned are: return 0 : Never 0 for now return 1 : if daycycle applied with success return -1 : never -1 return -2 : no ossl rights return -3 : daycycle not found return -4 : agent not found return -5 : if fail to decode daycycle asset | |
Threat Level | Moderate |
Permissions | ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
Extra Delay | 0 seconds |
Example(s) | |
// // osReplaceAgentEnvironment Script Example // Author: djphil // // Can be asset's name in object's inventory or the asset uuid string daycycle_a = "Daycycle_A"; string daycycle_b = NULL_KEY; integer transition = 3; integer switch; default { state_entry() { llSay(PUBLIC_CHANNEL, "Touch to see osReplaceAgentEnvironment usage."); llSay(PUBLIC_CHANNEL, "Transition: " + (string)transition + " second(s)."); } touch_start(integer number) { key agentKey = llDetectedKey(0); if (llGetAgentSize(agentKey) != ZERO_VECTOR) { integer result; if (switch = !switch) { result = osReplaceAgentEnvironment(agentKey, transition, daycycle_a); llRegionSayTo(agentKey, PUBLIC_CHANNEL, "daycycle_a: " + daycycle_a); } else { result = osReplaceAgentEnvironment(agentKey, transition, daycycle_b); llRegionSayTo(agentKey, PUBLIC_CHANNEL, "daycycle_b: " + daycycle_b); } if (daycycle_a == "" || daycycle_a == NULL_KEY || daycycle_b == "" || daycycle_b == NULL_KEY) { llRegionSayTo(agentKey, PUBLIC_CHANNEL, "The normal environment for the parcel or region has been selected."); } if (result > 0) { llRegionSayTo(agentKey, PUBLIC_CHANNEL, "Agent environment replaced with success!"); } else if (result < 0) { llRegionSayTo(agentKey, PUBLIC_CHANNEL, "Agent environment replaced without success!"); } } else { llInstantMessage(agentKey, "You need to be in the same region to use this function ..."); } } } | |
Notes | |
This function was added in 0.9.2 |
See Also
- osReplaceAgentEnvironment
- osReplaceParcelEnvironment
- osReplaceRegionEnvironment
- osResetEnvironment