OpenSimulator - User contributions [en]

NPC Automator 2.0

2013-02-01T01:36:26Z

Nihlaeth: Created page with "==Instruction Notecard== For this script to work, ossl must be enabled with a threat level of VeryHigh. NPCAutomator uses it's own kind of very simple script. All the commands a..."

==Instruction Notecard==
For this script to work, ossl must be enabled with a threat level of VeryHigh.

NPCAutomator uses it's own kind of very simple script. All the commands are in the form of:

===Rules===
*Command|optionalvalue|optionalvalue|
*Empty fields are maked by a "#" sign.
*Commands are not case sensitive.
*Spaces do matter! Do not use whitespace in commands or values that are not mean as text.

===Commands===
*NpcCreate|Test Npc|<1,1,1>| This creates an npc named Test NPC at 1,1,1 (relative to object position).
*Wait|5|#| This makes the script sleep for 5 seconds. Build in waits at regular intervals to prevent flooding and make the npc come over more natural.
*GotoLine|4|#| This makes the script continue at the specified line number. The first line is 0. You can also replace the number with a label name.
*NpcFlyTo|<128,128,128>|#| This makes your npc fly to these coordinates (these are region coords).
*NpcMoveTo|<128,128,22>|#| Same as NpcFlyTo, but walking.
*NpcSetRot|Random|#| Sets a timer that changes npc rotation to random angles at a set interval.
*NpcPlayAnimation|animationname|#| Plays an animation (has to be present in prim inventory).
*NpcStopAnimation|animationname|#| Stops the animation.
*NpcSay|Hey! I'm an npc :)|#| Makes the npc say stuff.
*NpcSit|objectkey|#| Makes the npc sit on object.
*NpcDelete|#|#| Remove the NPC.
*GreetStrangerFirst|Hey, |#| Message that is said before avatar name when meeting someone new.
*GreetStrangerLast|. Nice meeting you.|#| Message that is said after the avatar name when meeting someone new.
*GreetAquaintanceFirst|Hey, |#| Message that is said before avatar name when running into an aquaintance.
*GreetAquaintanceLast|. Good to see you again!|#| Message that is said after avatar name when running into an aquaintance.
*AddTrigger|Help|15| A trigger is a word that triggers a reaction in the npc. In this case, when someone says the word help, the code jumps to line 14. Instead of a line number you can also specify a label name.
*RemoveTrigger|Help|#| Removes a trigger word.
*GotoTrigger|#|#| This command makes the code check if a trigger word has been said and then jumps to the right line. The code waits for this command to make sure it doesn't skip lines that are important. So don't forget to include this.
*Label|Labelnaam|#| A label is a fixed point in the notecard that you can refer to so you don't have to keep counting lines.

===Example===
The notecard HAS to be named "-NPC AI". It's case sensitive.
<nowiki>NpcCreate|Test NPC|<1, 1,1>|#|
GreetAquaintanceFirst|You again! What are you doing here, |#|
GreetAquaintanceLast|?|#|
AddTrigger|help|help|
GOTOLINE|loop|#|
Label|help|#|
NpcSay|Do you want me te help you?|#|
AddTrigger|yes|yes|
GOTOLINE|loop|#|
Label|yes|#|
NpcSay|Sorry, I don't think I'm the right person for the job.|#|
RemoveTrigger|yes|#|
GOTOLINE|loop|#|
Label|loop|
WAIT|1|#|
GOTOTrigger|#|#|
NpcMoveTo|<112,112,22>|#|
GOTOTrigger|#|#|
WAIT|3|#|
GOTOTrigger|#|#|
NpcMoveTo|<109,112,22>|#|
GOTOTrigger|#|#|
GOTOLINE|loop|#|</nowiki>

===Planned===
*NpcStandUp
*NpcLookAt
*NpcAttach
*SaveAppearance
*Revising way notecards are accessed, dataserver event has to go.

==Commands==
You can issue commands to the script directly too. I did however not revise this functionality and can't say if it works or not. For instructions, you'll have to read the script.

==NPC Automator 2.0 script==
You don't need to change a thing about this script. Just put it in a prim together with the instruction notecard and maybe an appearance notecard and you're done.
<source lang = "lsl">
debug(string str)
{
if(debugger)
{
llOwnerSay(str);
}
}

list tempdata;
vector offset = <0,0,0>;
integer rezcount= 0;
integer debugger= FALSE;
integer rand= FALSE;
key npc = NULL_KEY;
string npcfirstname ;
string npclastname;
vector npcrezpos = <202,119,25>;
string detectname = "NPC Name";
integer channel = 77;
integer line;
float delay = 1;
string config = "-NPC AI";
key readLineId;
string NpcCommand;
string NpcValue;
string command;
string value ="value";
string extra="extra";
string aq;
list greet;
list aqaintance;
string hiufirst="Hello, ";
string hiulast=". Nice to meet you!";
string hikfirst="Good to see you again, ";
string hiklast=".";
list triggers;
list goto;
list gotoqueue;
list labels;
list labelpos;

ResetScript()
{
//llResetScript()
tempdata =[];
npcfirstname = "";
npclastname = "";
rezcount=0;
npc = "";
line = 0;
triggers=[];
goto=[];
gotoqueue=[];
greet=[];
labels=[];
labelpos=[];
init();
state default;
}

integer get_aqaintance(string name)
{
if(llListFindList(aqaintance,[name])<0){return 0;}
else{return 1;}
}

set_aqaintance(string name)
{
string aq=osGetNotecard("Aqaintances");
aq+=","+name;
aqaintance=llCSV2List(aq);
llRemoveInventory("Aqaintances");
osMakeNotecard("Aqaintances",[aq]);
}

init_labels()
{
debug("Starting label initialization");
integer i=0;
string templine;
while (templine != EOF) {
templine=osGetNotecardLine(config,i);
debug("Reading line: " + templine);
list templist = llParseString2List(templine,["|"],[]);
string tempcommand = llToLower(llList2String(templist,0));
string tempvalue = llList2String(templist,1);
if(tempcommand=="label")
{
labels=labels + [(string)tempvalue];
labelpos=labelpos + [(integer)i];
debug("Added label " + tempvalue + " to labels.");
}
i++;
}
}

integer label2line(string lblname)
{
integer tmppos=llListFindList(labels, llToLower(lblname));
if(tmppos<0)
{
debug("label " + lblname + "not found, return to line 0");
return 0;
}
else{
return llList2Integer(labelpos, tmppos);
}
}

integer IsInteger(string var)
{
integer i;
for (i=0;i<llStringLength(var);++i)
{
if(!~llListFindList(["1","2","3","4","5","6","7","8","9","0"],[llGetSubString(var,i,i)]))
{
return FALSE;
}
}
return TRUE;
}

init()
{
init_labels();
//read aquaintances notecard
aq=osGetNotecard("Aqaintances");
aqaintance=llCSV2List(aq);
llSensorRepeat("",NULL_KEY,AGENT,30.0,PI,15);

// reset configuration values to default
NpcCommand = "Unknown";
NpcValue = "None";

// make sure the file exists and is a notecard
if(llGetInventoryType(config) != INVENTORY_NOTECARD)
{
// notify owner of missing file
debug("Missing inventory notecard: " + config);
return; // don't do anything else
}

// initialize to start reading from first line
line = 0;

// read the first line
readLineId = llGetNotecardLine(config, line++);

}
processConfiguration(string data)
{
// if we are at the end of the file
if(data == EOF)
{
// notify the owner
debug("We are done reading the configuration");
// reset
line=0;
}

// if we are not working with a blank line
if(data != "")
{
// if the line does not begin with a comment
if(llSubStringIndex(data, "#") != 0)
{
// find first pipe "|" and smoke it
integer i = llSubStringIndex(data, "|");

// if line contains equal sign
if(i != -1)
{
tempdata = llParseString2List(data,["|"],[]);
command = llToLower(llList2String(tempdata,0));
value = llList2String(tempdata,1);
extra = llDumpList2String(llList2List(tempdata,2,-1)," ");

debug( " Command " +command + " Value " + value + " Extra " +extra);
if(command == "npccreate" && value !="" )
{
//NpcCommand = value;
list tempname = llParseString2List(value,[" "],[]);
string fname = llList2String(tempname,0);
string lname = llList2String(tempname,1);
npcfirstname = (string)fname;
npclastname = (string)lname;
offset = (vector)extra;
if (CardExists(npcfirstname + "_" + npclastname))
{
debug("A saved appearance for " + npcfirstname + " " + npclastname + " was found.");
npc = osNpcCreate(npcfirstname, npclastname, llGetPos()+offset, npcfirstname + "_" + npclastname);
lognpc(npc);
debug("Created NPC " + (string)npc + " with the name " + npcfirstname + " " + npclastname + ".");

}
else{
debug("No appearance for " + npcfirstname + " " + npclastname + " found. Copying your appearance.");
osOwnerSaveAppearance(npcfirstname + "_" + npclastname);
npc = osNpcCreate(npcfirstname, npclastname, llGetPos()+offset, npcfirstname + "_" + npclastname);
lognpc(npc);
debug("Created NPC " + (string)npc + " with the name " + npcfirstname + " " + npclastname + "." +(string)npcrezpos);
debug( "Created " + npcfirstname + "_" + npclastname + " @ " +extra);
// color
}
}
else if(command == "wait")
{
llSetTimerEvent((float)value);
debug( "wait " + value);
}
else if(command == "gotoline")
{
if(IsInteger(value))
{
line = (integer)value;
}
else{
line = label2line(value);
}
debug( "go to line " + value);
}
else if(command == "npcflyto")
{
osNpcMoveToTarget(npc, (vector)value, OS_NPC_FLY);
debug( "move to " + value);
}
else if(command == "npcmoveto")
{
osNpcMoveToTarget(npc, (vector)value, OS_NPC_NO_FLY);
debug( "move to " + value + " " +extra);
}
else if(command == "npcsetrot")
{
if(value == llToLower("set"))
{
rand = FALSE;
debug( "No Rotaion Timer");
}
else if(value == llToLower("random"))
{
rand = TRUE;
debug( "Random rotation set every timer");
}
}
else if(command == "npcplayanimation")
{
osNpcPlayAnimation(npc, value);
debug( "animate " + value);
}
else if(command == "npcstopanimation")
{
osNpcStopAnimation(npc, value);
debug( "stop animate " + value);
}
else if(command == "npcsay")
{
osNpcSay(npc, value);
//debug( "stop animate " + value);
}
else if(command == "wait")
{
delay = (float)value;
debug( " setimer " + value);
}
else if(command == "npcsit")
{
osNpcSit(npc,(key)value,1);
}
else if(command == "npcdelete")
{
NpcDelete();
}
else if(command == "greetstrangerfirst")
{
hiufirst=value;
}
else if(command == "greetstrangerlast")
{
hiulast=value;
}
else if(command == "greetaquaintancefirst")
{
hikfirst=value;
}
else if(command == "greetaquaintancelast")
{
hiklast=value;
}
else if(command == "addtrigger")
{
integer tmpline;
triggers=triggers + [llToLower(value)];
if(IsInteger(extra))
{
tmpline = (integer)extra;
}
else{
tmpline = label2line(extra);
}
goto=goto + [(integer)tmpline];
debug("Added trigger \"" + value + " with goto value of " + extra + ".");
}
else if(command == "removetrigger")
{
integer pos=llListFindList(triggers,llToLower(value));
if(pos<0){debug("Trigger not found");}
else{
triggers=llDeleteSubList(triggers,pos,pos);
goto=llDeleteSubList(goto,pos,pos);
debug("Deleted trigger with value \"" + value);
}
}
else if(command == "gototrigger")
{
integer length=llGetListLength(gotoqueue);
if(length>0)
{
integer goto=llList2Integer(gotoqueue, 0);
line = goto;
gotoqueue=llDeleteSubList(gotoqueue,0,0);
debug( "loops back to line " + goto);
}
}
else if(command == "label")
{
debug("Now at label " + value);
}
// unknown name osNpcSit(npc,"bca94960-4fd9-4512-85e1-fd7faf130aba",1);
else{
//debug("Unknown configuration value: " + name + " on line " + (string)line);
}
}
else // line does not contain equal sign
{
debug("Configuration could not be read on line " + (string)line);
}
}
}
// read the next line
// readLineId = llGetNotecardLine(config, line++);
}

// Enter multiple NPCs into a list just incase of name change, Send linked message to other script(s) if needed
lognpc(key npcl)
{
llSetObjectDesc(npc);
dead = FALSE;
integer i;
for (i=0;i<rezcount;i++)
{
npc = osNpcCreate(npcfirstname, npclastname + " " + (string)i, llGetPos()+offset, npcfirstname + "_" + npclastname);
llMessageLinked(LINK_THIS,-5,"npcid",npc);
}
}

integer CardExists(string cardname)
{
if (llGetInventoryType(cardname) == INVENTORY_NONE)
{
return FALSE;
}
else{
return TRUE;
}
}

NpcCreate(list cmdline, integer cmdlength)
{
// Create a new NPC. Use an existing appearance if a
// notecard matching the given name exists, otherwise
// use the creator's appearance.
if (npc != NULL_KEY)
{
debug(llGetObjectName() + " thinks you still have an active NPC. Either delete that NPC, use the clearid command, or reset the scripts in " + llGetObjectName() + ".");
return;
}
if (cmdlength != 3)
{
debug("Command usage: create <firstname> <lastName>");
return;
}
npcfirstname = llList2String(cmdline, 1);
npclastname = llList2String(cmdline, 2);
if (CardExists(npcfirstname + "_" + npclastname))
{
debug("A saved appearance for " + npcfirstname + " " + npclastname + " was found.");
npc = osNpcCreate(npcfirstname, npclastname, llGetPos()+offset, npcfirstname + "_" + npclastname);
lognpc(npc);
debug("Created NPC " + (string)npc + " with the name " + npcfirstname + " " + npclastname + ".");
}
else{
debug("No appearance for " + npcfirstname + " " + npclastname + " found. Copying your appearance.");
osOwnerSaveAppearance(npcfirstname + "_" + npclastname);
npc = osNpcCreate(npcfirstname, npclastname, llGetPos()+offset, npcfirstname + "_" + npclastname);
lognpc(npc);
debug("Created NPC " + (string)npc + " with the name " + npcfirstname + " " + npclastname + ".");
return;
}
}

NpcSave(list cmdline, integer cmdlength)
{
// Save the NPC's current appearance to a notecare. Accepts a
// notecard name as an optional parameter. Card name will be
// the NPC's name if not specified, i.e.: John_Smith

if (npc == NULL_KEY)
{
debug("Can't save appearance because no NPC has been created. Create an NPC, or use setid to specify a rezzed NPC.");
return;
}
if (cmdlength = 1)
{
osNpcSaveAppearance(npc, npcfirstname + "_" + npclastname);
debug("NPC appearance saved as: " + npcfirstname + "_" + npclastname);
return;
}
else if (cmdlength = 2)
{
osNpcSaveAppearance(npc, llList2String(cmdline, 1));
debug("NPC appearance saved as: " + llList2String(cmdline, 1));
return;
}
else{
debug("Command usage: save [<cardname>]");
return;
}
}

NpcLoad(list cmdline, integer cmdlength)
{
// Load an appearance from a notecard, and apply it to the NPC.
if (npc == NULL_KEY)
{
debug("Cannot load an appearance because there is no NPC. Either create one, or assign the UUID of an existing NPC with setid.");
return;
}
if (cmdlength == 1)
{
// No appearance was specified, so use the notecard created when the
// NPC was created.
if (CardExists("Test_NPC"))
{
osNpcLoadAppearance(npc, "Test_NPC");
debug("Default appearance loaded.");
return;
}
else{
debug("Cannot load an appearance. No NPC may have been created yet.");
return;
}
return;
}
else if (cmdlength == 2)
{
// Attempt to load an appearance notecard from a specified notecard.
string cardname = llList2String(cmdline, 1);
if (CardExists(cardname))
{
osNpcLoadAppearance(npc, cardname);
debug("NPC appearance loaded from the notecard " + cardname + ".");
return;
}
else{
debug("The notecard " + cardname + " was not found.");
return;
}
return;
}
else if (cmdlength == 3)
{
// Attempt to load an appearance notcard associated with provided NPC name.
string cardname = llList2String(cmdline, 1) + "_" + llList2String(cmdline, 2);
if(CardExists(cardname))
{
osNpcLoadAppearance(npc, cardname);
debug("Loaded the stored appearance for " + llList2String(cmdline,1) + " " + llList2String(cmdline, 2) + ".");
return;
}
else{
debug("Cannot load the requested appearance. No notecard associated with " + llList2String(cmdline, 1) + " " + llList2String(cmdline, 2) + " was found.");
return;
}
return;
}
else{
debug("Command usage: load [<cardname> | <firstname> <lastname>]");
}
}

