OpenSimulator - User contributions [en]

Talk:LSL osFunctions

2009-08-17T16:10:17Z

Drava:

==Page renaming==

There is an updated page at [[OSSL_Proposals]]. I suggest we use this, because the name of this page doesn't reflect the content(ossl!=lsl). I'll just change the reference on the script status page, and hope everyone agrees. The table on the other page is also updated, and aligns better within the wiki.

-Agreeing with above. I'm tagging the page as Obsolete and leaving a link to the updated page at the top. If anyone wishes to simply delete this page, go right ahead.

== os function vs primitive object model ==

os function is a great idea ! Anyway, knowing c# scripting is possible, I cant prevent myself to dream about a powerfull region/asset/primitives object model which would make possible things like ''Region.GetObject(uuid).Primitives[3].Faces[1].Alpha = .5;'' or ''Region.Restart();'' or ''Region.GetObject(uuid).Primitives[4].Unlink();'' or ''Region.GetObject(uuid).Color = Color.Yellow;'', ''Region.GetObject(uuid).RootPrimitive.HoverText="Hello, Avatar!''... and so on. Just imagine... :p [[User:Grumly|Grumly]] 07:51, 28 December 2007 (PST)

== string osConsole() ==

<s>Why not have a function that enters any string as if you typed it in the console, rather than having seperate ones for everything?</s> -[[User:Cow Taurog|Cow Taurog]] 22:32, 27 December 2007 (PST)
:osConsoleCommand is here as of r3500, or so it says in the revision logs. -[[User:Cow Taurog|Cow Taurog]] 01:56, 18 February 2008 (PST)

== on secure messaging ==

While I do not insist, I have reasons to believe that secure messaging (many people has own opinion about security, and essentially spectrum of definition is wider than one can even imagine) shall be done on client side. Main arguments - control and care about secure methods shall be always at hands of end user, not one server side where it is rather imaginary. [[User:Silpol|Silpol]] 07:31, 28 December 2007 (PST)

Question: Why not implement something like osLoadTexture() and then use osSetTexture ? Loading and applying the texture should be separated to avoid unnecessary multiple downloads. osLoadTexture should also check if the texture is already available in this grid - Ezekiel

Remark: an enhanced type of Dialog that allows to create HTML-like forms is highly desireable. It would require static text, input fields with modifyable default data, selections, formatting, etc. Input and output might be either through structured lists or through tree-like data structures - Ezekiel

NAT Loopback Routers

2009-08-17T01:49:38Z

Drava: Could be potentially a great resource. Needs more info

__NOTOC__

{{Template:Quicklinks}}
{{content}}
 

This page show a list of routers supporting NAT Loopback feature in order to be able to TP in your region when you host it at home on the same computer or local network. Please, feel free to contribute such a list especially if these routers are cheap :D

"D-Link DGL-4xxx series of routers have the largest available nat table of any router on the market"

"These routers range from 70$-180$ USD depending on where you live and purchase from."

* D-Link DGL-4500 : http://games.dlink.com/products/?pid=643
* D-Link DGL-4300 : http://games.dlink.com/products/?pid=370
* D-Link DGL-4100 : http://games.dlink.com/products/?pid=371

Other routers

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf
* Linksys WRT54G : http://en.wikipedia.org/wiki/Linksys_WRT54G_series
* Arris TM502b : http://portforward.com/english/routers/port_forwarding/Arris/TM502b/
* NetGear WGR614 : has been confirmed to work out of the box
(note: NetGear WGR614 does not work with ISP required gateway modems)

Routers that users has experienced problems with

* Belkin F5D7230-4
(the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries
The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network.
<source lang=bash>
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback | OpenWRT NAT Loopback]]

OSSL Proposals

2009-08-16T21:04:38Z

Drava: Minor error

__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"
| 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("http://www.yourserver.com/phpfile.php?region=" + llEscapeURL("OpenSim Test"), [HTTP_METHOD, "GET"], "");
the http_response event will return the uuid for the map texture in body, which can be used with llSetTexture() or other functions
</math>

| Athlon Maurer

|- 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

|- 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.
Command: osGetSimulatorStatus(string Simulator)
Where Simulator = "RegionName", "IPAddress:PortNum", "HostName:PortNum"
Returns: integer "0 = DOWN", "1 = UP", "2 = UNKNOWN"
Security: Would require some form of Throttle to prevent recurring requests of destination Simulator.
|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
|}

----

= See Also =

* [[Status|Main Status Page]]
* [[OSSL Status|OSSL Status]]
* [[OSSL Status/Events|OSSL Events Status]]
* [[OSSL Status/Functions|OSSL Functions Status]]
* [[LSL Status/Events|LSL Events Status]]
* [[LSL Status/Functions|LSL Functions Status]]
* [[LSL_Status/functions/summary | LSL Functions Status Summary]]
* [[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]]

OSSL Proposals

2009-08-16T21:03:01Z

Drava: osHyperGrid

__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"
| 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("http://www.yourserver.com/phpfile.php?region=" + llEscapeURL("OpenSim Test"), [HTTP_METHOD, "GET"], "");
the http_response event will return the uuid for the map texture in body, which can be used with llSetTexture() or other functions
</math>