NpcDelete()
{
// Derez the NPC and clear associated info.
if (npc == NULL_KEY)
{
debug("Can't delete because no NPC has been created. Create an NPC, or use setid to specify a rezzed NPC.");
return;
}
string name = llKey2Name(npc);
osNpcRemove(npc);
npc = NULL_KEY;
dead = TRUE;
llSetObjectDesc(NULL_KEY);
// npcfirstname = "";
//npclastname = "";
debug("Deleted the NPC named " + name + ".");
}

NpcCopy()
{
// Copy the appearance of the user to the NPC, and save it to a default
// notecard named Test_NPC.
if (npc == NULL_KEY)
{
debug("Cannot copy your appearance to the NPC because no NPC exists. Either create one, or assign the UUID of an existing NPC with setid.");
return;
}
osOwnerSaveAppearance("Test_NPC");
osNpcLoadAppearance(npc, "Test_NPC");
debug("Your appearance has been saved to the NPC.");
return;
}

NpcSetUUID(list cmdline, integer cmdlength)
{
// Assign currently active agent UUID.
if (cmdlength < 2 || cmdlength > 3)
{
debug("Command usage: setid <UUID>");
debug("Command usage: setid <firstname> <lastname>");
return;
}
key newUUID = llList2Key(cmdline, 1);
string name = llKey2Name(newUUID);
if (cmdlength == 2)
{
if (name != "")
{
// Set the active NPC UUID to the one provided.
debug("This UUID matches the entity named " + name + ".");
npc = newUUID;
llSetObjectDesc(newUUID);
list namelist = llParseString2List(name, [" "], []);
npcfirstname = llList2String(namelist, 0);
npclastname = llList2String(namelist, 1);
debug("The NPC's UUID is now " + npc + ".");
return;
}
else{
debug("No existing NPC was found for this UUID.");
return;
}
}
if (cmdlength = 3)
{
// Attempt to detect and assign the NPC UUID by detecting it from
// a provided agent name.
detectname = llList2String(cmdline, 1) + " " + llList2String(cmdline, 2);
state DetectAgent;
}
}

CommandExec(list cmdline)
{
// Commands are interpreted and executed in this function.
string cmd = llToLower(llList2String(cmdline, 0));
integer cmdlength = llGetListLength(cmdline);
if (cmd == "create")
{
rezcount=0;
NpcCreate(cmdline, cmdlength);
return;
}
else if (cmd == "setupnpc")
{
npc = osNpcCreate(npcfirstname, npclastname, llGetPos() + <0, 1, 0>, "Test_NPC");
lognpc(npc);
return;
}
else if (cmd == "save")
{
NpcSave(cmdline, cmdlength);
return;
}
else if (cmd == "load")
{
NpcLoad(cmdline, cmdlength);
return;
}
else if (cmd == "delete")
{
NpcDelete();
return;
}
else if (cmd == "copy")
{
NpcCopy();
return;
}
else if (cmd == "setid")
{
NpcSetUUID(cmdline, cmdlength);
return;
}
else if (cmd == "getid")
{
debug("Current NPC is " + npcfirstname + " " + npclastname + ", with the UUID: " + (string)npc);
return;
}
else if (cmd == "clearid")
{
npc = NULL_KEY;
llSetObjectDesc(NULL_KEY);
debug("NPC UUID has been set to NULL_KEY.");
return;
}
else if (cmd == "help")
{
CommandHelp(cmdline);
return;
}
else if (cmd == "test")
{
string s = llKey2Name(npc);
debug(s);
}
else{
debug("Unknown command: " + llDumpList2String(cmdline, " "));
debug("Use the help command for a list of commands.");
}
}

CommandHelp(list cmdline)
{
// This function provides command instructions and usage information.
string cmd = llList2String(cmdline, 0);
integer cmdlength = llGetListLength(cmdline);
if (cmdlength == 1)
{
debug("The following commands are available:");
debug("\thelp \tcreate \tsave \tload \tdelete");
debug("\tcopy \tsetid \tgetid \tclearid");
debug("Use \"help <command>\" to get more information on an item in the list.");
return;
}
else if (cmdlength == 2)
{
string param = llList2String(cmdline, 1);
if (param == "save")
{
debug("The save command saves the current appearance of the NPC to a notecard. If no notecard name is specified, the name is set to the first and last names of the NPC, seperated by an underscore.");
debug("Command usage: save [<cardname>]");
debug("Example: save John_Smith");
return;
}
if (param == "load")
{
debug("The load command saves the current appearance of the NPC to a notecard. When not given an parameters, it attempts to load the card created when the NPC was created. It will also attempt to load any notecard when a name is spefified. Finally, it will try to load a notecard named after an NPC.");
debug("Command usage: load [<cardname> | <firstname> <lastname>]");
debug("Example: load");
debug("Example: load mynotecard");
debug("Example: load John Smith");
return;
}
else if (param == "delete")
{
debug("The delete command removes the current NPC from the scene.");
debug("Command usage: delete");
return;
}
else if (param == "create")
{
debug("The create command creates a new NPC. If it does not find a previously stored appearance for the given NPC name, it copies the appearance of its creator. All subsequent commands will be applied to this new NPC.");
debug("Command usage: create <firstname> <lastName>");
debug("Example: create John Smith");
return;
}
else if (param == "copy")
{
debug("The copy command makes a copy of the user's appearance, and applies it to the NPC.");
debug("Command usage: copy");
return;
}
else if (param == "setid")
{
debug("The setid command tells " + llGetObjectName() + " which NPC it is working with. Can be provided with an explicit UUID, or given a first and last name from which it will attempt to detect the UUID.");
debug("Command usage: setid <UUID>");
debug("Command usage: setid <firstname> <lastname>");
debug("Example: setid e254e947-65d0-4bc8-b70a-6e6c05bf0535");
return;
}
else if (param == "getid")
{
debug("The getid command retrieves and displays the UUID for the current active NPC.");
debug("Command usage: getid");
return;
}
else if (param == "clearid")
{
debug("The clearid command sets the NPC's UUID to NULL_KEY.");
debug("Command usage: clearid");
return;
}
else if (param == "help")
{
debug("Please see the help command.");
debug("Command usage: help");
return;
}
}
else{
debug("Command usage: help [<command>]");
return;
}
}

integer anim = FALSE;
integer dead = TRUE;

default
{
on_rez(integer start_param)
{
ResetScript();
}
changed(integer change)
{
if(change & CHANGED_INVENTORY)
{
NpcDelete();
llSleep(3);
ResetScript();
}
else if(change & CHANGED_OWNER)
{
ResetScript();
}
}
state_entry()
{
llListen(channel, "", NULL_KEY, "");
llListen(0,"",NULL_KEY,"");
init();
llSetObjectDesc(NULL_KEY);
//llSensor("", NULL_KEY, AGENT, 4.0, PI);
debug(llGetObjectName() + " started on channel " + (string)channel + ".");
debug("Use the help command to get started.");
debug("Example: /" + (string)channel + " help");
anim = FALSE;
llSetTimerEvent(1);
debug("RUNNING");
}
timer()
{
if ((llKey2Name(npc) == "" && (dead != TRUE)))
{
ResetScript();
}
else{
// osNpcPlayAnimation(npc, "Hello";
if(rand)
{
osNpcSetRot(npc, llGetRot() * (llEuler2Rot(<0, 0, llFrand(360)> * DEG_TO_RAD))); // Setting Random Rotation every wait
}
readLineId = llGetNotecardLine(config, line++);
}
llSetTimerEvent(delay);
}
dataserver(key request_id, string data)
{
if(request_id == readLineId)
{
processConfiguration(data);
}
}
listen(integer chan, string name, key id, string msg)
{
if(chan==channel)
{
if (msg == "" ) { return; }
if (id != llGetOwner())
{
// llSay(0, "Only the owner of " + llGetObjectName() + " may issue commands.";
}
list commandline = llParseString2List(msg, [" "], []);
CommandExec(commandline);
}
if(chan==0)
{
//conversations
if(id!=npc)
{
integer length = llGetListLength(triggers);
integer i;
for (i = 0; i < length; ++i) {
string word = llList2String(triggers, i);
integer found=llSubStringIndex(llToLower(msg),word);
if(found>-1)
{
integer address=llList2Integer(goto,i);
gotoqueue= [(integer)address] + gotoqueue;
debug("Added address " + address + " to gotoqueue.");
}
}
}
}
}

sensor(integer num)
{
integer count=0;
while(count<num)
{
string myname=npcfirstname + " " + npclastname;
string name=llKey2Name(llDetectedKey(count));
if(name!=myname)
{
if(llListFindList(greet,[name])<0)
{
greet+=[name];
integer space=llSubStringIndex(name," ");
string firstName=llGetSubString(name,0,space-1);
integer known=get_aqaintance(name);
llSleep(0.5);
if(known==0){
osNpcSay(npc,hiufirst + firstName + hiulast);
set_aqaintance(name);
}
else{
osNpcSay(npc,hikfirst + firstName + hiklast);
}
}
}
count++;
}
}
no_sensor()
{
greet=[];
}
}

state DetectAgent
{
state_entry()
{
llSensor(detectname, NULL_KEY, AGENT, 96, PI);
}
sensor(integer number)
{
debug("The entity named " + detectname + " was found.");
npc = llDetectedKey(0);
llSetObjectDesc(llDetectedKey(0));
list namelist = llParseString2List(detectname, [" "], []);
npcfirstname = llList2String(namelist, 0);
npclastname = llList2String(namelist, 1);
debug("The NPC's UUID is now " + npc + ".");
detectname = "";
state default;
}
no_sensor()
{
debug("The entity named " + detectname + " was not found.");
detectname = "";
gotoqueue=[];
state default;
}
}
</source>

==Credit==
Original script by Paintball Magic. Rewritten, corrected and expanded by Nihlaeth Melody.

OSSLNPC

2013-02-01T01:33:12Z

Nihlaeth:

{{Quicklinks}}
 
=Introduction=

Since OpenSimulator 0.7.2, a number of functions are provided for for creating and manipulating server-side NPCs. These replace the previous functions, that had stopped working by OpenSimulator 0.7.1.1 (possibly broken since OpenSimulator 0.6.9).

The general philosophy in creating these new functions is to

# Give script writers the simple tools needed to create more sophisticated behaviour.
# Avoid duplicating existing LSL and OSSL functions. For instance, finding out what state an agent is in can be done through llGetAgentInfo() rather than creating a special NPC function.

NPCs are controlled via a script which must be in the same region as the NPC. This could be housed in an attachment that is attached to the avatar.

NPCs created user these scripts cannot leave the region in which they were born. If you want region crossing behaviour, please look at the options on the [[NPC]] wiki page.

NPC appearance is saved and loaded by serializing the appearance data structure to a notecard present in the same prim as the script. The required textures should be preserved when an OAR is saved and loaded.

Unfortunately, the appearance data format is currently the same used for the OpenSimulator wire format, and so is not designed to be edited directly. However, with great care this should be possible, see [[Appearance Formats]] for more details.

= Enabling =

To use these functions, in the OpenSim.ini file you will need the following config

# Enabled = true set in the [NPC] section.
# Enabled = true set in the [XEngine] section.
# AllowOSFunctions = true in the [XEngine] section.
# OSFunctionThreatLevel = VeryHigh in the [XEngine] section. The functions osAgentSaveAppearance(), osAvatarPlayAnimation() and osAvatarStopAnimation() need this level. If you don't need these functions, then a "High" level will suffice.

See [[Configuring Simulator Parameters#Getting information about parameters]] if you need to double check that these parameters have been set correctly.

= Notes =

* When using your avatar to model appearance before saving, you will need to wait a few seconds before invoking any save appearance command. This is because appearance saving currently operates on a timer in order to manage multiple appearance updates from the viewer.
* OpenSimulator 0.7.3-rc1 introduces the concept of 'owned' and 'unowned' NPC. An 'owned' NPC is one where only the creating script and other scripts with the same owner can manipulate the NPC. An 'unowned' NPC is one where any script with the right permissions (as defined in the [XEngine] configuration section) can manipulate it. In OpenSimulator 0.7.3, all avatars are 'owned' by default unless otherwise specified in the osNpcCreate() call.

= Sensing =

llAgentSensor() can be used to set up a sensor that will detected NPCs instead/of as well as other region entities.

In OpenSimulator 0.7.2, LSL sensors will detect NPCs as ordinary agents.

In OpenSimulator 0.7.3-rc1 onwards, unless otherwise specified, NPCs will only be detected using the OpenSimulator-specific NPC flag, e.g.

As of git master bcfc392 (Fri Jul 20 21:08:04 2012), the constant OS_NPC should now be used instead of NPC, in order to avoid future issues if LL decide to use NPC themselves for some other function. The NPC constant will be deprecated in the forthcoming OpenSimulator 0.7.4 release but will remain useble.

<source lang="lsl">
//Author: mewtwo0641

list keys = [];
key npc;
string toucher;
key toucherkey;
vector toucherPos;
integer npc_on = FALSE;

default
{
touch_start(integer x)
{
toucherkey = llDetectedKey(0);
toucherPos = llDetectedPos(0);
vector npcPos = llGetPos() + <1,1,1>;

if(npc_on == FALSE)
{
npc = osNpcCreate("Fred", "Flintstone", npcPos, toucherkey);
npc_on = TRUE;
llSensor("", "", AGENT | NPC, 96.0, PI); //Will always return NPC key regardless of npc create option
return;
}

if(npc_on == TRUE)
{
osNpcRemove(npc);
llResetScript();
}
}

sensor(integer num)
{
keys = [];
integer i = 0;

for(i; i < num; i++)
{
keys += llDetectedKey(i);
}

llOwnerSay(llDumpList2String(keys, "\n"));
}

no_sensor()
{
keys = [];
}
}
</source>

You can get NPCs to be detected as AGENTs again using the OS_NPC_SENSE_AS_AGENT option below in osNpcCreate().

The justification is that detecting NPCs as AGENTs by default may make some scripts unusable (e.g. radars that know nothing about NPCs). However, conversely other scripts may not behave as expected if NPCs aren't sensed as agents (e.g. doors that open automatically for avatars would not open for NPCs).

From OpenSimulator git master commit ecf7bb26 (Fri Jul 20 21:36:33 2012), llGetDetectedType() will set the OS_NPC flag if an NPC was detected. If the NPC was created with the OS_NPC_SENSE_AS_AGENT option then the AGENT flag will also be set.

= Data Formats =
For more information about the format used to store appearance information in notecards, see [[Appearance Formats]].

= Functions =

== Create and Remove ==
=== [[osNpcCreate]] ===

osNpcCreate(string firstname, string lastname, vector position, string cloneFrom):key

cloneFrom may be:

* Name of the notecard containing a serialized avatar appearance, or
* Asset UUID of the Notecard, or
* UUID of an avatar logged into the same region. However, please note that this appearance will not be persisted unless osNpcSaveAppearance() is called.

If the NPC is successfully created, then its UUID is returned, which is required for all subsequent functions. Example is available at [[osNpcCreate]]

(OpenSimulator 0.7.3-rc1 onwards only). This creates an NPC that is 'owned' by the creating script and sensed using the OpenSimulator-only NPC flag for sensors.

=== osNpcCreate ===

OpenSimulator 0.7.3-rc1 onwards.

osNpcCreate(string firstname, string lastname, vector position, string cloneFrom, integer options):key

cloneFrom may be:

* Name of the notecard containing a serialized avatar appearance, or
* Asset UUID of the Notecard, or
* UUID of an avatar logged into the same region. However, please note that this appearance will not be persisted unless osNpcSaveAppearance() is called.

integer is a set of flags that may be 0 or one or more of

* OS_NPC_NOT_OWNED - create an unowned NPC.
* OS_NPC_SENSE_AS_AGENT - create an NPC that is sensed as an AGENT with LSL sensors

If the NPC is successfully created, then its UUID is returned, which is required for all subsequent functions. Example is available at [[osNpcCreate]]

=== [[osNpcRemove]] ===

osNpcRemove(key npc):void

Remove the given avatar from the region. Example at [[osNpcRemove]].

== Get and Set ==
=== osIsNpc ===

OpenSimulator 0.7.3-rc1 onwards.

osIsNpc(key npc):integer

Returns TRUE if the given key is an NPC, false otherwise.

=== [[osNpcGetRot]] ===

Gets the rotation of the avatar. Only the rotation around the Z plane in Euler rotation (horizontal rotation) has any meaning.

osNpcGetRot(key npc):rotation

=== [[osNpcSetRot]] ===

osNpcSetRot(key npc, rotation rot):void

Set the rotation of the avatar. Only setting the rotation in the Z plane in Euler rotation will have any meaningful effect (turning the avatar to point in one direction or another). Setting X or Y Euler values will result in the avatar rotating in an undefined manner.

=== [[osNpcGetPos]] ===

osNpcGetPos(key npc):vector

Return the current position of the NPC.

=== [[osNpcGetOwner]] ===

OpenSimulator 0.7.3-rc1 onwards.

osNpcGetOwner(key npc):key

Return the owner of the given NPC (i.e. the owner of the script that created it). If the NPC is unowned or the input key does not belong to an NPC then returns NULL_KEY.

== Movement ==

=== [[osNpcMoveTo]] ===

osNpcMoveTo(key npc, vector position):void

An older function that performs an osNpcMoveToTarget() by flying and landing at the target.

=== [[osNpcMoveToTarget]] ===

osNpcMoveToTarget(key npc, vector target, int options):void

Move the avatar to a given target over time. How the avatar will get there depends on the following options.

* OS_NPC_FLY - Fly the avatar to the given position. The avatar will not land unless the OS_NPC_LAND_AT_TARGET option is also given.
* OS_NPC_NO_FLY - Do not fly to the target. The NPC will attempt to walk to the location. If it's up in the air then the avatar will keep bouncing hopeless until another move target is given or the move is stopped
* OS_NPC_LAND_AT_TARGET - If given and the avatar is flying, then it will land when it reaches the target. If OS_NPC_NO_FLY is given then this option has no effect.
* OS_NPC_RUNNING - if given, NPC avatar moves at running/fast flying speed, otherwise moves at walking/slow flying speed.

OS_NPC_FLY and OS_NPC_NO_FLY are options that cannot be combined - the avatar will end up doing one or the other. If you want the avatar to fly and land at the target, then OS_NPC_LAND_AT_TARGET must be combined with OS_NPC_FLY. For instance,

osNpcMoveToTarget(npc, llGetPos() + <9,9,5>, OS_NPC_FLY|OS_NPC_LAND_AT_TARGET);

=== [[osNpcStopMoveToTarget]] ===

osNpcStopMoveToTarget(key npc):void

Stop a current move to a target.

== Sitting and standing ==

=== osNpcSit ===

OpenSimulator 0.7.3-rc1 onwards.

osNpcSit(key npc, key target, int options):void

Sit an NPC on a prim target. As yet there are no options, so always input 0.

=== osNpcStand ===

OpenSimulator 0.7.3-rc1 onwards.

osNpcStand(key npc):void

Make an npc stand up.

== Communication ==

=== [[osNpcSay]] ===

osNpcSay(key npc, string message):void
osNpcSay(key npc, int channel, string message):void

Get the NPC to say the given message.

If channel is specified then the chat is said on the given channel. The channel parameter is only available in OpenSimulator 0.7.4 development code at this time.

=== [[osNpcShout]] ===

Only in OpenSimulator 0.7.4 development code at this time.

osNpcShout(key npc, int channel, string message):void

Get the NPC to shout the given message on the given channel.

=== [[osNpcWhisper]] ===

Only in OpenSimulator 0.7.4 development code at this time.

osNpcWhisper(key npc, int channel, string message):void

Get the NPC to whisper the given message on the given channel.

== Animations ==

=== osNpcPlayAnimation ===

OpenSimulator 0.7.3-rc1 onwards.

osNpcPlayAnimation(key npc, string animation):void

Get an NPC to play an animation. The animation can either be a key or the name of an animation in the same inventory as the script.

=== osNpcStopAnimation ===

In OpenSimulator 0.7.3-rc1 there is a bug which makes this play the animation instead. This will be corrected for the final release but in the mean time please use osAvatarStopAnimation() instead.

osNpcStopAnimation(key npc, string animation):void

Get an NPC to stop playing an animation. The animation can either be a key or the name of an animation in the same inventory as the script.

== Appearance ==

NPC appearance is manipulated by saving and loading appearance data to notecards from the same inventory as the invoking script.

=== [[osOwnerSaveAppearance]] ===

osOwnerSaveAppearance(string notecard):key

Save the owner's current 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 owner must be present in the region when this function is invoked. The baked textures for the owner (necessary to recreate appearance on the NPC) are saved permanently.

=== [[osAgentSaveAppearance]] ===

osAgentSaveAppearance(key agentId, string notecard):key

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.

=== [[osNpcSaveAppearance]] ===

osNpcSaveAppearance(key npc, string notecard):key

Save the NPC's current 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) are saved permanently.

=== [[osNpcLoadAppearance]] ===

osNpcLoadAppearance(key npc, string notecard):void

Load appearance from a notecard. This notecard must contain appearance data created with one of the save appearance functions.

== Touch ==
=== [[osNpcTouch]] ===

OpenSimulator 0.7.4 development code at this time.

osNpcTouch(key npc, key objectKey, integer linkNum)

Allows the NPC to touch objects.

= Examples =
*[[NPC Automator 2.0]]

This is a rough example script for most of the current NPC functionality. One of its major current deficiencies is that it doesn't track more than one created avatar at a time. Please feel free to improve it.

<source lang = "lsl">
key npc;
integer listenChannel = 10;

default
{
// NPC manipulator adapted by justincc 0.0.3 released 20121025
state_entry()
{
llListen(listenChannel,"",NULL_KEY,"");
llSetText("Listening on " + listenChannel, <0, 255, 0>, 1);
llOwnerSay("Say /" + (string)listenChannel + " help for commands");
}

listen(integer channel, string name, key id, string msg)
{
if (msg != "")
{
list commands = llParseString2List(msg, [ " " ], []);
string msg0 = llList2String(commands, 0);
string msg1 = llList2String(commands, 1);
string msg2 = llList2String(commands, 2);
string msg3 = llList2String(commands, 3);

if (msg0 == "create")
{
if (msg1 != "")
{
string notecardName = msg1;

npc = osNpcCreate("Jane", "Doe", llGetPos() + <5, 5, 0>, notecardName);

llOwnerSay("Created npc from notecard " + notecardName);
}
else
{
llOwnerSay("Usage: create <notecard-name>");
}
}
else if (msg0 =="createm" && msg1 != "")
{
osOwnerSaveAppearance("appearance");
vector pos = llGetPos();
integer i;
for (i = 0; i < (integer)msg1; i++)
{
osNpcCreate("John", "Doe", pos + <8, 0, 0>, "appearance");
llSleep(1);
}
}
else if (msg0 == "remove" && npc != NULL_KEY)
{
osNpcSay(npc, "You will pay for this with your liiiiiivvveeessss!!!.....");
osNpcRemove(npc);
}
else if (msg0 == "say" && npc != NULL_KEY)
{
osNpcSay(npc, "I am your worst Nightmare!!!!");
}
else if (msg0 == "move")
{
if (msg1 != "" && msg2 != "" && npc != NULL_KEY)
{
vector delta = <(integer)msg1, (integer)msg2, 0>;

if (msg3 != "")
{
delta.z = (integer)msg3;
}

osNpcMoveTo(npc, osNpcGetPos(npc) + delta);
}
else
{
llOwnerSay("Usage: move <x> <y> [<z>]");
}
}
else if (msg0 == "moveto")
{
if (msg1 != "" && msg2 != "" && npc != NULL_KEY)
{
vector pos = <(integer)msg1, (integer)msg2, 0>;

if (msg3 != "")
{
pos.z = (integer)msg3;
}

osNpcMoveTo(npc, pos);
}
else
{
llOwnerSay("Usage: move <x> <y> [<z>]");
}
}
else if (msg0 == "movetarget" && npc != NULL_KEY)
{
osNpcMoveToTarget(npc, llGetPos() + <9,9,5>, OS_NPC_FLY|OS_NPC_LAND_AT_TARGET);
}
else if (msg0 == "movetargetnoland" && npc != NULL_KEY)
{
osNpcMoveToTarget(npc, llGetPos() + <9,9,5>, OS_NPC_FLY);
}
else if (msg0 == "movetargetwalk" && npc != NULL_KEY)
{
osNpcMoveToTarget(npc, llGetPos() + <9,9,0>, OS_NPC_NO_FLY);
}
else if (msg0 == "rot" && npc != NULL_KEY)
{
vector xyz_angles = <0,0,90>; // This is to define a 1 degree change
vector angles_in_radians = xyz_angles * DEG_TO_RAD; // Change to Radians
rotation rot_xyzq = llEuler2Rot(angles_in_radians); // Change to a Rotation
rotation rot = osNpcGetRot(npc);
osNpcSetRot(npc, rot * rot_xyzq);
}
else if (msg0 == "rotabs" && msg1 != "")
{
vector xyz_angles = <0, 0, (integer)msg1>;
vector angles_in_radians = xyz_angles * DEG_TO_RAD; // Change to Radians
rotation rot_xyzq = llEuler2Rot(angles_in_radians); // Change to a Rotation
osNpcSetRot(npc, rot_xyzq);
}
else if (msg0 == "animate" && npc != NULL_KEY)
{
osAvatarPlayAnimation(npc, "stabbed+die_2");
llSleep(3);
osAvatarStopAnimation(npc, "stabbed+die_2");
}
else if (msg0 == "save" && msg1 != "" && npc != NULL_KEY)
{
osNpcSaveAppearance(npc, msg1);
llOwnerSay("Saved appearance " + msg1 + " to " + npc);
}
else if (msg0 == "load" && msg1 != "" && npc != NULL_KEY)
{
osNpcLoadAppearance(npc, msg1);
llOwnerSay("Loaded appearance " + msg1 + " to " + npc);
}
else if (msg0 == "clone")
{
if (msg1 != "")
{
osOwnerSaveAppearance(msg1);
llOwnerSay("Cloned your appearance to " + msg1);
}
else
{
llOwnerSay("Usage: clone <notecard-name-to-save>");
}
}
else if (msg0 == "stop" && npc != NULL_KEY)
{
osNpcStopMoveToTarget(npc);
}
else if (msg0 == "sit" && msg1 != "" && npc != NULL_KEY)
{
osNpcSit(npc, msg1, OS_NPC_SIT_NOW);
}
else if (msg0 == "stand" && npc != NULL_KEY)
{
osNpcStand(npc);
}
else if (msg0 == "help")
{
llOwnerSay("Commands are:");
llOwnerSay("create <notecard-name> - Create NPC from a stored notecard");
llOwnerSay("createm");
llOwnerSay("remove - Remove current NPC");
llOwnerSay("clone <notecard-name> - Clone own appearance to a notecard");
llOwnerSay("load <notecard-name> - Load appearance on notecard to current npc");
llOwnerSay("save <notecard-name> - Save appearance of current NPC to notecard");
llOwnerSay("animate");
llOwnerSay("move");
llOwnerSay("moveto <x> <y> <z> - move to absolute position");
llOwnerSay("movetarget");
llOwnerSay("movetargetnoland");
llOwnerSay("movetargetwalk");
llOwnerSay("rot");
llOwnerSay("say");
llOwnerSay("sit <target-uuid>");
llOwnerSay("stop");
llOwnerSay("stand");
}
else
{
llOwnerSay("I don't understand [" + msg + "]");
}
}
}
}
</source>

= Questions/Comments =

Please leave your questions and comments on [[Talk:OSSLNPC|this article's talk page]].

[[Category:OSSL Functions]]
[[Category:Scripting]]

OsMakeNotecard

2011-09-12T00:40:15Z

Nihlaeth:

{{osslfunc
|threat_level=High
|function_syntax=void osMakeNotecard(string notecardName, list contents)
|ossl_example=<source lang="lsl">
//
//osMakeNotecard example
//By Tom Earth

default
{
touch_start(integer n)
{
key id = llDetectedKey(0);
string name = llKey2Name(id);
list contents; //The variable we are going to use for the contents of the notecard.
contents += ["Name: "+name+"\n"];
contents += ["Key: "+(string)id+"\n"];
contents += ["Pos: "+(string)llDetectedPos(0)+"\n"];
contents += ["Rotation: "+(string)llDetectedRot(0)+"\n"];

osMakeNotecard(name,contents); //Makes the notecard.

llGiveInventory(id,name); //Gives the notecard to the person.
llRemoveInventory(name);
}
}
</source>
|description=Creates a notecard with text in the prim that contains the script.
|
}}

Talk:OsMakeNotecard

2011-09-12T00:39:08Z

Nihlaeth: New page: In the function specification it states that osMakeNotecard takes a list as a second argument, but in the code example it takes a string. Testing revealed that it actually does expect a li...

In the function specification it states that osMakeNotecard takes a list as a second argument, but in the code example it takes a string. Testing revealed that it actually does expect a list.
I corrected this in the example. ~Nihlaeth

OSSL Proposals

2010-11-08T13:43:40Z

Nihlaeth: /* OSSL Proposal Table */

__NOTOC__
{{Template:Quicklinks}}

[[Technical Reference | Technical Reference]] -> [[Technical Reference/terms | Terms]] -> [[OSSL Status | OSSL Status]] -> [[OSSL_Proposals | OSSL Proposal List]]

{{proposal}}
{{content}}

=What is OSSL?=

==Introduction==

This is a page dedicated to OpenSim's very own home brew custom scripting language Known as "'''O'''pen '''S'''im '''S'''cripting '''L'''anguage"

<big>'''Please see [[OSSL_Standards|OSSL Standards]] for proposed naming schema'''</big>

* Please post your osFunction along with a brief description of what it would be for, or do and an example of it.
* Make sure it begins with os NOT ll.
* And remember, almost anything within reason can be posted here as an idea, who knows, maybe a variation of your request can be possible.
* If a function could implemented in standard LSL, there is no reason to make an OS function. LSL code and function code executes at the same speed in OpenSim.
== OSSL Proposal Table ==

{| class="sortable" cellpadding="5" cellspacing="0" style="width:100%;border:1px solid #000000;border-collapse: collapse; white-space:normal;"
|- style="background-color:#99CCFF;font-size:6pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| osFunction
| Description
| Example Usage
| Signed
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| list osGetRegionAgentKeys();
| C# Code:
public LSL_List osGetRegionAgentKeys()
{
CheckThreatLevel(ThreatLevel.None, "osGetRegionAgentKeys");
LSL_List result = new LSL_List();
foreach (ScenePresence avatar in World.GetAvatars())
{
result.Add(avatar.UUID);
}
return result;
}

Returns a list of keys for every agent in the region

| list keys=osGetRegionAgentKeys();
integer i; integer l=llGetListLength(keys); string names; for(i=0;i<l;i++) { key id=llList2Key(keys,i); string add=llKey2Name(id); integer dist=llVecDist(llGetPos(),llList2Vector(llGetObjectDetails(id,[OBJECT_POS]),0))); add+="["+(string)dist+"]\n"; names+=add; } llSetText(names,<1,1,1>,1.0);

| Joshua Driver
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| [NEW] various os functions including osDerezObject(), osMessageAgentAttachment(), ...
| see http://opensimulator.org/wiki/User:Athlon_Maurer for full source code
| tested on local opensimulator 0.6.9 (some of them doesnt seem to work on 0.7.x)
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| string osBin(string char);
| To convert a char into its binary value. Will only convert 1 char at a time.
| string bin_a = osBin("A"); // bin_a = "01000001";
| Athlon Maurer (please send me a notecard into secondlife, if that are too much ideas xD, this hint can be deleted by an opensimulator admin, if neccesary xD)
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osHex(integer number);
| To convert a number into its hexadecimal value.
| string str_ff = osHex(255); // str_ff = "FF";
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osAsc(string char);
| To convert a char into its ascii index. Will only convert 1 char at a time.
| integer asc_a = osAsc("A"); // asc_a = 65;
| Athlon Maurer
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osScanRegionRemove();
| Remove an osScanRegionRepeat(). [ nearly the same as llSensorRemove() ]
| osScanRegionRemove();
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| void osScanRegion(string name, key id, integer type);
| Scan the whole region where the script task object is in regardless where it is positioned. Triggers sensor() or no_sensor().
| osScanRegion("", "", AGENT);
| Athlon Maurer
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osScanRegionRepeat(string name, key id, integer type, float rate);
| Scan the whole region where the script task object is in regardless where it is positioned with rate. Triggers sensor() or no_sensor().
| osScanRegionRepeat("", "", AGENT, 15.0);
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| key osGetRegionMapTexture(string RegionName)
| return the map texture uuid for the region named by RegionName.
| llSetTexture(osGetRegionMapTexture("OpenSim Test"), ALL_SIDES);
<math>
create a php file which is public
<?php
 // mapquery.php by Athlon Maurer (SL, OL, OS)
//
// hello, ive just started to learn php/mysql and this is one of my first
// scripts for opensim. this script returns the texture uuid for a given
// region by calling: mapquery.php?region=REGIONNAME
// if a region has been found, it returns that regions map texture uuid,
// otherwise it returns a null key uuid
// mysql connection info is here, please make this more safe
 // region name (do not change this)
$region = htmlspecialchars($_GET['region']);
 // default uuid (do not change this)
$uuid = '00000000-0000-0000-0000-000000000000';
 // your mysql host name (change this)
$dbhost = 'localhost';
 // your mysql user name (change this)
$dbuser = 'root';
 // your mysql user password (change this)
$dbpass = '';
 // your mysql opensim database (change this)
$dbname = 'opensim';
 // try to connect
if ($conn = mysql_connect($dbhost, $dbuser, $dbpass))
{
// try to select
if ($select = mysql_select_db($dbname, $conn))
{
$sql = 'SELECT regionName, regionMapTexture FROM regions';
$result = mysql_query($sql);
while ($row = mysql_fetch_array($result, MYSQL_ASSOC))
{
if ($row['regionName'] == $region)
{
$uuid = $row['regionMapTexture'];
}
}
// free result
mysql_free_result($result);
}
// close connection
mysql_close($conn);
}
// output
echo $uuid;
?>
then llHTTPRequest(</math>

| Athlon Maurer (This function is available as of November 12, 2009)
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osGetLinkPrimitiveParams(integer link, list params);
| Function llSetLinkPrimitiveParams() does exist, but no chance to get params from a prim in a linkset, like llGetPrimitiveParams() and llSetPrimitiveParams().
| list linkparams = osGetLinkPrimitiveParams([PRIM_TYPE, PRIM_TEXTURE, ...]);
| Athlon Maurer (This function is available as of August 09, 2009)
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| void osDerezObject(key object)
| Deletes an InWorld-Object specified by object as uuid. Only successful if the object the script is attached to and the object which should be derezzed is owned by the same owner :). Useful if the object to be deleted should be unscripted.
| osDerezObject("key_of_object");
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| int osRestartRegion()
| Restarts the region the script is currently in. The script this is run in has to be owned by the master avatar for that region. Returns 1 if the region is restarting, 0 on failure.
| osRestartRegion();
| gryc (Implemented by AFrisby)
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| int osWebTexture()
| Sets the texture from a web-url
| osWebTexture(string url,integer maptype);
| AFrisby?
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osGroupAdd(key, string Role)
| Adds user to a group with given role, default role Everyone. Returns 1 if successful 0 if fail.
| osGroupAdd(87f6e6a0-d884-11dc-95ff-0800200c9a66, "Officer")
| Nitrus Nori
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| int osShutdownRegion()
| Shuts down the region the script is currently in. The script this is run in has to be owned by the master avatar for that region. Returns 1 if the region is going down, 0 on failure.
| osShutdownRegion();
| gryc
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osAttachmentSay(integer channel, string msg)
| Provide a secure, low lag method of communicating between attachments over the chat channels by only sending messages to objects attached to the same avatar. Would fail (or not be heard) if in a non-attached object.
| osAttachmentSay(-20, "detatch");
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osMessageSecure(string message_key, string str, integer num, key id); secure_message(string message_key, string str, integer num, key id);
| Provide a method of sending secure, salt encripted messages sim wide. Messages would only be able to be received by scripts with the matching key in the secure_message method.
| osMessageSecure("myPassPhrase", "Hello World", 0, NULL_KEY);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osSetText( vector color, string text [,vector color, string text]);
| Allow setting of multiple colors on the prim text
| osSetText(<1,0,0>,"Red", <0,1,0>, "\nGreen", <0,0,1>, "\nBlue");
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSensor
| Gets ALL the objects in the specified range not just the first 16
| (same as standard)
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list lst=osDetectObjectsInSim(key id)
| given an Agent Key, provide a list of ALL object owned by that agent
| osDetectObjectsInSim(key id) returning a strided list of [ name, <pos> ]
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer=osDialog([ title, label1, type1, len1, label2, type2, len2]....
| given title and a listing of fields, builds up a real form where to put structured checked data
| will return a [ value1, value2, valuen ] corresponding to fields read. Type might be something like (string, text (multiline), integer, float, currency(decimals), options(combobox)
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| key id=osMakeTextureText(string name,integer width, integer height,[posx1,posy1,font1,color1,size1,text1,posx2,posy2,font2,color2,size2,text2....])
| allow for producing a texture on the fly with desired Font content from a selected font selection. Width, Height in pixels 1024x512 to control how big will be the texture
| will generate a texture with defined text. (Allow some support for at least ISO-8859-1) texture will be created in the object inventory. posx, posy in the range 0-1 to be pixel independent
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osMakeNotecard(string name, [ line1, line2, line3, ...])
| allow creation of new notecards in current object repository
| generate a new asset id useful for storing modified configuration
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer handler=osReadNotecardKey(string notecard, string key)
| allows reading notecards (through dataserver) in format key=value in convenient and efficient way
| ...
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osWriteNotecardKey(string notecard, string key,string value)
| allows WRITING notecards in format key=value in convenient and efficient way. Might be optimized having a fixed record length "file" so to avoid rewriting of the entire notecard
| ...
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer handle=osXMLParser(string xml)
| will activate a listener xmlparser(integer handler,string parent, string field, string value)
| to easily parse xml without writing php external code
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osReturnObjects(key owner, integer type);
| Provide a scriptable method of returning objects from a sim. type would be OBJECT_SCRIPTED, OBJECT_PASSIVE or OBJECT_ALL. Would return a binary Success/Fail, and work inline with land permissions for the script owner.
| osReturnObjects( target, OBJECT_ALL);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osReturnItem(key item);
| Provide a scriptable method of returning individual objects from a sim. Would return a binary Success/Fail, and work inline with land permissions for the script owner.
| osReturnItem(uuid);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSetTimerEvent(integer timer, float rate); (event) timer(integer timer_num)
| Support for multiple timers in a script.
| osSetTimerEvent(2, 0.5);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osTimerOnce(integer timer, float rate);
| Allow for a one shot timer event, rather than the normal repeating heartbeat type
| osTimerOnce(2, 10);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osVerifyScripts();
| Check to see if all scripts in an object are created by the owner of the script calling the function. Return TRUE if they are, FALSE otherwise, to prevent insertion of alien scripts into an object
| if (!osVerifyScripts()) { llDie(); }
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osStopOtherAnimations(list animation_exceptions);
| Provide a method of stopping all animations on an avatar, except those defined in the list
| osStopOtherAnimations(["my_sitting_anim"]);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osPutScriptInLinkedSet(string name,integer linknum, integer starting_parm, integer running)
| Use this to propagate one script to ALL or part of linked set.
| Useful to have all objects in a linked set sharing a common behaviour
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osRezObject(string name, string description, integer permissionmask, list setPrimitiveObjectLikeList) will trigger the object_rez object as usual
| similar to llRezObject, but without the need of having a prim inside the inventory (which produced a lot of problems in deploying and in sl). Newly created object will have the same owner of current object where script is running.
| In case list is empty or position not specified, suitable defaults should apply like pos being 1 m higher in the z axis
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osGetOwnerName();
| Provide a method of getting the owner name without having to use llKey2Name
| myName = osGetOwnerName();
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osXMPPOpen(string server, string username, string password, string resource);
| Open an XMPP session to a jabber or other XMPP server, returning a handle to be able to manipulate the connection. Incoming messages to be parsed through a xmpp_message(integer handle, string sender, string service, string message) event. Accounts would have to be set up manually by the scripter, or by some other method, to prevent scripted spamming of a server, and to allow users to set up gateways and other services if needed.
| handle = osXMPPOpen("jabber.org", "MyObject", "MyPassword", "OpenSim");
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osXMPPGetRosta(integer handle);
| Get the rosta from the XMPP server, list in the strided form of [username, presence, resource];
| list presence = osXMPPGetRosta(handle);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osXMPPGetServices(integer handle);
| Get a list of available services from the XMPP Server.
| list services = osXMPPGetServices(handle);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osXMPPAdd(string username, string service)
| Add a username to the account rosta. Return boolean success or fail
| if (osXMPPAdd("Test User", "Yahoo")) { ... }
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer oxXMPPDelete(string username)
| Remove a username from the account rosta. Return boolean success or fail
| if (osXMPPDelete("Test User")) { ... }
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osXMPPGetStatus(string username);
| Poll the server for the status of a specific username on the rosta - returns would be OFFLINE, BUSY, AWAY and ONLINE
| if (osXMPPGetStatus("Test User") & ONLINE) { ... }
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osXMPPSendMessage(integer handle, string message, string target);
| Send a message via the open XMPP channel, to the specified target. Return boolean success values
| if (osXMPPSendMessage(handle, "Hello World", osGetOwnerName()) { llOwnerSay("Successfully sent message");
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osXMPPClose(integer handle);
| Close the XMPP session
| osXMPPClose();
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osRezObjectKey(key object,vector pos,vector vel,rotation rot, int param);
| Basically llGodLikeRezObject[http://lslwiki.net/lslwiki/wakka.php?wakka=llGodLikeRezObject] with the features of llRezObject[http://lslwiki.net/lslwiki/wakka.php?wakka=llRezObject] but for everyone to use. Calls object_rez.
| osRezObjectKey(object_key,llGetPos(),ZERO_VECTOR,llGetRot(),0);
| Tdub
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osRezFromURL(string url, vector pos, vector vel, rotation rot, integer param) - calls on_rez
| Fetch a fragment of xml from a web server and rez its contents in-world as in 'load-xml'. Off or intergrid object repositories, such as objects stored in SVN via websvn, CMS, etc.
| osRezFromURL("http://my.objectstore.com/myawesomeprims.xml", <1, 1, 1>, <0, 0, 0>, <0, 0, 0>, 0)
| Jimbo2120
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osRunCustom(string function, list params)
| Allow scripts to call external custom routines that are grid-specific without modifying the set of LSL and OSL functions.
| list results = osRunCustom("function1", [...])
| Ezekiel
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSetScriptServer()
| Create a 'Server' prim that allows for extended scripting capabilities: more memory, higher bandwidth when communicating with external servers, probably some database connectivity, no artificial delays, can receive IMs, etc. Could be limited to one server per prim / parcel or per avatar, could be forced to remain in a fixed position. A server is important for residents that want to set up a virtual business.
| osSetScriptServer()
| Ezekiel
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osRemoteLoadScript(string url, string target)
| Load a source file in txt format from "URL" and compile it into script "target" in the inventory of the same prim. Requires permission of the object owner (RequestPermission). Returns boolean success value. Replaces an existing script with same name. This function would allow updates to scripted solutions that operate in any grid and sim worldwide, allowing the creator of the solution to distribute code fixes and implement new functions. Since the source code is distributed openly, it can be copied and modified by anyone. A function that would allow for secure code distribution, protecting copyrights and certificates, would also be very interesting but should be far more difficult to implement.
| integer updatestatus = osRemoteLoadScript("http://www.xyz.com/updates/script1013.txt", "betterscript" )
| Ezekiel
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osSetCustomPrimitiveAttributes(list params)
| Set some custom persistent primitive attributes, the same way as llSetPrimitiveParams do. The attribute name has to be specified as a string, then the attribute type using a lSL constant. In the example, we set a "magnet" custom attribute as -0.5, supposing a customized physic engine handles this attribute to provide prim attraction.
| integer osSetCustomPrimitiveAttributes(["magnet", TYPE_FLOAT, -0.5])
| Grumly
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osGetCustomPrimitiveAttributes(list paramNames)
| Return a list values of the specified attributes names, the same way as llGetPrimitiveParams do.
| list osGetCustomPrimitiveAttributes(["Magnetic"])
| Grumly
 

|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osSyncUUID(key oldUUID, key newUUID);
| Allows to change the UUID of an avatar or item(requires permission from owner).
| Suppose a terminal in the LL-grid wants to communicate with an OS-Grid terminal. It can only send messages, if the UUID's of avatars match. An OS-Grid script can get the avatar's LL-UUID by calling the dataserver script. Then it calls osSyncUUID(llDetectedKey(0), keyFromHTTPRequest); . Now the two keys are equal, and avatar-avatar communication between grids can take place!
| Phrearch
 

|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osTeleport(string RegionName, int x, int y, int z);
| Teleports an avatar to a custom region
as : osTeleportAgent(key agentId, string regionName, vector position, vector lookAt);

| (this is implemented now - edited April 2009 by Wordfromthe Wise)
| Phrearch
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSetStatus(integer status, integer value);
| Improved verion of the LSL function llSetStatus.
| The function works basically the same way as llSetStatus, except that an extra flag is added named STATUS_PHYSICS_ROOT. When this flag is TRUE, physics would be enabled Only for the root prim in a linked set, while the other prims in the set would behave as phantom. This would be useful for bypassing the 32-prim physics limit for vehicles by using only the root prim as a collision mesh.
| Pesho
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| vector osGetBonePos();
| When called from an Attachment, retrieves the position of the bone it is attached to, in Region Coordinates.
| When llGetPos() is called from an attachment, the vector returned is the one of the avatar center, whereas llGetLocalPos() returns the local offset from the bone it is attached to. It would be useful to know where the attachment's location really is in world space.
| Pesho
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osGetOSLLRelease();
| When called return the actual release of OSSL running on the sim.
| if osGetOSSLRelease() > 1.1 {llSay(0,"good");}
| Sacha Magne
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| List osGetServerLib();
| When called return a list of all the additional libraries loaded on the server. it will avoid any scripts using a specific library to crash in case of missing libs.
| List lib=osGetServerLib();
| Sacha Magne
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSetAttachmentPoint(integer attachment);
| When called from an Attachment sets the default attachment point to attachment value.
| osSetAttachmentPoint(ATTACH_HUD_BOTTOM_RIGHT);
| Peter
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osMySQLQuery(string query);
| Used to get informations out of a sql database. Works together with osMySQLConnect(), osMySQLSelectDatabase() and osMySQLClose().
| osMySQLQuery("Select name FROM user LIMIT 0,1;");
| Peter
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| string osGetGridName();
| When called it return the hostname of the grid server. Useful to find out what grid you are on.
| string gridHostname = osGetGridHostname();
| Patnad
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| key osName2Key(string avatarname);
| When called it return the key associated with a Avatar Name.
| key avKey = osName2Key("avatar name");
| Patnad
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| vector osParcelCenterpoint(vector pos);
| When called it return the vector that represent the center point of the current parcel. Same height as the object running the script but centerpoint for x,y.
| vector parcel_center = osParcelCenterpoint(llGetPos());
| Patnad
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osSetMapDestination(integer mode, string simname, vector position, vector lookat);
| Sets a new "beacon" (red pole) without opening the worldmap: mode is for 1 (simname is a standard region name) or 0 (simname is a SLURL). If the code can handle standard sim names and SLURL(s) at the same time, the "mode" flag can be left behind.
| integer error = osSetMapDestination(TRUE, "cyberlandia", <128.0, 128.0, 0.0>, ZERO_VECTOR);
 If error is FALSE then no errors have occurred setting up the new beacon.  Errors can arise using unknown simnames/SLURL(s), out of ranges vector coords and so on (nearly the same as llSetMapDestination).

| Elwe Ewing
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osTeleportAgentPerm(key agentId, string regionName, vector position, vector lookAt);
osTeleportAgentPerm(key agentId, vector position, vector lookAt);

| Works similarly as the two implemented osTeleportAgent but requires (at least the first time) the PERMISSION_TELEPORT flag set (via llRequestPermissions(key id, PERMISSION_TELEPORT); which should be implemented) and can be used by everyone (or restricted to a member of the group wich the region is deed, maybe with a new "Restrict teleports" Estate flag).
|
// requests permission to Teleport then do it

key avie = NULL_KEY;

default
{
state_entry()
{
llSay(0, "Touch to be teleported");
}

run_time_permissions(integer vBitPermissions)
{
if(PERMISSION_TELEPORT & vBitPermissions){
osTeleportAgentPerm(avie, <128.0,128.0,0.0>,
ZERO_VECTOR);
} else {
llSay(0, "You deny teleport permission");
}
}

touch_start(integer num_detected)
{
avie = llDetectedKey(0);

llRequestPermissions(avie,
PERMISSION_TELEPORT |
PERMISSION_TRIGGER_ANIMATION |
0);
integer perm = llGetPermissions();
}
}

| Elwe Ewing
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| osGetSimulatorStatus(string Simulator)
| Extended / Enhanced version of llGetSimulatorData.
Purpose: When an avatar is Teleported with osTeleportAgent, there is no check to see if a given simulator is available. If it's down, Agent is Teleported to NULL resulting in Agent being fragged and viewer broken, requiring a relog. This would be especially useful for HyperGrid Teleporting. Returns: integer "0 = DOWN", "1 = UP", "2 = UNKNOWN" Security: Would require some form of Throttle to prevent recurring requests of destination Simulator. Command: osGetSimulatorStatus(string Simulator) Where Simulator = "RegionName", "IPAddress:PortNum", "HostName:PortNum"

|
// CHecks if simulator is online before teleporting agent -kizmut

string destination = "Wright Plaza";

default
{
state_entry()
{
llSay(0, "Touch to be teleported to: "+destination);
}
touch_start(integer num_detected)
{
llSay(0,llDetectedName(0)+" requesting teleport to: "+destination);
integer sim_stat = osGetSimulatorStatus(destination);
if (sim_stat == 2) {
llSay(0, "Could not teleport to "+destination+": Region status unknown.");
}
else if (sim_stat) {
osTeleportAgent(llDetectedKey(0),destination,ZERO_VECTOR);
}
else {
llSay(0, "Could not teleport to "+destination+": Region is down");
}
}
}

| WhiteStar Magic
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osTeleportOwner(string regionName, vector position, vector lookAt);
| Works similarly as osTeleportAgent but could only teleport the owner of the script itself. Would be very useful for HUD and would not require any authorization.
| integer error=osTeleportOwner("Snoopies",<100,25,25>,ZERO_VECTOR);
| Agnes Chalet
 

|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osName2Key(string name);
| A command which gives the UUID of an agent. Would work in the same way as llKey2Name, but in reverse. (Linden Lab may implement this first)
| osName2Key("Bob Smith");
| Drava
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osHyperGrid();
| Detects whether or not the region the person is in is Hypergrid enabled. Could be expanded to any region in the current grid.
| osHyperGrid() == TRUE
| Drava
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osTurnAvatar(rotation rot);
| Turns an avatar about the vertical axis to rotation rot relative to the grid rotation.
| osTurnAvatar(newrot); // turns the avatar to the new rotation specified by newrot.
| Valradica

|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| osRezLink(string inventory, vector position, vector velocity, rotation rot, integer param) ;
| osRezLink would work just like llRezObject but instead of a separate object it would be directly part of the original object's link system. This would be very useful in HUDs and attachments.
| osRezLink("myobject",llGetPos()+<0.0,0.0,0.5>,ZERO_VECTOR,ZERO_ROTATION,10);
| Nihlaeth

|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSaveObject();
| osSaveObject would be used in attachments and HUDs to save changes made while the object was worn.
| osSaveObject();
| Nihlaeth
|}

----

= See Also =
* [[LSL Status|LSL/OSSL Status Page]]
* LSL
** [[LSL Status/Types|LSL Types Status Page]]
** [[LSL Status/Events|LSL Events Status Page]]
** [[LSL Status/Functions|LSL Functions Status Page]]
** [[LSL_Status/functions/summary | LSL Functions Status Summary]]
** [[LSL_Known_Issues| LSL Known Issues]]
** [[Kan-Ed_Tests| Kan-Ed Tests]]
* OSSL
** [[OSSL Status/Types |OSSL Types Status Page]]
** [[OSSL Status/Events |OSSL Events Status Page]]
** [[OSSL_Proposals | OSSL Proposed Functions]]
** [[OSSL_Implemented | OSSL Implemented Functions]]
** [[OSSL_Standards | OSSL Standards]]
* [[Technical_Reference|Technical Reference Page]]

[[Category:Main]]
[[Category:Users]]
[[Category:Support]]
[[Category:Tech Reference]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting_Started]]
[[Category:Development]]
[[Category:Todo]]

Performance

2010-10-26T22:46:10Z

Nihlaeth: /* Hardware Requirements */

{{Template:Quicklinks}}

=Introduction=

OpenSim performance is a very complex issue. Performance can be affected by any number of things, including the number of prims on a region, number of regions, number of avatars, network quality between server and viewer, network quality between simulator and grid services, etc.

==Hardware Requirements==

Unfortunately, this is a very difficult question in light of all the factors mentioned above. Below are some examples of hardware people use/have used. Please feel free to add to the list, or to add any reports to the performance studies and blog posts section. '''These are examples to help you in your selection, not necessarily recommendations.'''

Object Parts ~= # prim

Sensors and Timers are generally more intensive then regular scripts, so please specify quantity of each.

{| border="1"
!Description
!Operating System (please add Mono version if appropriate)
!OpenSim version
!RAM/AVG_USE_%
!CPU
!#/type of regions
!# simultaneous avs
!#scripts/timers/Sensors
!Location
!#objectparts
|-
|hosted Xen VPS
|Ubuntu Intrepid (8.10)
|Unknown
|540MB/?
|1x quad-core 2.5GHz Xeon (L5420)
|1 region + 9 voids
|generally 1-2
|few
|Knifejaw Atoll & surrounding on OSGrid
|?
|-
|hosted Xen VPS
|Ubuntu Jaunty (9.04)
|Unknown
|360MB/?
|2x dual-core 2.0GHz Xeon (5130)
|1 void
|generally 1-2
|none
|Knifejaw Road on OSGrid
|?
|-
|Dedicated Server from A+
|Windows Server 2003
|Unknown
|1 Meg
|1x single-core 2.8GHz Celeron
|2regions per server
|6 at once with no issues
|Waterfalls, texture anims, window texture switchers, lots of sound loops
|Pleasure Planet Welcome center & Region Pleasure Planet in OSGrid
|20000 prims per region
|-
|Amazon EC2 "high-CPU medium instance" (Xen VM)
|Windows Server 2003
|Unknown
|1.7GB
|1x dual-core 2.3GHz (Intel E5345)
|1 region with sailing race course
|7 avs, 4 in boats
|scripted start line
|Castle Rock, OSGrid
|
|-
|Dedicated Server from simhost.com
|SuSe 11.2 x64
|Unknown
|8gb / 50%
|4x Core2Quad Q9300 2.6ghz
|1 region (Wright Plaza) uses approx 4gb ram
|20-25 users
|Freebie Stores / Meeting Center / Video Theater
|@osgrid.org Heavy Use Sim
|17500 prims aprox 1500 scripts
|-
|Home machine
|Windows XP SP3
|0.7.0.1 (Diva r13558)
|3GB / 15-40% incl. Opensim and MySQL
|4x Core2Quad Q6600 2.4 GHz. Use: generally, 0-10%
|11 regions
|1-6 users
|Many scripted objects (1934 scripts)
|[http://zonjacapalini.wordpress.com/2010/08/25/condensation-land-a-status-report/ Condensation Land]
|38,065 prims
|-
|Home machine
|Ubuntu Lucid 10.04 (32 bit pae)
|0.7.0.1 (Diva r13558)
|160Mb no users, add 5Mb/user incl Opensim and MySQL
|I7-920 (dual threaded quad core), 3.8Ghz, 6Gb RAM, 0-10% Load
|4 regions (Diva default config)
|1-4 users (approx 20Kb/sec bandwidth/user)
|Few scripted objects (<10)
|[http://mars-simulator.hobby-site.org:9000/wifi Mars Simulation]- Based on [http://metatek.blogspot.com/2010/06/mars-simulation-for-distribution.html Erik Nauman's Open Blackboard]
|158 prims
|-
|Parallels Virtuozzo Container 4.5
|Win/Net (32 run)
|0.7 (D2)
|320Mb total, incl Opensim and MySQL
|Q6600 Quad, 2.8Ghz, 2Gb RAM, 0-2% Avg Load
|9 regions (3x3 mega-region)
|<6 users
|vehicle scripted objects (<5)
|[http://metaversesailing.com:9000/wifi Metaverse Sailing]
|<1000 prims
|-
|VPS
|Debian Lenny 5 (mono 2.4.2.3)
|OSgrid 0.7.1 (Dev) cd4d7a7: 2010-10-15
|655MB average out of 1722MB RAM, incl. MySQL
|Intel Quadcore 2.5 Ghz (1 core assigned to vps) average use: 40-45%
|20 regions
|<4 users
|about 20 different light scripts, but we're also experimenting with heavier HUD scripts (timers, lots of ll(Get/Set)PrimitiveParams and large lists) and custom IRC relay
|Phoenix Rising Isles on OsGrid
|3727 prims
|}

==Performance studies and blog posts==

These provide some interesting data on the performance limitations of OpenSim at various points in time.

* [https://lists.berlios.de/pipermail/opensim-users/2010-August/005189.html https://lists.berlios.de/pipermail/opensim-users/2010-August/005189.html] - Some interesting information from Mr Blue. Physical objects and max avatars are limited by single thread performance in OpenSim.
* [http://www.sciencesim.com/wiki/doku.php/vwperf/start http://www.sciencesim.com/wiki/doku.php/vwperf/start] - Links to ScienceSim performance studies, including some very recent ones.
* [[Improving Performance]] - An old page from July 2009 detailing some performance issues on OpenSim. Some of these issues are still valid (e.g. ODE issues).
* [[NHibernate Performance Testing]] — SQLite and MySQL performance tests with NHibernate.
* [[LibSecondLife performance problems]] - Another old page from November 2007 detailing issues with libsecondlife (now called libopenmetaverse).
* [http://opensim.cybertechnews.org/?p=71 Experiences from Operating a 3D Region Server in OSGrid - Part 1]
* [http://opensim.cybertechnews.org/?p=104 Experiences from Operating a 3D Region Server in OSGrid - Part 2]

==Performance hints==

Here are some specific things you might be able to do to improve performance

===Home Based systems===

The most obvious performance difference between a home based cable/dsl system and a "commercial" server is the upload bandwidth. A typical home system allows 100Kb/s upload with 12Mb/s download, a "commercial" system typically has a "symmetrical" bandwidth of say 12Mb/s UP AND DOWN! "Commercial" systems can essentially buy unlimited bandwidth as needed, but it does get expensive to buy bandwidth that you don't need!

In practice this limits the number of "external" users on a "home system" to 4 or 5, but LAN users (NPCs/bots etc.) are essentially unlimited.

A reasonable strategy (i.e. MY strategy) is to use the home system for experimentation and then move the entire sim to a "commercial" VPS service if the sim gets popular (and produces enough $$$ to pay the freight!)

===Running Squid on your region server as a reverse proxy to the asset server===
1. Download and install the Squid Proxy from: http://www.squid-cache.org/Download/ 
2. Create your [[squid.conf]] configuration file. 
3. Change your asset_server configuration in your OpenSim.ini to point to http://localhost:3128/ 
4. Start everything up! 

Now assets will be cached in the squid cache on the region server, and will be served up much faster, especially on region restart.

=== GC_NO_EXPLICIT ===

Sometimes this patch applied to mono-svn has helped my sim run a lot faster and not slowly get bogged down.

$mono-svn-root$/mono
mono/metadata/boehm-gc.c

<pre>
Index: boehm-gc.c
===================================================================
--- boehm-gc.c (revision 105684)
+++ boehm-gc.c (working copy)
@@ -107,6 +107,10 @@
void
mono_gc_collect (int generation)
{
+ static int no_explicite_gc = 0; if (no_explicite_gc==0) {if (getenv("GC_NO_EXPLICIT")) {no_explicite_gc = 1;return;} else {no_explicite_gc = 2;}} else if (no_explicite_gc==1) {
+ g_print("\n --------GC_NO_EXPLICIT \n");
+ return;
+ }
MONO_PROBE_GC_BEGIN (generation);

GC_gcollect ();
</pre>

Not only this, but I recompile the mono runtime:
<pre>--with-large-heap=yes</pre>

Otherwise, the Sim is limited to 3GB RAM. Probably, this second peice is more important. But still, afterwards it's worth a shot to test with both to see if there is a difference in performance:

export GC_NO_EXPLICIT=1
and
unset GC_NO_EXPLICIT

What I think, (only a guess) is that Mono starts internally GC thrashing in fishing expeditions to gaining maybe 1k of RAM at time. And by having a large heap (>3GB), it is possible might keep mono less apt to do stop world complete collections as often.

Performance

2010-10-26T22:44:11Z

Nihlaeth: /* Hardware Requirements */

{{Template:Quicklinks}}

=Introduction=

OpenSim performance is a very complex issue. Performance can be affected by any number of things, including the number of prims on a region, number of regions, number of avatars, network quality between server and viewer, network quality between simulator and grid services, etc.

==Hardware Requirements==

Unfortunately, this is a very difficult question in light of all the factors mentioned above. Below are some examples of hardware people use/have used. Please feel free to add to the list, or to add any reports to the performance studies and blog posts section. '''These are examples to help you in your selection, not necessarily recommendations.'''

Object Parts ~= # prim

Sensors and Timers are generally more intensive then regular scripts, so please specify quantity of each.

{| border="1"
!Description
!Operating System (please add Mono version if appropriate)
!OpenSim version
!RAM/AVG_USE_%
!CPU
!#/type of regions
!# simultaneous avs
!#scripts/timers/Sensors
!Location
!#objectparts
|-
|hosted Xen VPS
|Ubuntu Intrepid (8.10)
|Unknown
|540MB/?
|1x quad-core 2.5GHz Xeon (L5420)
|1 region + 9 voids
|generally 1-2
|few
|Knifejaw Atoll & surrounding on OSGrid
|?
|-
|hosted Xen VPS
|Ubuntu Jaunty (9.04)
|Unknown
|360MB/?
|2x dual-core 2.0GHz Xeon (5130)
|1 void
|generally 1-2
|none
|Knifejaw Road on OSGrid
|?
|-
|Dedicated Server from A+
|Windows Server 2003
|Unknown
|1 Meg
|1x single-core 2.8GHz Celeron
|2regions per server
|6 at once with no issues
|Waterfalls, texture anims, window texture switchers, lots of sound loops
|Pleasure Planet Welcome center & Region Pleasure Planet in OSGrid
|20000 prims per region
|-
|Amazon EC2 "high-CPU medium instance" (Xen VM)
|Windows Server 2003
|Unknown
|1.7GB
|1x dual-core 2.3GHz (Intel E5345)
|1 region with sailing race course
|7 avs, 4 in boats
|scripted start line
|Castle Rock, OSGrid
|
|-
|Dedicated Server from simhost.com
|SuSe 11.2 x64
|Unknown
|8gb / 50%
|4x Core2Quad Q9300 2.6ghz
|1 region (Wright Plaza) uses approx 4gb ram
|20-25 users
|Freebie Stores / Meeting Center / Video Theater
|@osgrid.org Heavy Use Sim
|17500 prims aprox 1500 scripts
|-
|Home machine
|Windows XP SP3
|0.7.0.1 (Diva r13558)
|3GB / 15-40% incl. Opensim and MySQL
|4x Core2Quad Q6600 2.4 GHz. Use: generally, 0-10%
|11 regions
|1-6 users
|Many scripted objects (1934 scripts)
|[http://zonjacapalini.wordpress.com/2010/08/25/condensation-land-a-status-report/ Condensation Land]
|38,065 prims
|-
|Home machine
|Ubuntu Lucid 10.04 (32 bit pae)
|0.7.0.1 (Diva r13558)
|160Mb no users, add 5Mb/user incl Opensim and MySQL
|I7-920 (dual threaded quad core), 3.8Ghz, 6Gb RAM, 0-10% Load
|4 regions (Diva default config)
|1-4 users (approx 20Kb/sec bandwidth/user)
|Few scripted objects (<10)
|[http://mars-simulator.hobby-site.org:9000/wifi Mars Simulation]- Based on [http://metatek.blogspot.com/2010/06/mars-simulation-for-distribution.html Erik Nauman's Open Blackboard]
|158 prims
|-
|Parallels Virtuozzo Container 4.5
|Win/Net (32 run)
|0.7 (D2)
|320Mb total, incl Opensim and MySQL
|Q6600 Quad, 2.8Ghz, 2Gb RAM, 0-2% Avg Load
|9 regions (3x3 mega-region)
|<6 users
|vehicle scripted objects (<5)
|[http://metaversesailing.com:9000/wifi Metaverse Sailing]
|<1000 prims
|-
|VPS
|Debian Lenny 5 (mono 2.4.2.3)
|OSgrid 0.7.1 (Dev) cd4d7a7: 2010-10-15
|655MB average out of 1722MB RAM, incl. MySQL
|Intel Quadcore 2.5 Ghz (1 core assigned to vps) average use: 40-45%
|20 regions (4x5 mega-region)
|<4 users
|about 20 different light scripts, but we're also experimenting with heavier HUD scripts (timers, lots of ll(Get/Set)PrimitiveParams and large lists) and custom IRC relay
|Phoenix Rising Isles on OsGrid
|3727 prims
|}

==Performance studies and blog posts==

These provide some interesting data on the performance limitations of OpenSim at various points in time.

* [https://lists.berlios.de/pipermail/opensim-users/2010-August/005189.html https://lists.berlios.de/pipermail/opensim-users/2010-August/005189.html] - Some interesting information from Mr Blue. Physical objects and max avatars are limited by single thread performance in OpenSim.
* [http://www.sciencesim.com/wiki/doku.php/vwperf/start http://www.sciencesim.com/wiki/doku.php/vwperf/start] - Links to ScienceSim performance studies, including some very recent ones.
* [[Improving Performance]] - An old page from July 2009 detailing some performance issues on OpenSim. Some of these issues are still valid (e.g. ODE issues).
* [[NHibernate Performance Testing]] — SQLite and MySQL performance tests with NHibernate.
* [[LibSecondLife performance problems]] - Another old page from November 2007 detailing issues with libsecondlife (now called libopenmetaverse).
* [http://opensim.cybertechnews.org/?p=71 Experiences from Operating a 3D Region Server in OSGrid - Part 1]
* [http://opensim.cybertechnews.org/?p=104 Experiences from Operating a 3D Region Server in OSGrid - Part 2]

==Performance hints==

Here are some specific things you might be able to do to improve performance

===Home Based systems===

The most obvious performance difference between a home based cable/dsl system and a "commercial" server is the upload bandwidth. A typical home system allows 100Kb/s upload with 12Mb/s download, a "commercial" system typically has a "symmetrical" bandwidth of say 12Mb/s UP AND DOWN! "Commercial" systems can essentially buy unlimited bandwidth as needed, but it does get expensive to buy bandwidth that you don't need!

In practice this limits the number of "external" users on a "home system" to 4 or 5, but LAN users (NPCs/bots etc.) are essentially unlimited.

A reasonable strategy (i.e. MY strategy) is to use the home system for experimentation and then move the entire sim to a "commercial" VPS service if the sim gets popular (and produces enough $$$ to pay the freight!)

===Running Squid on your region server as a reverse proxy to the asset server===
1. Download and install the Squid Proxy from: http://www.squid-cache.org/Download/ 
2. Create your [[squid.conf]] configuration file. 
3. Change your asset_server configuration in your OpenSim.ini to point to http://localhost:3128/ 
4. Start everything up! 

Now assets will be cached in the squid cache on the region server, and will be served up much faster, especially on region restart.

=== GC_NO_EXPLICIT ===

Sometimes this patch applied to mono-svn has helped my sim run a lot faster and not slowly get bogged down.

$mono-svn-root$/mono
mono/metadata/boehm-gc.c

<pre>
Index: boehm-gc.c
===================================================================
--- boehm-gc.c (revision 105684)
+++ boehm-gc.c (working copy)
@@ -107,6 +107,10 @@
void
mono_gc_collect (int generation)
{
+ static int no_explicite_gc = 0; if (no_explicite_gc==0) {if (getenv("GC_NO_EXPLICIT")) {no_explicite_gc = 1;return;} else {no_explicite_gc = 2;}} else if (no_explicite_gc==1) {
+ g_print("\n --------GC_NO_EXPLICIT \n");
+ return;
+ }
MONO_PROBE_GC_BEGIN (generation);

GC_gcollect ();
</pre>

Not only this, but I recompile the mono runtime:
<pre>--with-large-heap=yes</pre>

Otherwise, the Sim is limited to 3GB RAM. Probably, this second peice is more important. But still, afterwards it's worth a shot to test with both to see if there is a difference in performance:

export GC_NO_EXPLICIT=1
and
unset GC_NO_EXPLICIT

What I think, (only a guess) is that Mono starts internally GC thrashing in fishing expeditions to gaining maybe 1k of RAM at time. And by having a large heap (>3GB), it is possible might keep mono less apt to do stop world complete collections as often.

Performance

2010-10-26T22:43:12Z

Nihlaeth: /* Hardware Requirements */

{{Template:Quicklinks}}

=Introduction=

OpenSim performance is a very complex issue. Performance can be affected by any number of things, including the number of prims on a region, number of regions, number of avatars, network quality between server and viewer, network quality between simulator and grid services, etc.

==Hardware Requirements==

Unfortunately, this is a very difficult question in light of all the factors mentioned above. Below are some examples of hardware people use/have used. Please feel free to add to the list, or to add any reports to the performance studies and blog posts section. '''These are examples to help you in your selection, not necessarily recommendations.'''

Object Parts ~= # prim

Sensors and Timers are generally more intensive then regular scripts, so please specify quantity of each.

{| border="1"
!Description
!Operating System (please add Mono version if appropriate)
!OpenSim version
!RAM/AVG_USE_%
!CPU
!#/type of regions
!# simultaneous avs
!#scripts/timers/Sensors
!Location
!#objectparts
|-
|hosted Xen VPS
|Ubuntu Intrepid (8.10)
|Unknown
|540MB/?
|1x quad-core 2.5GHz Xeon (L5420)
|1 region + 9 voids
|generally 1-2
|few
|Knifejaw Atoll & surrounding on OSGrid
|?
|-
|hosted Xen VPS
|Ubuntu Jaunty (9.04)
|Unknown
|360MB/?
|2x dual-core 2.0GHz Xeon (5130)
|1 void
|generally 1-2
|none
|Knifejaw Road on OSGrid
|?
|-
|Dedicated Server from A+
|Windows Server 2003
|Unknown
|1 Meg
|1x single-core 2.8GHz Celeron
|2regions per server
|6 at once with no issues
|Waterfalls, texture anims, window texture switchers, lots of sound loops
|Pleasure Planet Welcome center & Region Pleasure Planet in OSGrid
|20000 prims per region
|-
|Amazon EC2 "high-CPU medium instance" (Xen VM)
|Windows Server 2003
|Unknown
|1.7GB
|1x dual-core 2.3GHz (Intel E5345)
|1 region with sailing race course
|7 avs, 4 in boats
|scripted start line
|Castle Rock, OSGrid
|
|-
|Dedicated Server from simhost.com
|SuSe 11.2 x64
|Unknown
|8gb / 50%
|4x Core2Quad Q9300 2.6ghz
|1 region (Wright Plaza) uses approx 4gb ram
|20-25 users
|Freebie Stores / Meeting Center / Video Theater
|@osgrid.org Heavy Use Sim
|17500 prims aprox 1500 scripts
|-
|Home machine
|Windows XP SP3
|0.7.0.1 (Diva r13558)
|3GB / 15-40% incl. Opensim and MySQL
|4x Core2Quad Q6600 2.4 GHz. Use: generally, 0-10%
|11 regions
|1-6 users
|Many scripted objects (1934 scripts)
|[http://zonjacapalini.wordpress.com/2010/08/25/condensation-land-a-status-report/ Condensation Land]
|38,065 prims
|-
|Home machine
|Ubuntu Lucid 10.04 (32 bit pae)
|0.7.0.1 (Diva r13558)
|160Mb no users, add 5Mb/user incl Opensim and MySQL
|I7-920 (dual threaded quad core), 3.8Ghz, 6Gb RAM, 0-10% Load
|4 regions (Diva default config)
|1-4 users (approx 20Kb/sec bandwidth/user)
|Few scripted objects (<10)
|[http://mars-simulator.hobby-site.org:9000/wifi Mars Simulation]- Based on [http://metatek.blogspot.com/2010/06/mars-simulation-for-distribution.html Erik Nauman's Open Blackboard]
|158 prims
|-
|Parallels Virtuozzo Container 4.5
|Win/Net (32 run)
|0.7 (D2)
|320Mb total, incl Opensim and MySQL
|Q6600 Quad, 2.8Ghz, 2Gb RAM, 0-2% Avg Load
|9 regions (3x3 mega-region)
|<6 users
|vehicle scripted objects (<5)
|[http://metaversesailing.com:9000/wifi Metaverse Sailing]
|<1000 prims
|-
|VPS
|Debian Lenny 5 (mono 2.4.2.3)
|OSgrid 0.7.1 (Dev) cd4d7a7: 2010-10-15
|655MB averabe out of 1722MB RAM, incl. MySQL
|Intel Quadcore 2.5 Ghz (1 core assigned to vps) average use: 40-45%
|20 regions (4x5 mega-region)
|<4 users
|about 20 different light scripts, but we're also experimenting with heavier HUD scripts (timers, lots of ll(Get/Set)PrimitiveParams and large lists) and custom IRC relay
|Phoenix Rising Isles on OsGrid
|3727 prims
|}

==Performance studies and blog posts==

These provide some interesting data on the performance limitations of OpenSim at various points in time.

* [https://lists.berlios.de/pipermail/opensim-users/2010-August/005189.html https://lists.berlios.de/pipermail/opensim-users/2010-August/005189.html] - Some interesting information from Mr Blue. Physical objects and max avatars are limited by single thread performance in OpenSim.
* [http://www.sciencesim.com/wiki/doku.php/vwperf/start http://www.sciencesim.com/wiki/doku.php/vwperf/start] - Links to ScienceSim performance studies, including some very recent ones.
* [[Improving Performance]] - An old page from July 2009 detailing some performance issues on OpenSim. Some of these issues are still valid (e.g. ODE issues).
* [[NHibernate Performance Testing]] — SQLite and MySQL performance tests with NHibernate.
* [[LibSecondLife performance problems]] - Another old page from November 2007 detailing issues with libsecondlife (now called libopenmetaverse).
* [http://opensim.cybertechnews.org/?p=71 Experiences from Operating a 3D Region Server in OSGrid - Part 1]
* [http://opensim.cybertechnews.org/?p=104 Experiences from Operating a 3D Region Server in OSGrid - Part 2]

==Performance hints==

Here are some specific things you might be able to do to improve performance

===Home Based systems===

The most obvious performance difference between a home based cable/dsl system and a "commercial" server is the upload bandwidth. A typical home system allows 100Kb/s upload with 12Mb/s download, a "commercial" system typically has a "symmetrical" bandwidth of say 12Mb/s UP AND DOWN! "Commercial" systems can essentially buy unlimited bandwidth as needed, but it does get expensive to buy bandwidth that you don't need!

In practice this limits the number of "external" users on a "home system" to 4 or 5, but LAN users (NPCs/bots etc.) are essentially unlimited.

A reasonable strategy (i.e. MY strategy) is to use the home system for experimentation and then move the entire sim to a "commercial" VPS service if the sim gets popular (and produces enough $$$ to pay the freight!)

===Running Squid on your region server as a reverse proxy to the asset server===
1. Download and install the Squid Proxy from: http://www.squid-cache.org/Download/ 
2. Create your [[squid.conf]] configuration file. 
3. Change your asset_server configuration in your OpenSim.ini to point to http://localhost:3128/ 
4. Start everything up! 

Now assets will be cached in the squid cache on the region server, and will be served up much faster, especially on region restart.

=== GC_NO_EXPLICIT ===

Sometimes this patch applied to mono-svn has helped my sim run a lot faster and not slowly get bogged down.

$mono-svn-root$/mono
mono/metadata/boehm-gc.c

<pre>
Index: boehm-gc.c
===================================================================
--- boehm-gc.c (revision 105684)
+++ boehm-gc.c (working copy)
@@ -107,6 +107,10 @@
void
mono_gc_collect (int generation)
{
+ static int no_explicite_gc = 0; if (no_explicite_gc==0) {if (getenv("GC_NO_EXPLICIT")) {no_explicite_gc = 1;return;} else {no_explicite_gc = 2;}} else if (no_explicite_gc==1) {
+ g_print("\n --------GC_NO_EXPLICIT \n");
+ return;
+ }
MONO_PROBE_GC_BEGIN (generation);

GC_gcollect ();
</pre>

Not only this, but I recompile the mono runtime:
<pre>--with-large-heap=yes</pre>

Otherwise, the Sim is limited to 3GB RAM. Probably, this second peice is more important. But still, afterwards it's worth a shot to test with both to see if there is a difference in performance:

export GC_NO_EXPLICIT=1
and
unset GC_NO_EXPLICIT

What I think, (only a guess) is that Mono starts internally GC thrashing in fishing expeditions to gaining maybe 1k of RAM at time. And by having a large heap (>3GB), it is possible might keep mono less apt to do stop world complete collections as often.

Performance

2010-10-26T22:42:37Z

Nihlaeth: /* Hardware Requirements */

{{Template:Quicklinks}}

=Introduction=

OpenSim performance is a very complex issue. Performance can be affected by any number of things, including the number of prims on a region, number of regions, number of avatars, network quality between server and viewer, network quality between simulator and grid services, etc.

==Hardware Requirements==

Unfortunately, this is a very difficult question in light of all the factors mentioned above. Below are some examples of hardware people use/have used. Please feel free to add to the list, or to add any reports to the performance studies and blog posts section. '''These are examples to help you in your selection, not necessarily recommendations.'''

Object Parts ~= # prim

Sensors and Timers are generally more intensive then regular scripts, so please specify quantity of each.

{| border="1"
!Description
!Operating System (please add Mono version if appropriate)
!OpenSim version
!RAM/AVG_USE_%
!CPU
!#/type of regions
!# simultaneous avs
!#scripts/timers/Sensors
!Location
!#objectparts
|-
|hosted Xen VPS
|Ubuntu Intrepid (8.10)
|Unknown
|540MB/?
|1x quad-core 2.5GHz Xeon (L5420)
|1 region + 9 voids
|generally 1-2
|few
|Knifejaw Atoll & surrounding on OSGrid
|?
|-
|hosted Xen VPS
|Ubuntu Jaunty (9.04)
|Unknown
|360MB/?
|2x dual-core 2.0GHz Xeon (5130)
|1 void
|generally 1-2
|none
|Knifejaw Road on OSGrid
|?
|-
|Dedicated Server from A+
|Windows Server 2003
|Unknown
|1 Meg
|1x single-core 2.8GHz Celeron
|2regions per server
|6 at once with no issues
|Waterfalls, texture anims, window texture switchers, lots of sound loops
|Pleasure Planet Welcome center & Region Pleasure Planet in OSGrid
|20000 prims per region
|-
|Amazon EC2 "high-CPU medium instance" (Xen VM)
|Windows Server 2003
|Unknown
|1.7GB
|1x dual-core 2.3GHz (Intel E5345)
|1 region with sailing race course
|7 avs, 4 in boats
|scripted start line
|Castle Rock, OSGrid
|
|-
|Dedicated Server from simhost.com
|SuSe 11.2 x64
|Unknown
|8gb / 50%
|4x Core2Quad Q9300 2.6ghz
|1 region (Wright Plaza) uses approx 4gb ram
|20-25 users
|Freebie Stores / Meeting Center / Video Theater
|@osgrid.org Heavy Use Sim
|17500 prims aprox 1500 scripts
|-
|Home machine
|Windows XP SP3
|0.7.0.1 (Diva r13558)
|3GB / 15-40% incl. Opensim and MySQL
|4x Core2Quad Q6600 2.4 GHz. Use: generally, 0-10%
|11 regions
|1-6 users
|Many scripted objects (1934 scripts)
|[http://zonjacapalini.wordpress.com/2010/08/25/condensation-land-a-status-report/ Condensation Land]
|38,065 prims
|-
|Home machine
|Ubuntu Lucid 10.04 (32 bit pae)
|0.7.0.1 (Diva r13558)
|160Mb no users, add 5Mb/user incl Opensim and MySQL
|I7-920 (dual threaded quad core), 3.8Ghz, 6Gb RAM, 0-10% Load
|4 regions (Diva default config)
|1-4 users (approx 20Kb/sec bandwidth/user)
|Few scripted objects (<10)
|[http://mars-simulator.hobby-site.org:9000/wifi Mars Simulation]- Based on [http://metatek.blogspot.com/2010/06/mars-simulation-for-distribution.html Erik Nauman's Open Blackboard]
|158 prims
|-
|Parallels Virtuozzo Container 4.5
|Win/Net (32 run)
|0.7 (D2)
|320Mb total, incl Opensim and MySQL
|Q6600 Quad, 2.8Ghz, 2Gb RAM, 0-2% Avg Load
|9 regions (3x3 mega-region)
|<6 users
|vehicle scripted objects (<5)
|[http://metaversesailing.com:9000/wifi Metaverse Sailing]
|<1000 prims
|-
|VPS on shared server
|Debian Lenny 5 (mono 2.4.2.3)
|OSgrid 0.7.1 (Dev) cd4d7a7: 2010-10-15
|655MB averabe out of 1722MB RAM, incl. MySQL
|Intel Quadcore 2.5 Ghz (1 core assigned to vps) average use: 40-45%
|20 regions (4x5 mega-region)
|<4 users
|about 20 different light scripts, but we're also experimenting with heavier HUD scripts (timers, lots of ll(Get/Set)PrimitiveParams and large lists) and custom IRC relay
|Phoenix Rising Isles on OsGrid
|3727 prims
|}

==Performance studies and blog posts==

These provide some interesting data on the performance limitations of OpenSim at various points in time.

* [https://lists.berlios.de/pipermail/opensim-users/2010-August/005189.html https://lists.berlios.de/pipermail/opensim-users/2010-August/005189.html] - Some interesting information from Mr Blue. Physical objects and max avatars are limited by single thread performance in OpenSim.
* [http://www.sciencesim.com/wiki/doku.php/vwperf/start http://www.sciencesim.com/wiki/doku.php/vwperf/start] - Links to ScienceSim performance studies, including some very recent ones.
* [[Improving Performance]] - An old page from July 2009 detailing some performance issues on OpenSim. Some of these issues are still valid (e.g. ODE issues).
* [[NHibernate Performance Testing]] — SQLite and MySQL performance tests with NHibernate.
* [[LibSecondLife performance problems]] - Another old page from November 2007 detailing issues with libsecondlife (now called libopenmetaverse).
* [http://opensim.cybertechnews.org/?p=71 Experiences from Operating a 3D Region Server in OSGrid - Part 1]
* [http://opensim.cybertechnews.org/?p=104 Experiences from Operating a 3D Region Server in OSGrid - Part 2]

==Performance hints==

Here are some specific things you might be able to do to improve performance

===Home Based systems===

The most obvious performance difference between a home based cable/dsl system and a "commercial" server is the upload bandwidth. A typical home system allows 100Kb/s upload with 12Mb/s download, a "commercial" system typically has a "symmetrical" bandwidth of say 12Mb/s UP AND DOWN! "Commercial" systems can essentially buy unlimited bandwidth as needed, but it does get expensive to buy bandwidth that you don't need!

In practice this limits the number of "external" users on a "home system" to 4 or 5, but LAN users (NPCs/bots etc.) are essentially unlimited.

A reasonable strategy (i.e. MY strategy) is to use the home system for experimentation and then move the entire sim to a "commercial" VPS service if the sim gets popular (and produces enough $$$ to pay the freight!)

===Running Squid on your region server as a reverse proxy to the asset server===
1. Download and install the Squid Proxy from: http://www.squid-cache.org/Download/ 
2. Create your [[squid.conf]] configuration file. 
3. Change your asset_server configuration in your OpenSim.ini to point to http://localhost:3128/ 
4. Start everything up! 

Now assets will be cached in the squid cache on the region server, and will be served up much faster, especially on region restart.

=== GC_NO_EXPLICIT ===

Sometimes this patch applied to mono-svn has helped my sim run a lot faster and not slowly get bogged down.

$mono-svn-root$/mono
mono/metadata/boehm-gc.c

<pre>
Index: boehm-gc.c
===================================================================
--- boehm-gc.c (revision 105684)
+++ boehm-gc.c (working copy)
@@ -107,6 +107,10 @@
void
mono_gc_collect (int generation)
{
+ static int no_explicite_gc = 0; if (no_explicite_gc==0) {if (getenv("GC_NO_EXPLICIT")) {no_explicite_gc = 1;return;} else {no_explicite_gc = 2;}} else if (no_explicite_gc==1) {
+ g_print("\n --------GC_NO_EXPLICIT \n");
+ return;
+ }
MONO_PROBE_GC_BEGIN (generation);

GC_gcollect ();
</pre>

Not only this, but I recompile the mono runtime:
<pre>--with-large-heap=yes</pre>

Otherwise, the Sim is limited to 3GB RAM. Probably, this second peice is more important. But still, afterwards it's worth a shot to test with both to see if there is a difference in performance:

export GC_NO_EXPLICIT=1
and
unset GC_NO_EXPLICIT

What I think, (only a guess) is that Mono starts internally GC thrashing in fishing expeditions to gaining maybe 1k of RAM at time. And by having a large heap (>3GB), it is possible might keep mono less apt to do stop world complete collections as often.

Talk:OsGetPrimitiveParams

2010-10-26T20:44:59Z

Nihlaeth: New page: Nihlaeth: As far as I can see this function is in fact not implemented. Use results in a syntax error. Is there anyone who has different experiences with this one?

Nihlaeth: As far as I can see this function is in fact not implemented. Use results in a syntax error. Is there anyone who has different experiences with this one?

OSSL Proposals

2010-10-26T20:34:30Z

Nihlaeth: /* OSSL Proposal Table */

__NOTOC__
{{Template:Quicklinks}}

[[Technical Reference | Technical Reference]] -> [[Technical Reference/terms | Terms]] -> [[OSSL Status | OSSL Status]] -> [[OSSL_Proposals | OSSL Proposal List]]

{{proposal}}
{{content}}

=What is OSSL?=

==Introduction==

This is a page dedicated to OpenSim's very own home brew custom scripting language Known as "'''O'''pen '''S'''im '''S'''cripting '''L'''anguage"

<big>'''Please see [[OSSL_Standards|OSSL Standards]] for proposed naming schema'''</big>

* Please post your osFunction along with a brief description of what it would be for, or do and an example of it.
* Make sure it begins with os NOT ll.
* And remember, almost anything within reason can be posted here as an idea, who knows, maybe a variation of your request can be possible.
* If a function could implemented in standard LSL, there is no reason to make an OS function. LSL code and function code executes at the same speed in OpenSim.
== OSSL Proposal Table ==

{| class="sortable" cellpadding="5" cellspacing="0" style="width:100%;border:1px solid #000000;border-collapse: collapse; white-space:normal;"
|- style="background-color:#99CCFF;font-size:6pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| osFunction
| Description
| Example Usage
| Signed
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| list osGetRegionAgentKeys();
| C# Code:
public LSL_List osGetRegionAgentKeys()
{
CheckThreatLevel(ThreatLevel.None, "osGetRegionAgentKeys");
LSL_List result = new LSL_List();
foreach (ScenePresence avatar in World.GetAvatars())
{
result.Add(avatar.UUID);
}
return result;
}

Returns a list of keys for every agent in the region

| list keys=osGetRegionAgentKeys();
integer i; integer l=llGetListLength(keys); string names; for(i=0;i<l;i++) { key id=llList2Key(keys,i); string add=llKey2Name(id); integer dist=llVecDist(llGetPos(),llList2Vector(llGetObjectDetails(id,[OBJECT_POS]),0))); add+="["+(string)dist+"]\n"; names+=add; } llSetText(names,<1,1,1>,1.0);

| Joshua Driver
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| [NEW] various os functions including osDerezObject(), osMessageAgentAttachment(), ...
| see http://opensimulator.org/wiki/User:Athlon_Maurer for full source code
| tested on local opensimulator 0.6.9 (some of them doesnt seem to work on 0.7.x)
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| string osBin(string char);
| To convert a char into its binary value. Will only convert 1 char at a time.
| string bin_a = osBin("A"); // bin_a = "01000001";
| Athlon Maurer (please send me a notecard into secondlife, if that are too much ideas xD, this hint can be deleted by an opensimulator admin, if neccesary xD)
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osHex(integer number);
| To convert a number into its hexadecimal value.
| string str_ff = osHex(255); // str_ff = "FF";
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osAsc(string char);
| To convert a char into its ascii index. Will only convert 1 char at a time.
| integer asc_a = osAsc("A"); // asc_a = 65;
| Athlon Maurer
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osScanRegionRemove();
| Remove an osScanRegionRepeat(). [ nearly the same as llSensorRemove() ]
| osScanRegionRemove();
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| void osScanRegion(string name, key id, integer type);
| Scan the whole region where the script task object is in regardless where it is positioned. Triggers sensor() or no_sensor().
| osScanRegion("", "", AGENT);
| Athlon Maurer
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osScanRegionRepeat(string name, key id, integer type, float rate);
| Scan the whole region where the script task object is in regardless where it is positioned with rate. Triggers sensor() or no_sensor().
| osScanRegionRepeat("", "", AGENT, 15.0);
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| key osGetRegionMapTexture(string RegionName)
| return the map texture uuid for the region named by RegionName.
| llSetTexture(osGetRegionMapTexture("OpenSim Test"), ALL_SIDES);
<math>
create a php file which is public
<?php
 // mapquery.php by Athlon Maurer (SL, OL, OS)
//
// hello, ive just started to learn php/mysql and this is one of my first
// scripts for opensim. this script returns the texture uuid for a given
// region by calling: mapquery.php?region=REGIONNAME
// if a region has been found, it returns that regions map texture uuid,
// otherwise it returns a null key uuid
// mysql connection info is here, please make this more safe
 // region name (do not change this)
$region = htmlspecialchars($_GET['region']);
 // default uuid (do not change this)
$uuid = '00000000-0000-0000-0000-000000000000';
 // your mysql host name (change this)
$dbhost = 'localhost';
 // your mysql user name (change this)
$dbuser = 'root';
 // your mysql user password (change this)
$dbpass = '';
 // your mysql opensim database (change this)
$dbname = 'opensim';
 // try to connect
if ($conn = mysql_connect($dbhost, $dbuser, $dbpass))
{
// try to select
if ($select = mysql_select_db($dbname, $conn))
{
$sql = 'SELECT regionName, regionMapTexture FROM regions';
$result = mysql_query($sql);
while ($row = mysql_fetch_array($result, MYSQL_ASSOC))
{
if ($row['regionName'] == $region)
{
$uuid = $row['regionMapTexture'];
}
}
// free result
mysql_free_result($result);
}
// close connection
mysql_close($conn);
}
// output
echo $uuid;
?>
then llHTTPRequest(</math>

| Athlon Maurer (This function is available as of November 12, 2009)
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osGetLinkPrimitiveParams(integer link, list params);
| Function llSetLinkPrimitiveParams() does exist, but no chance to get params from a prim in a linkset, like llGetPrimitiveParams() and llSetPrimitiveParams().
| list linkparams = osGetLinkPrimitiveParams([PRIM_TYPE, PRIM_TEXTURE, ...]);
| Athlon Maurer (This function is available as of August 09, 2009)
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| void osDerezObject(key object)
| Deletes an InWorld-Object specified by object as uuid. Only successful if the object the script is attached to and the object which should be derezzed is owned by the same owner :). Useful if the object to be deleted should be unscripted.
| osDerezObject("key_of_object");
| Athlon Maurer
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| int osRestartRegion()
| Restarts the region the script is currently in. The script this is run in has to be owned by the master avatar for that region. Returns 1 if the region is restarting, 0 on failure.
| osRestartRegion();
| gryc (Implemented by AFrisby)
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| int osWebTexture()
| Sets the texture from a web-url
| osWebTexture(string url,integer maptype);
| AFrisby?
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osGroupAdd(key, string Role)
| Adds user to a group with given role, default role Everyone. Returns 1 if successful 0 if fail.
| osGroupAdd(87f6e6a0-d884-11dc-95ff-0800200c9a66, "Officer")
| Nitrus Nori
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| int osShutdownRegion()
| Shuts down the region the script is currently in. The script this is run in has to be owned by the master avatar for that region. Returns 1 if the region is going down, 0 on failure.
| osShutdownRegion();
| gryc
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osAttachmentSay(integer channel, string msg)
| Provide a secure, low lag method of communicating between attachments over the chat channels by only sending messages to objects attached to the same avatar. Would fail (or not be heard) if in a non-attached object.
| osAttachmentSay(-20, "detatch");
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osMessageSecure(string message_key, string str, integer num, key id); secure_message(string message_key, string str, integer num, key id);
| Provide a method of sending secure, salt encripted messages sim wide. Messages would only be able to be received by scripts with the matching key in the secure_message method.
| osMessageSecure("myPassPhrase", "Hello World", 0, NULL_KEY);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osSetText( vector color, string text [,vector color, string text]);
| Allow setting of multiple colors on the prim text
| osSetText(<1,0,0>,"Red", <0,1,0>, "\nGreen", <0,0,1>, "\nBlue");
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSensor
| Gets ALL the objects in the specified range not just the first 16
| (same as standard)
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list lst=osDetectObjectsInSim(key id)
| given an Agent Key, provide a list of ALL object owned by that agent
| osDetectObjectsInSim(key id) returning a strided list of [ name, <pos> ]
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer=osDialog([ title, label1, type1, len1, label2, type2, len2]....
| given title and a listing of fields, builds up a real form where to put structured checked data
| will return a [ value1, value2, valuen ] corresponding to fields read. Type might be something like (string, text (multiline), integer, float, currency(decimals), options(combobox)
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| key id=osMakeTextureText(string name,integer width, integer height,[posx1,posy1,font1,color1,size1,text1,posx2,posy2,font2,color2,size2,text2....])
| allow for producing a texture on the fly with desired Font content from a selected font selection. Width, Height in pixels 1024x512 to control how big will be the texture
| will generate a texture with defined text. (Allow some support for at least ISO-8859-1) texture will be created in the object inventory. posx, posy in the range 0-1 to be pixel independent
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osMakeNotecard(string name, [ line1, line2, line3, ...])
| allow creation of new notecards in current object repository
| generate a new asset id useful for storing modified configuration
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer handler=osReadNotecardKey(string notecard, string key)
| allows reading notecards (through dataserver) in format key=value in convenient and efficient way
| ...
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osWriteNotecardKey(string notecard, string key,string value)
| allows WRITING notecards in format key=value in convenient and efficient way. Might be optimized having a fixed record length "file" so to avoid rewriting of the entire notecard
| ...
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer handle=osXMLParser(string xml)
| will activate a listener xmlparser(integer handler,string parent, string field, string value)
| to easily parse xml without writing php external code
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osReturnObjects(key owner, integer type);
| Provide a scriptable method of returning objects from a sim. type would be OBJECT_SCRIPTED, OBJECT_PASSIVE or OBJECT_ALL. Would return a binary Success/Fail, and work inline with land permissions for the script owner.
| osReturnObjects( target, OBJECT_ALL);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osReturnItem(key item);
| Provide a scriptable method of returning individual objects from a sim. Would return a binary Success/Fail, and work inline with land permissions for the script owner.
| osReturnItem(uuid);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSetTimerEvent(integer timer, float rate); (event) timer(integer timer_num)
| Support for multiple timers in a script.
| osSetTimerEvent(2, 0.5);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osTimerOnce(integer timer, float rate);
| Allow for a one shot timer event, rather than the normal repeating heartbeat type
| osTimerOnce(2, 10);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osVerifyScripts();
| Check to see if all scripts in an object are created by the owner of the script calling the function. Return TRUE if they are, FALSE otherwise, to prevent insertion of alien scripts into an object
| if (!osVerifyScripts()) { llDie(); }
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osStopOtherAnimations(list animation_exceptions);
| Provide a method of stopping all animations on an avatar, except those defined in the list
| osStopOtherAnimations(["my_sitting_anim"]);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osPutScriptInLinkedSet(string name,integer linknum, integer starting_parm, integer running)
| Use this to propagate one script to ALL or part of linked set.
| Useful to have all objects in a linked set sharing a common behaviour
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osRezObject(string name, string description, integer permissionmask, list setPrimitiveObjectLikeList) will trigger the object_rez object as usual
| similar to llRezObject, but without the need of having a prim inside the inventory (which produced a lot of problems in deploying and in sl). Newly created object will have the same owner of current object where script is running.
| In case list is empty or position not specified, suitable defaults should apply like pos being 1 m higher in the z axis
| Sal
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osGetOwnerName();
| Provide a method of getting the owner name without having to use llKey2Name
| myName = osGetOwnerName();
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osXMPPOpen(string server, string username, string password, string resource);
| Open an XMPP session to a jabber or other XMPP server, returning a handle to be able to manipulate the connection. Incoming messages to be parsed through a xmpp_message(integer handle, string sender, string service, string message) event. Accounts would have to be set up manually by the scripter, or by some other method, to prevent scripted spamming of a server, and to allow users to set up gateways and other services if needed.
| handle = osXMPPOpen("jabber.org", "MyObject", "MyPassword", "OpenSim");
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osXMPPGetRosta(integer handle);
| Get the rosta from the XMPP server, list in the strided form of [username, presence, resource];
| list presence = osXMPPGetRosta(handle);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osXMPPGetServices(integer handle);
| Get a list of available services from the XMPP Server.
| list services = osXMPPGetServices(handle);
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osXMPPAdd(string username, string service)
| Add a username to the account rosta. Return boolean success or fail
| if (osXMPPAdd("Test User", "Yahoo")) { ... }
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer oxXMPPDelete(string username)
| Remove a username from the account rosta. Return boolean success or fail
| if (osXMPPDelete("Test User")) { ... }
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osXMPPGetStatus(string username);
| Poll the server for the status of a specific username on the rosta - returns would be OFFLINE, BUSY, AWAY and ONLINE
| if (osXMPPGetStatus("Test User") & ONLINE) { ... }
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osXMPPSendMessage(integer handle, string message, string target);
| Send a message via the open XMPP channel, to the specified target. Return boolean success values
| if (osXMPPSendMessage(handle, "Hello World", osGetOwnerName()) { llOwnerSay("Successfully sent message");
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osXMPPClose(integer handle);
| Close the XMPP session
| osXMPPClose();
| Del M
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osRezObjectKey(key object,vector pos,vector vel,rotation rot, int param);
| Basically llGodLikeRezObject[http://lslwiki.net/lslwiki/wakka.php?wakka=llGodLikeRezObject] with the features of llRezObject[http://lslwiki.net/lslwiki/wakka.php?wakka=llRezObject] but for everyone to use. Calls object_rez.
| osRezObjectKey(object_key,llGetPos(),ZERO_VECTOR,llGetRot(),0);
| Tdub
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osRezFromURL(string url, vector pos, vector vel, rotation rot, integer param) - calls on_rez
| Fetch a fragment of xml from a web server and rez its contents in-world as in 'load-xml'. Off or intergrid object repositories, such as objects stored in SVN via websvn, CMS, etc.
| osRezFromURL("http://my.objectstore.com/myawesomeprims.xml", <1, 1, 1>, <0, 0, 0>, <0, 0, 0>, 0)
| Jimbo2120
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osRunCustom(string function, list params)
| Allow scripts to call external custom routines that are grid-specific without modifying the set of LSL and OSL functions.
| list results = osRunCustom("function1", [...])
| Ezekiel
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSetScriptServer()
| Create a 'Server' prim that allows for extended scripting capabilities: more memory, higher bandwidth when communicating with external servers, probably some database connectivity, no artificial delays, can receive IMs, etc. Could be limited to one server per prim / parcel or per avatar, could be forced to remain in a fixed position. A server is important for residents that want to set up a virtual business.
| osSetScriptServer()
| Ezekiel
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osRemoteLoadScript(string url, string target)
| Load a source file in txt format from "URL" and compile it into script "target" in the inventory of the same prim. Requires permission of the object owner (RequestPermission). Returns boolean success value. Replaces an existing script with same name. This function would allow updates to scripted solutions that operate in any grid and sim worldwide, allowing the creator of the solution to distribute code fixes and implement new functions. Since the source code is distributed openly, it can be copied and modified by anyone. A function that would allow for secure code distribution, protecting copyrights and certificates, would also be very interesting but should be far more difficult to implement.
| integer updatestatus = osRemoteLoadScript("http://www.xyz.com/updates/script1013.txt", "betterscript" )
| Ezekiel
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osSetCustomPrimitiveAttributes(list params)
| Set some custom persistent primitive attributes, the same way as llSetPrimitiveParams do. The attribute name has to be specified as a string, then the attribute type using a lSL constant. In the example, we set a "magnet" custom attribute as -0.5, supposing a customized physic engine handles this attribute to provide prim attraction.
| integer osSetCustomPrimitiveAttributes(["magnet", TYPE_FLOAT, -0.5])
| Grumly
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| list osGetCustomPrimitiveAttributes(list paramNames)
| Return a list values of the specified attributes names, the same way as llGetPrimitiveParams do.
| list osGetCustomPrimitiveAttributes(["Magnetic"])
| Grumly
 

|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osSyncUUID(key oldUUID, key newUUID);
| Allows to change the UUID of an avatar or item(requires permission from owner).
| Suppose a terminal in the LL-grid wants to communicate with an OS-Grid terminal. It can only send messages, if the UUID's of avatars match. An OS-Grid script can get the avatar's LL-UUID by calling the dataserver script. Then it calls osSyncUUID(llDetectedKey(0), keyFromHTTPRequest); . Now the two keys are equal, and avatar-avatar communication between grids can take place!
| Phrearch
 

|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osTeleport(string RegionName, int x, int y, int z);
| Teleports an avatar to a custom region
as : osTeleportAgent(key agentId, string regionName, vector position, vector lookAt);

| (this is implemented now - edited April 2009 by Wordfromthe Wise)
| Phrearch
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSetStatus(integer status, integer value);
| Improved verion of the LSL function llSetStatus.
| The function works basically the same way as llSetStatus, except that an extra flag is added named STATUS_PHYSICS_ROOT. When this flag is TRUE, physics would be enabled Only for the root prim in a linked set, while the other prims in the set would behave as phantom. This would be useful for bypassing the 32-prim physics limit for vehicles by using only the root prim as a collision mesh.
| Pesho
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| vector osGetBonePos();
| When called from an Attachment, retrieves the position of the bone it is attached to, in Region Coordinates.
| When llGetPos() is called from an attachment, the vector returned is the one of the avatar center, whereas llGetLocalPos() returns the local offset from the bone it is attached to. It would be useful to know where the attachment's location really is in world space.
| Pesho
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osGetOSLLRelease();
| When called return the actual release of OSSL running on the sim.
| if osGetOSSLRelease() > 1.1 {llSay(0,"good");}
| Sacha Magne
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| List osGetServerLib();
| When called return a list of all the additional libraries loaded on the server. it will avoid any scripts using a specific library to crash in case of missing libs.
| List lib=osGetServerLib();
| Sacha Magne
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osSetAttachmentPoint(integer attachment);
| When called from an Attachment sets the default attachment point to attachment value.
| osSetAttachmentPoint(ATTACH_HUD_BOTTOM_RIGHT);
| Peter
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osMySQLQuery(string query);
| Used to get informations out of a sql database. Works together with osMySQLConnect(), osMySQLSelectDatabase() and osMySQLClose().
| osMySQLQuery("Select name FROM user LIMIT 0,1;");
| Peter
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| string osGetGridName();
| When called it return the hostname of the grid server. Useful to find out what grid you are on.
| string gridHostname = osGetGridHostname();
| Patnad
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| key osName2Key(string avatarname);
| When called it return the key associated with a Avatar Name.
| key avKey = osName2Key("avatar name");
| Patnad
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| vector osParcelCenterpoint(vector pos);
| When called it return the vector that represent the center point of the current parcel. Same height as the object running the script but centerpoint for x,y.
| vector parcel_center = osParcelCenterpoint(llGetPos());
| Patnad
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osSetMapDestination(integer mode, string simname, vector position, vector lookat);
| Sets a new "beacon" (red pole) without opening the worldmap: mode is for 1 (simname is a standard region name) or 0 (simname is a SLURL). If the code can handle standard sim names and SLURL(s) at the same time, the "mode" flag can be left behind.
| integer error = osSetMapDestination(TRUE, "cyberlandia", <128.0, 128.0, 0.0>, ZERO_VECTOR);
 If error is FALSE then no errors have occurred setting up the new beacon.  Errors can arise using unknown simnames/SLURL(s), out of ranges vector coords and so on (nearly the same as llSetMapDestination).

| Elwe Ewing
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osTeleportAgentPerm(key agentId, string regionName, vector position, vector lookAt);
osTeleportAgentPerm(key agentId, vector position, vector lookAt);

| Works similarly as the two implemented osTeleportAgent but requires (at least the first time) the PERMISSION_TELEPORT flag set (via llRequestPermissions(key id, PERMISSION_TELEPORT); which should be implemented) and can be used by everyone (or restricted to a member of the group wich the region is deed, maybe with a new "Restrict teleports" Estate flag).
|
// requests permission to Teleport then do it

key avie = NULL_KEY;

default
{
state_entry()
{
llSay(0, "Touch to be teleported");
}

run_time_permissions(integer vBitPermissions)
{
if(PERMISSION_TELEPORT & vBitPermissions){
osTeleportAgentPerm(avie, <128.0,128.0,0.0>,
ZERO_VECTOR);
} else {
llSay(0, "You deny teleport permission");
}
}

touch_start(integer num_detected)
{
avie = llDetectedKey(0);

llRequestPermissions(avie,
PERMISSION_TELEPORT |
PERMISSION_TRIGGER_ANIMATION |
0);
integer perm = llGetPermissions();
}
}

| Elwe Ewing
|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| osGetSimulatorStatus(string Simulator)
| Extended / Enhanced version of llGetSimulatorData.
Purpose: When an avatar is Teleported with osTeleportAgent, there is no check to see if a given simulator is available. If it's down, Agent is Teleported to NULL resulting in Agent being fragged and viewer broken, requiring a relog. This would be especially useful for HyperGrid Teleporting. Returns: integer "0 = DOWN", "1 = UP", "2 = UNKNOWN" Security: Would require some form of Throttle to prevent recurring requests of destination Simulator. Command: osGetSimulatorStatus(string Simulator) Where Simulator = "RegionName", "IPAddress:PortNum", "HostName:PortNum"

|
// CHecks if simulator is online before teleporting agent -kizmut

string destination = "Wright Plaza";

default
{
state_entry()
{
llSay(0, "Touch to be teleported to: "+destination);
}
touch_start(integer num_detected)
{
llSay(0,llDetectedName(0)+" requesting teleport to: "+destination);
integer sim_stat = osGetSimulatorStatus(destination);
if (sim_stat == 2) {
llSay(0, "Could not teleport to "+destination+": Region status unknown.");
}
else if (sim_stat) {
osTeleportAgent(llDetectedKey(0),destination,ZERO_VECTOR);
}
else {
llSay(0, "Could not teleport to "+destination+": Region is down");
}
}
}

| WhiteStar Magic
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| osTeleportOwner(string regionName, vector position, vector lookAt);
| Works similarly as osTeleportAgent but could only teleport the owner of the script itself. Would be very useful for HUD and would not require any authorization.
| integer error=osTeleportOwner("Snoopies",<100,25,25>,ZERO_VECTOR);
| Agnes Chalet
 

|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| string osName2Key(string name);
| A command which gives the UUID of an agent. Would work in the same way as llKey2Name, but in reverse. (Linden Lab may implement this first)
| osName2Key("Bob Smith");
| Drava
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| integer osHyperGrid();
| Detects whether or not the region the person is in is Hypergrid enabled. Could be expanded to any region in the current grid.
| osHyperGrid() == TRUE
| Drava
|- style="font-size:8pt;border-bottom:1px solid;" valign="top"
| void osTurnAvatar(rotation rot);
| Turns an avatar about the vertical axis to rotation rot relative to the grid rotation.
| osTurnAvatar(newrot); // turns the avatar to the new rotation specified by newrot.
| Valradica

|- style="background-color:#CCFFCC;font-size:8pt;border-bottom:1px solid;" valign="top"
| osRezLink(string inventory, vector position, vector velocity, rotation rot, integer param) ;
| osRezLink would work just like llRezObject but instead of a separate object it would be directly part of the original object's link system. This would be very useful in HUDs and attachments.
| osRezLink("myobject",llGetPos()+<0.0,0.0,0.5>,ZERO_VECTOR,ZERO_ROTATION,10);
| Nihlaeth
|}

----

= See Also =
* [[LSL Status|LSL/OSSL Status Page]]
* LSL
** [[LSL Status/Types|LSL Types Status Page]]
** [[LSL Status/Events|LSL Events Status Page]]
** [[LSL Status/Functions|LSL Functions Status Page]]
** [[LSL_Status/functions/summary | LSL Functions Status Summary]]
** [[LSL_Known_Issues| LSL Known Issues]]
** [[Kan-Ed_Tests| Kan-Ed Tests]]
* OSSL
** [[OSSL Status/Types |OSSL Types Status Page]]
** [[OSSL Status/Events |OSSL Events Status Page]]
** [[OSSL_Proposals | OSSL Proposed Functions]]
** [[OSSL_Implemented | OSSL Implemented Functions]]
** [[OSSL_Standards | OSSL Standards]]
* [[Technical_Reference|Technical Reference Page]]

[[Category:Main]]
[[Category:Users]]
[[Category:Support]]
[[Category:Tech Reference]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting_Started]]
[[Category:Development]]
[[Category:Todo]]