| Athlon Maurer

|- 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

|- 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.
Command: osGetSimulatorStatus(string Simulator)
Where Simulator = "RegionName", "IPAddress:PortNum", "HostName:PortNum"
Returns: integer "0 = DOWN", "1 = UP", "2 = UNKNOWN"
Security: Would require some form of Throttle to prevent recurring requests of destination Simulator.
|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

----

= See Also =

* [[Status|Main Status Page]]
* [[OSSL Status|OSSL Status]]
* [[OSSL Status/Events|OSSL Events Status]]
* [[OSSL Status/Functions|OSSL Functions Status]]
* [[LSL Status/Events|LSL Events Status]]
* [[LSL Status/Functions|LSL Functions Status]]
* [[LSL_Status/functions/summary | LSL Functions Status Summary]]
* [[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]]

User:Drava

2009-08-15T15:04:28Z

Drava: New page: Hello, Brand new here but I support the project and wanted to contribute with my suggestions

Hello,

Brand new here but I support the project and wanted to contribute with my suggestions

Money

2009-08-15T15:00:49Z

Drava: Web Transactions and sim-based fake money??

__NOTOC__
{{Template:Quicklinks}}
 

{{proposal}}
This page is intended as an open discussion board for ideas regarding an in-world financial system - Ezekiel.

== OpenSim, Applications and Money ==
The OpenSim project does not consider providing any kind of functioning monetary system within its scope. Doing so is entirely up to the service provider, as that provider has to be the source of the trust associated with monetary transactions.

The OpenSim platform will provide whatever protocol hooks necessary to implement a monetary system, and reference implementations for demonstration purposes, but not actual implementations of functioning monetary systems. It is essential to understand this when discussing what OpenSim can do with respect to monetary systems.

== Motivation ==
In order to be successful, any new world simulator needs to allow for financial transactions. While many residents enjoy the creative and social aspects of virtual life, others are there to provide them with the necessary means - and usually intend to be compensated.
Metaverses without a business component (allowing residents to make money) depend largely on the creativity of the makers and tend to fall into disuse as soon as competitive simulators with better graphics and better entertainment come along (e.g. Active Worlds).

== Play Money vs. Serious Money ==
There are two types of financial systems and currencies: one is purely an in-world affair (play money) and supports roleplay, the other is convertible into hard currencies (serious money).
While it is commonly agreed that implementing a serious in-world currency system (with all the security implications) is out of scope at least for the current phase of the OpenSim development project, there are still some functional decisions to be made.

There are several possible ways of handling money in a grid:
* no money support
* in-world play money for roleplay
* in-world currency supported, protected and converted by the grid owner (like SL)
* off-world payment implementation, no in-world currency
* in-world play money plus off-world payment capabilities (might be confusing)

OpenSim should allow for an implementation of any of those alternatives.

== Off-World Implementation ==
These are crucial in-world functions for off-world financial transactions:
* put a price tag on a prim, specifying amount and currency
* notification event (LSL) that resident X agrees to buy item / pay amount Y.

These functions are not crucial, since they may be implemented off-world:
* an in-world currency (use an internet payment provider or an e-currency instead)
* avatar account (use an internet payment provider or an e-currency instead)
* receive payment (can be handled off-world through osLoadURL - for most providers)
* give money (can be handled off-world through osHTTPRequest - for some providers)
* notify avatar of payment (can be done through IM or e-Mail)

== Wallet Plugin ==
It occurs to me that perhaps it isn't the job of the grid to keep track of every avatars financial transactions. Perhaps this should be left to banks and other financial organizations. I'm thinking that perhaps OpenSim should pull the money out of the grid and develop an independent bank server. Avatars could choose which "wallet" or "bank" to use for a transaction.

== A Different Idea ==

'''A Currency that Pays a Divident'''

The OpenSim project should have a currency that pays a divident. If users earn a divident just by using the game currency this will be a great incentive not only to participate in the game but also to use the currency in real life. Thus this increases the possibility that a market of things of value will develop in the game and maybe the currency will be used for real life transactions as well. A currency that pays a divident will prevail over any other form of virtual currency by means of the strategic advantage of directly benefiting the user. Convertibility to real currencies will depend solely on free market ability of the currency to provide goods and services and not some convertibility obligation undertaken by the company that hosts the server.

Implementing a currency that produces a divident would require suitable financial institutions, capital markets, and a mechanism to liquidate a part of current value of financial instruments. Through liquidating a sustainable part of current value of financial instruments the company that hosts the server would earn the game money funds which when converted to real currency would pay for its operational costs plus the funds needed to pay a divident. It would be in the best interest of the company that hosts the server to ensure that the financial structure operates efficiently for the benefit of the users so that the game currency has maximum value of convertibility to real life currencies.

The financial structure required could be as follows:

'''1. Central Bank'''

THe Central Bank would oversee the monetary volume, the amount to be liquidated and the keeping of individual money accounts of users free of charge but free of interest as well.

- All users would be shareholders to the Central Bank, owning no more and no less than one share each

- The monetary volume would be a fixed amount of currency for each share, say 100.000 units, which would be the nominal value of the Central Bank share.

- All financial transactions of users, Investment Banks and Capital Markets would be processed through the Central Bank's server software and console

- The Central Bank will determine how much of Investment Bank's current stock value must be held in liquid reserves

- The Central Bank will determine how much of those liquid reserves will be contributed to the Special Account in order to be distributed to the users as divident and to the company that hosts the server

- The Central Bank will have the power to dispense payments through the Special Account to the company that hosts the server, to shareholders and to in-game political institutions such as elected moderators

- Ideally the Central Bank management would be ellected by users, even better by Invesment Bank managers

- Any increase or decrease in monetary volume would be achieved solely by depositing or withdrawing funds to/from each user's account

'''2. Investment Banks'''

The Investment Banks would be the main user operated financial institution.

- They would be the only financial instrument users would be able to directly buy shares of.

- They would be the only vehicle available for investment in Capital Markets.

- They would be able to structure and trade financial instruments through the Central Bank console

- They would be able to lend money for projects

- Any user or group of users would able to open an Investment Bank through a console provided by the Central Bank if they provide capital equal to say 10 Central Bank Shares worth

- An individual who wants to trade the financial markets with his own money, should come up with enough capital to open an Investment Bank

- Investment Banks would freely be able to raise capital by issuing shares

- Their shares would be floated and traded in a separate market than Capital Markets through the Central Bank console

- They would be under obligation to keep a part of their investment portfolio in cash so the Central Bank can deduct a contribution to the Special Account

- The holdings in their investment portfolio would be open for every interested investor to audit

'''3. Capital markets'''

These would be the Exchanges where financial instruments are traded

- The Central Bank would provide the console for the Exchanges and handle the payments

- Anything of value could be traded on the Exchanges

- The financial instruments would be structured freely by the Investment Banks

- Individual loans would be structured as financial instruments and traded freely

- The coding of financial instruments would be open for everyone to audit

- An Exchange would be a user-managed institution, the user-managers would be able to charge a commision on transactions as compensation for managing the exchange

- The Exchanges would all be interconected, so the most efficient ones get the most business

'''Supporting Environment'''

The financial structure's legitimacy and effectiveness would benefit the most by a functional political proccess within the game and the development of legal and political institutions that would oversee its implementation. In this way the company that hosts the server would have relegated most of the work too the user community. In a maybe utopian scenario the company itself could be owned by the users. A lot of reated economic activity could evolve alongside the main structure such as auditing companies, programmers etc

'''Kickstarting a Project'''

Once the software is implemented as above this could evolve as essentially a game where the collective purpose of the users would be to develop and increase the value of the game currency and spread its use. A group of people willing to kickstart such a project would need to set up a server and a rudimentary mechanism to buy and sell shares to the Central Bank and thus opening user accounts. Integration with a payment system such as Paypal would help. A new user would be able to either:

- use real money to buy enough in-game currency from other users or the central bank as a provider of last resort to purchase his share to the Central Bank and so be entitled to a divident

- or start free and offer services or anything of value in-game so as to accumulate enough in-game currency to buy his share in the Central Bank and then be entitled to a divident

When a new user opens an account and purchases his share to the Central Bank, new in-game money is created up to the value of one Central Bank share. If he buys his share, the money is deposited in his account. If he does not buy a share and starts free the money is deposited to the Special Account for the benefit of all users. In this way the monetary volume is increased as new users come in and all all users benefit from attracting new users. A de facto mechanism for the convertibility of the in-game currency would thus be achieved and setting up a server for the game could prove profitable. Ideally various groups would be able to start different projects but all grids should be interconnected and maybe their currencies floated on a common exchange

== Simplest In-Grid Money ==

A unique avatar creates objects that may not be copied, may not be modified, but may be transferred. The object permission, and asset storage code of OpenSimulator must be very robust and dependable. The names of the objects are something like "1-gazoon," "2-gazoons," "5-gazoons," "10-gazoons," "20-gazoons," etc. Players agree to treat these objects as money and trade them. Making change will be a pain at times. The reason that the unique avatar gives "gazoon" objects to other avatars is left as an exercise for the reader.

== Web Transactions ==

We could also simply use external websites to sell objects in real world money (dollars, euros etc.). With the current advances in the in-world web browser, it shouldn't be too difficult and shouldn't take up too much time. Theres also the advantage of a decrease in fraud and there would no longer be a concern for the rise and dropping of L$ prices. Of course, the website would be the responsibility of the grid-owner. In terms of "fake currency", we would use the current implemented system (the L$ functions) and use it as fake/roleplaying money on a simulator level (meaning that it would be functional in only some sims and the sim owner would have control over the name of the currency and how it is distributed).

== Reference Implementations ==

There are currently two projects in forge that provide reference implementations for currency in OpenSim. They are both very experimental and should not be used in a production environment or with real money. They can be found at

* [http://forge.opensimulator.org/gf/project/opencurrency/ OpenCurrency]
* [http://forge.opensimulator.org/gf/project/currency/ Currency]