OpenSimulator - User contributions [en]

Accessing Prim Properties

2025-04-07T15:08:14Z

JeffKelley: Copy-paste error

{{Quicklinks|Accessing_Prim_Properties}}
 

==A bit of history==

First, there was llSetColor.

Then, there was llSetLinkColor. That was a huge step forward, since it was releaving you from the burden to script each and every prim in your hair. Don't laugh. You may still find such blatantly outdated scripts on the Hypergrid. Do us a favor. Don't propagate them. Trash them. Rewrite them.

Later, it was recognized that the ability to access every property of a prim in a linkset from a master script was a Good Thing. It makes your application simpler to understand and to maintain, and helps reduce script count. llSetLinkPrimitiveParams was born.

Finally, OpenSimulator added it's own touch. Why not manipulate prims ''outside'' the linkset from a master script ? And we had osSetPrimitiveParams.

llGet/SetLinkPrimitiveParams, osGet/SetPrimitiveParams are the workhorse of prim manipulations. You can access every existing property of a prim from a centralized location. Streamlined, faster code. No more need for chat, or LinkedMessages between prims.

A special note about llGetObjectLinkKey : Introduced September, 2022, this function is the glue you need to access prims outside the linkset. Once you get the id of an external object (maybe using llSensor), you may call llGetObjectPrimCount (also consider osGetPrimCount which does not count sitting avatars) then iterate on llGetObjectLinkKey to get the id of each prim in the remote object. Finally, apply osGet/SetPrimitiveParams.

The following tables tries to sort out the functions available to manipulate prims, for each addressing method.

{| class="wikitable" style="margin:auto;text-align:center"
|-
! Target is script's host (prim containing the script)
! Target is link number (any prim in the linkset)
! Target is prim id (any prim you own in the scene)
|-
| llGetOwner || ||
|-
| llGetKey || llGetLinkKey(num) ||
|-
| llSetText || ||
|-
| llGetRot / llSetRot || ||
|-
| llGetScale / llSetScale || ||
|-
| llGetAlpha / llSetAlpha || llSetLinkAlpha(num) ||
|-
| llGetColor / llSetColor || llSetLinkColor(num) ||
|-
| llGetPos / llSetPos || ||
|-
| llGetObjectName / llSetObjectName || llGetLinkName(num) ||
|-(num)
| llGetObjectDesc / llSetObjectDesc || ||
|-
| llGetNumberOfSides || llGetLinkNumberOfSides(num) ||
|-
| llGetTexture / llSetTexture || llSetLinkTexture(num) ||
|-
| llSetTextureAnim || llSetLinkTextureAnim(num) ||
|-
| llParticleSystem || llLinkParticleSystem(num) ||
|-
| llSetPrimMediaParams || llSetLinkMedia(num) ||
|-
| || || llGetObjectPrimCount(uuid)
|-
| || || llGetObjectDetails(uuid)
|-
| || || llGetObjectLinkKey(uuid,num)
|-
!colspan="3" | "Universal" access (list of rules)

|-
| llGet/SetPrimitiveParams || llGet/SetLinkPrimitiveParams(num) || osGet/SetPrimitiveParams(uuid)
|}
 

==Example : A replicator==
Put this script in a box, along with a single-prim object named "seed". It will iterate on each prim of a named object you own in the scene, then rez an identical prim at a given offset, perfectly replicating the source object, even meshes. Sleeps are here for demo. Remove them for speedy replication. CLEANUP option will get rid of rezed prims.
<source lang="lsl">
string targetName = "Example"; // The name of an object you own in the scene
string seedName = "seed"; // Name of the seed prim
vector offset = <5,0,0>; // Offset of the dupicata

integer primcnt;
integer primnum;
key rootKey;

integer TupleLength (integer param)
{
if (param == PRIM_GLOW) return 1;
if (param == PRIM_COLOR) return 2;
if (param == PRIM_TEXGEN) return 1;
if (param == PRIM_TEXTURE) return 4;
if (param == PRIM_NORMAL) return 4;
if (param == PRIM_SPECULAR) return 7;
if (param == PRIM_BUMP_SHINY) return 2;
if (param == PRIM_FULLBRIGHT) return 1;

return 0; // Not a by-side parameter
}

list IterateFaces (list p, integer param)
{
integer tuplelength = TupleLength (param);
integer numsides = llGetListLength(p) / tuplelength;

// Une seule face, retourner [ param, ALL_SIDES, p ]
if (numsides == 1) return [ param, ALL_SIDES ] + p;

list result = [ ];
for (integer s=0; s<numsides; s++) {
list tuple = llList2List (p, s*tuplelength, (s+1)*tuplelength-1);
result += [ param, s ] + tuple;
}
return result;
}

CopyParams (key srcprim, key dstprim, integer param) {
if (TupleLength(param) == 0)
{
list p = osGetPrimitiveParams (srcprim, [ param ]);
if (param == PRIM_POSITION) p = [ llList2Vector (p,0) + offset ];
osSetPrimitiveParams (dstprim, [ param ] + p);
}
else
{
list p = osGetPrimitiveParams (srcprim, [ param, ALL_SIDES ]);
p = IterateFaces (p, param);
osSetPrimitiveParams (dstprim, p);
}
llSleep (0.1);
}

RezAPrim ()
{
if (++primnum > primcnt) llResetScript();
llRezObject (seedName, llGetPos()+<0,0,1>, ZERO_VECTOR, ZERO_ROTATION, 0);
}

PrimRezed (key dstkey)
{
llOwnerSay ("Processing link "+(string)primnum+" of "+(string)primcnt);
key srckey = llGetObjectLinkKey (rootKey, primnum);
llSleep (0.1);

CopyParams (srckey, dstkey, PRIM_POSITION);
CopyParams (srckey, dstkey, PRIM_ROTATION);
CopyParams (srckey, dstkey, PRIM_TYPE);
CopyParams (srckey, dstkey, PRIM_SIZE);
CopyParams (srckey, dstkey, PRIM_COLOR);
CopyParams (srckey, dstkey, PRIM_TEXTURE);
CopyParams (srckey, dstkey, PRIM_NORMAL);
CopyParams (srckey, dstkey, PRIM_SPECULAR);
CopyParams (srckey, dstkey, PRIM_TEXGEN);
CopyParams (srckey, dstkey, PRIM_BUMP_SHINY);
CopyParams (srckey, dstkey, PRIM_FULLBRIGHT);
CopyParams (srckey, dstkey, PRIM_PHYSICS_SHAPE_TYPE);

RezAPrim ();
}

key OwnerOf (key id)
{
list l = llGetObjectDetails (id, [ OBJECT_OWNER ]);
return llList2Key (l, 0);
}

default
{
state_entry()
{
llSetText ("READY", <0,1,0>, 1.0);
}

touch_start (integer n)
{
state dialog;
}
}

integer dlgchan = 99;
integer dlglistener;
state dialog
{
state_entry()
{
llSetText ("LISTENING", <0,1,0>, 1.0);
llDialog (llGetOwner(), "Action?", ["CLEANUP", "REPLICATE"], dlgchan);
dlglistener = llListen (dlgchan, "", llGetOwner(), "");
llSetTimerEvent (10);
}

listen (integer chan, string name, key id, string msg)
{
if (msg == "CLEANUP") state cleanup;
if (msg == "REPLICATE") state replicate;
}

timer ()
{
state default;
}

state_exit ()
{
llSetTimerEvent (0.0);
llListenRemove (dlglistener);
}
}

state cleanup
{
state_entry()
{
llSetText ("CLEANUP", <0,1,0>, 1.0);
llSensor (seedName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
llOwnerSay ("Garbage collecting "+(string)num);
for (integer i=0; i<num; i++) osDie (llDetectedKey(i));
state default;
}

no_sensor() {
llOwnerSay ("All clean.");
state default;
}
}

state replicate
{
state_entry()
{
llSetText ("REPLICATE", <0,1,0>, 1.0);
llSensor (targetName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
rootKey = llDetectedKey (0);

if (OwnerOf(rootKey) != llGetOwner())
{
llOwnerSay ("I don't own "+targetName+". Aborting.");
state default;
}

primcnt = llGetObjectPrimCount (rootKey);
primnum = 0; RezAPrim ();
}

no_sensor() {
llOwnerSay ("Object "+targetName+" was not found.");
state default;
}

object_rez (key uuid) {
PrimRezed (uuid);
}
}
</source>

==Writing accessors==

The Get/SetPrimitiveParams family of functions is awesomely powerful. It is also [https://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast quite arcane to write and decipher]. A way to get rid of these long lists of parameters cluttering your code is to encapsulate Get/SetPrimitiveParams in individual get/set accessors, actually 'filling the blanks' in the above table. Although this is much pleasant to read, note that doing so may hurt performance when you want to change many properties at once, which SetPrimitiveParams can do in one call. The following library is offered as an example.

<source lang="lsl">
// Index of properties for PRIM_TYPE_BOX, PRIM_TYPE_CYLINDER, PRIM_TYPE_PRISM

integer INDEX_TYPE = 0;
integer INDEX_HOLE = 1;
integer INDEX_CUT = 2;
integer INDEX_HOLLOW = 3;
integer INDEX_TWIST = 4;
integer INDEX_TAPER = 5;
integer INDEX_SHEAR = 6;

// Index of properties for PRIM_TEXTURE

integer INDEX_TEXTURE = 0;
integer INDEX_REPEATS = 1;
integer INDEX_OFFSETS = 2;
integer INDEX_ROTATION = 3;

// client script
// +---------------+------------+
// Taper | -1.0 0 +1.0 | 2.0 0.0 |
// Shear | -0.5 0 +0.5 | -0.5 +0.5 |
// Twist | -180 0 +180 | -1.0 +1.0 |
// +---------------+------------+

//
// Set accessors
//

mySetLinkName (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_NAME, text]);
}

mySetLinkDesc (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_DESC, text]);
}

mySetLinkText (integer link, string text, vector color) {
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXT, text, color, 1.0]);
}

mySetLinkColor (integer link, vector color, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_COLOR, face, color, 1.0]);
}

mySetLinkBright (integer link, integer bright, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_FULLBRIGHT, face, bright]);
}

mySetLinkGlow (integer link, float glow, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_GLOW, face, glow]);
}

// Les 3 suivants ne marchent pas pour ALL_SIDES

mySetLinkTexture (integer link, key texture, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [texture], INDEX_TEXTURE, INDEX_TEXTURE);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkRepeat (integer link, vector repeat, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [repeat], INDEX_REPEATS, INDEX_REPEATS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkOffset (integer link, vector offset, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [offset], INDEX_OFFSETS, INDEX_OFFSETS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkPos (integer link, vector pos) {
llSetLinkPrimitiveParamsFast (link, [PRIM_POS_LOCAL, pos]);
}

mySetLinkRot (integer link, rotation rot) {
llSetLinkPrimitiveParamsFast (link, [PRIM_ROT_LOCAL, rot]);
}

mySetLinkSize (integer link, vector size) {
llSetLinkPrimitiveParamsFast (link, [PRIM_SIZE, size]);
}

mySetLinkCut (integer link, vector cut) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [cut], INDEX_CUT, INDEX_CUT);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTwist (integer link, vector twist) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [twist], INDEX_TWIST, INDEX_TWIST);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTaper (integer link, vector taper) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [taper], INDEX_TAPER, INDEX_TAPER);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkShear (integer link, vector shear) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [shear], INDEX_SHEAR, INDEX_SHEAR);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkHollow (integer link, float hollow) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [hollow], INDEX_HOLLOW, INDEX_HOLLOW);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

//
// Get accessors
//

string myGetLinkName (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_NAME]);
return llList2String (l,0);
}

string myGetLinkDesc (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_DESC]);
return llList2String (l,0);
}

string myGetLinkText (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXT]);
return llList2String (l,0);
}

vector myGetLinkColor (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_COLOR, face]);
return llList2Vector (l,0);
}

integer myGetLinkBright (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_FULLBRIGHT, face]);
return llList2Integer (l,0);
}

float myGetLinkGlow (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_GLOW, face]);
return llList2Float (l,0);
}

key myGetLinkTexture (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Key(l,0);
}

vector myGetLinkRepeat (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,1);
}

vector myGetLinkOffset (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,2);
}

vector myGetLinkPos (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_POS_LOCAL]);
return llList2Vector (l,0);
}

vector myGetLinkSize (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_SIZE]);
return llList2Vector (l,0);
}

vector myGetLinkCut (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_CUT);
}

vector myGetLinkTwist (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TWIST);
}

vector myGetLinkTaper (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TAPER);
}

vector myGetLinkShear (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_SHEAR);
}

float myGetLinkHollow (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Float (l, INDEX_HOLLOW);
}
</source>
LL accessors can be effortlessly converted to OS versions. Just change prim_num to prim_key in argument list, and pick the right os/ll function. Finally, you can use function overloading to write universal routines :
<source lang="lsl">
SetPrimColor (key prim, vector color, integer side)
{
osSetPrimitiveParams (prim, [PRIM_COLOR, side, color, 1.0]);
}

SetPrimColor (integer prim, vector color, integer side)
{
llSetLinkPrimitiveParamsFast (prim, [PRIM_COLOR, side, color, 1.0]);
}
</source>

[[Category:Scripting]]
[[Category:Scripts]]
[[Category:OSSL]]

Accessing Prim Properties

2025-04-07T15:07:14Z

JeffKelley: Clarification

{{Quicklinks|Accessing_Prim_Properties}}
 

==A bit of history==

First, there was llSetColor.

Then, there was llSetLinkColor. That was a huge step forward, since it was releaving you from the burden to script each and every prim in your hair. Don't laugh. You may still find such blatantly outdated scripts on the Hypergrid. Do us a favor. Don't propagate them. Trash them. Rewrite them.

Later, it was recognized that the ability to access every property of a prim in a linkset from a master script was a Good Thing. It makes your application simpler to understand and to maintain, and helps reduce script count. llSetLinkPrimitiveParams was born.

Finally, OpenSimulator added it's own touch. Why not manipulate prims ''outside'' the linkset from a master script ? And we had osSetPrimitiveParams.

llGet/SetLinkPrimitiveParams, osGet/SetPrimitiveParams are the workhorse of prim manipulations. You can access every existing property of a prim from a centralized location. Streamlined, faster code. No more need for chat, or LinkedMessages between prims.

A special note about llGetObjectLinkKey : Introduced September, 2022, this function is the glue you need to access prims outside the linkset. Once you get the id of an external object (maybe using llSensor), you may call llGetObjectPrimCount (also consider osGetPrimCount which does not count sitting avatars) then iterate on llGetObjectLinkKey to get the id of each prim in the remote object. Finally, apply osGet/SetPrimitiveParams.

The following tables tries to sort out the functions available to manipulate prims, for each addressing method.

{| class="wikitable" style="margin:auto;text-align:center"
|-
! Target is script's host (prim containing the script)
! Target is link number (any prim you own the linkset)
! Target is prim id (any prim you own in the scene)
|-
| llGetOwner || ||
|-
| llGetKey || llGetLinkKey(num) ||
|-
| llSetText || ||
|-
| llGetRot / llSetRot || ||
|-
| llGetScale / llSetScale || ||
|-
| llGetAlpha / llSetAlpha || llSetLinkAlpha(num) ||
|-
| llGetColor / llSetColor || llSetLinkColor(num) ||
|-
| llGetPos / llSetPos || ||
|-
| llGetObjectName / llSetObjectName || llGetLinkName(num) ||
|-(num)
| llGetObjectDesc / llSetObjectDesc || ||
|-
| llGetNumberOfSides || llGetLinkNumberOfSides(num) ||
|-
| llGetTexture / llSetTexture || llSetLinkTexture(num) ||
|-
| llSetTextureAnim || llSetLinkTextureAnim(num) ||
|-
| llParticleSystem || llLinkParticleSystem(num) ||
|-
| llSetPrimMediaParams || llSetLinkMedia(num) ||
|-
| || || llGetObjectPrimCount(uuid)
|-
| || || llGetObjectDetails(uuid)
|-
| || || llGetObjectLinkKey(uuid,num)
|-
!colspan="3" | "Universal" access (list of rules)

|-
| llGet/SetPrimitiveParams || llGet/SetLinkPrimitiveParams(num) || osGet/SetPrimitiveParams(uuid)
|}
 

==Example : A replicator==
Put this script in a box, along with a single-prim object named "seed". It will iterate on each prim of a named object you own in the scene, then rez an identical prim at a given offset, perfectly replicating the source object, even meshes. Sleeps are here for demo. Remove them for speedy replication. CLEANUP option will get rid of rezed prims.
<source lang="lsl">
string targetName = "Example"; // The name of an object you own in the scene
string seedName = "seed"; // Name of the seed prim
vector offset = <5,0,0>; // Offset of the dupicata

integer primcnt;
integer primnum;
key rootKey;

integer TupleLength (integer param)
{
if (param == PRIM_GLOW) return 1;
if (param == PRIM_COLOR) return 2;
if (param == PRIM_TEXGEN) return 1;
if (param == PRIM_TEXTURE) return 4;
if (param == PRIM_NORMAL) return 4;
if (param == PRIM_SPECULAR) return 7;
if (param == PRIM_BUMP_SHINY) return 2;
if (param == PRIM_FULLBRIGHT) return 1;

return 0; // Not a by-side parameter
}

list IterateFaces (list p, integer param)
{
integer tuplelength = TupleLength (param);
integer numsides = llGetListLength(p) / tuplelength;

// Une seule face, retourner [ param, ALL_SIDES, p ]
if (numsides == 1) return [ param, ALL_SIDES ] + p;

list result = [ ];
for (integer s=0; s<numsides; s++) {
list tuple = llList2List (p, s*tuplelength, (s+1)*tuplelength-1);
result += [ param, s ] + tuple;
}
return result;
}

CopyParams (key srcprim, key dstprim, integer param) {
if (TupleLength(param) == 0)
{
list p = osGetPrimitiveParams (srcprim, [ param ]);
if (param == PRIM_POSITION) p = [ llList2Vector (p,0) + offset ];
osSetPrimitiveParams (dstprim, [ param ] + p);
}
else
{
list p = osGetPrimitiveParams (srcprim, [ param, ALL_SIDES ]);
p = IterateFaces (p, param);
osSetPrimitiveParams (dstprim, p);
}
llSleep (0.1);
}

RezAPrim ()
{
if (++primnum > primcnt) llResetScript();
llRezObject (seedName, llGetPos()+<0,0,1>, ZERO_VECTOR, ZERO_ROTATION, 0);
}

PrimRezed (key dstkey)
{
llOwnerSay ("Processing link "+(string)primnum+" of "+(string)primcnt);
key srckey = llGetObjectLinkKey (rootKey, primnum);
llSleep (0.1);

CopyParams (srckey, dstkey, PRIM_POSITION);
CopyParams (srckey, dstkey, PRIM_ROTATION);
CopyParams (srckey, dstkey, PRIM_TYPE);
CopyParams (srckey, dstkey, PRIM_SIZE);
CopyParams (srckey, dstkey, PRIM_COLOR);
CopyParams (srckey, dstkey, PRIM_TEXTURE);
CopyParams (srckey, dstkey, PRIM_NORMAL);
CopyParams (srckey, dstkey, PRIM_SPECULAR);
CopyParams (srckey, dstkey, PRIM_TEXGEN);
CopyParams (srckey, dstkey, PRIM_BUMP_SHINY);
CopyParams (srckey, dstkey, PRIM_FULLBRIGHT);
CopyParams (srckey, dstkey, PRIM_PHYSICS_SHAPE_TYPE);

RezAPrim ();
}

key OwnerOf (key id)
{
list l = llGetObjectDetails (id, [ OBJECT_OWNER ]);
return llList2Key (l, 0);
}

default
{
state_entry()
{
llSetText ("READY", <0,1,0>, 1.0);
}

touch_start (integer n)
{
state dialog;
}
}

integer dlgchan = 99;
integer dlglistener;
state dialog
{
state_entry()
{
llSetText ("LISTENING", <0,1,0>, 1.0);
llDialog (llGetOwner(), "Action?", ["CLEANUP", "REPLICATE"], dlgchan);
dlglistener = llListen (dlgchan, "", llGetOwner(), "");
llSetTimerEvent (10);
}

listen (integer chan, string name, key id, string msg)
{
if (msg == "CLEANUP") state cleanup;
if (msg == "REPLICATE") state replicate;
}

timer ()
{
state default;
}

state_exit ()
{
llSetTimerEvent (0.0);
llListenRemove (dlglistener);
}
}

state cleanup
{
state_entry()
{
llSetText ("CLEANUP", <0,1,0>, 1.0);
llSensor (seedName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
llOwnerSay ("Garbage collecting "+(string)num);
for (integer i=0; i<num; i++) osDie (llDetectedKey(i));
state default;
}

no_sensor() {
llOwnerSay ("All clean.");
state default;
}
}

state replicate
{
state_entry()
{
llSetText ("REPLICATE", <0,1,0>, 1.0);
llSensor (targetName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
rootKey = llDetectedKey (0);

if (OwnerOf(rootKey) != llGetOwner())
{
llOwnerSay ("I don't own "+targetName+". Aborting.");
state default;
}

primcnt = llGetObjectPrimCount (rootKey);
primnum = 0; RezAPrim ();
}

no_sensor() {
llOwnerSay ("Object "+targetName+" was not found.");
state default;
}

object_rez (key uuid) {
PrimRezed (uuid);
}
}
</source>

==Writing accessors==

The Get/SetPrimitiveParams family of functions is awesomely powerful. It is also [https://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast quite arcane to write and decipher]. A way to get rid of these long lists of parameters cluttering your code is to encapsulate Get/SetPrimitiveParams in individual get/set accessors, actually 'filling the blanks' in the above table. Although this is much pleasant to read, note that doing so may hurt performance when you want to change many properties at once, which SetPrimitiveParams can do in one call. The following library is offered as an example.

<source lang="lsl">
// Index of properties for PRIM_TYPE_BOX, PRIM_TYPE_CYLINDER, PRIM_TYPE_PRISM

integer INDEX_TYPE = 0;
integer INDEX_HOLE = 1;
integer INDEX_CUT = 2;
integer INDEX_HOLLOW = 3;
integer INDEX_TWIST = 4;
integer INDEX_TAPER = 5;
integer INDEX_SHEAR = 6;

// Index of properties for PRIM_TEXTURE

integer INDEX_TEXTURE = 0;
integer INDEX_REPEATS = 1;
integer INDEX_OFFSETS = 2;
integer INDEX_ROTATION = 3;

// client script
// +---------------+------------+
// Taper | -1.0 0 +1.0 | 2.0 0.0 |
// Shear | -0.5 0 +0.5 | -0.5 +0.5 |
// Twist | -180 0 +180 | -1.0 +1.0 |
// +---------------+------------+

//
// Set accessors
//

mySetLinkName (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_NAME, text]);
}

mySetLinkDesc (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_DESC, text]);
}

mySetLinkText (integer link, string text, vector color) {
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXT, text, color, 1.0]);
}

mySetLinkColor (integer link, vector color, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_COLOR, face, color, 1.0]);
}

mySetLinkBright (integer link, integer bright, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_FULLBRIGHT, face, bright]);
}

mySetLinkGlow (integer link, float glow, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_GLOW, face, glow]);
}

// Les 3 suivants ne marchent pas pour ALL_SIDES

mySetLinkTexture (integer link, key texture, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [texture], INDEX_TEXTURE, INDEX_TEXTURE);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkRepeat (integer link, vector repeat, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [repeat], INDEX_REPEATS, INDEX_REPEATS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkOffset (integer link, vector offset, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [offset], INDEX_OFFSETS, INDEX_OFFSETS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkPos (integer link, vector pos) {
llSetLinkPrimitiveParamsFast (link, [PRIM_POS_LOCAL, pos]);
}

mySetLinkRot (integer link, rotation rot) {
llSetLinkPrimitiveParamsFast (link, [PRIM_ROT_LOCAL, rot]);
}

mySetLinkSize (integer link, vector size) {
llSetLinkPrimitiveParamsFast (link, [PRIM_SIZE, size]);
}

mySetLinkCut (integer link, vector cut) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [cut], INDEX_CUT, INDEX_CUT);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTwist (integer link, vector twist) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [twist], INDEX_TWIST, INDEX_TWIST);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTaper (integer link, vector taper) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [taper], INDEX_TAPER, INDEX_TAPER);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkShear (integer link, vector shear) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [shear], INDEX_SHEAR, INDEX_SHEAR);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkHollow (integer link, float hollow) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [hollow], INDEX_HOLLOW, INDEX_HOLLOW);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

//
// Get accessors
//

string myGetLinkName (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_NAME]);
return llList2String (l,0);
}

string myGetLinkDesc (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_DESC]);
return llList2String (l,0);
}

string myGetLinkText (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXT]);
return llList2String (l,0);
}

vector myGetLinkColor (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_COLOR, face]);
return llList2Vector (l,0);
}

integer myGetLinkBright (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_FULLBRIGHT, face]);
return llList2Integer (l,0);
}

float myGetLinkGlow (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_GLOW, face]);
return llList2Float (l,0);
}

key myGetLinkTexture (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Key(l,0);
}

vector myGetLinkRepeat (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,1);
}

vector myGetLinkOffset (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,2);
}

vector myGetLinkPos (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_POS_LOCAL]);
return llList2Vector (l,0);
}

vector myGetLinkSize (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_SIZE]);
return llList2Vector (l,0);
}

vector myGetLinkCut (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_CUT);
}

vector myGetLinkTwist (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TWIST);
}

vector myGetLinkTaper (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TAPER);
}

vector myGetLinkShear (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_SHEAR);
}

float myGetLinkHollow (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Float (l, INDEX_HOLLOW);
}
</source>
LL accessors can be effortlessly converted to OS versions. Just change prim_num to prim_key in argument list, and pick the right os/ll function. Finally, you can use function overloading to write universal routines :
<source lang="lsl">
SetPrimColor (key prim, vector color, integer side)
{
osSetPrimitiveParams (prim, [PRIM_COLOR, side, color, 1.0]);
}

SetPrimColor (integer prim, vector color, integer side)
{
llSetLinkPrimitiveParamsFast (prim, [PRIM_COLOR, side, color, 1.0]);
}
</source>

[[Category:Scripting]]
[[Category:Scripts]]
[[Category:OSSL]]

OSSL vs LSL

2025-04-07T15:03:35Z

JeffKelley: Added Key2Name

LSL and OSSL functions may appear overlapping. Sometimes, they are. This may happen when a OSSL function has been written before it's LL conterpart. Most of the time, they are complementary.

OSSL implements features not available in LSL (NPCs, Texture Drawing) or extend them, like adressing prims by key, which gives unprecedented flexibility to the scripter.

This page tries to highlight the differences between OSSL and LSL functions when similar versions exist.

{| class="wikitable" style="margin:auto"
| llGetLinkPrimitiveParams || [[osGetLinkPrimitiveParams]] || Allows for multiple-link constants LINK_SET, LINK_ALL_CHILDREN. Returns a by-side list of properties.
|-
| llSetLinkPrimitiveParams || || No need for OSSL version since llSetLinkPrimitiveParams accepts all LINK_* flags
|-
| llGetPrimitiveParams llSetPrimitiveParams || [[osGetPrimitiveParams]] [[osSetPrimitiveParams]] || Acts on out-of-linkset primitive (uuid instead of linknumber)
|-
|| || [[osSetProjectionParams]] || Same effect can be obtained with llSetLinkPrimitiveParams (linknum, [PRIM_PROJECTOR]) but OSSL version has osSetPrimitiveParams power to work outside linkset.
|-
| llCreateLink<br\>llBreakLink<br\>llBreakAllLinks || [[osForceCreateLink]] [[osForceBreakLink]]<br\>[[osForceBreakAllLinks]] || Does not require PERMISSION_CHANGE_LINKS
|-
| llParticleSystem llLinkParticleSystem || [[osParticleSystem]] [[osLinkParticleSystem]] ||
|-
| llSitTarget llLinkSitTarget || [[osSetStandTarget]] [[osSetLinkStandTarget]] || SitTarget is position when sitting. StandTarget, position when unsitting.
|-
| llAvatarOnSitTarget llAvatarOnLinkSitTarget || [[osGetSittingAvatarsCount]]() [[osGetSittingAvatarsCount]](uuid) || OSSL function returns the total number of avatars sitting on a linkset. LSL functions apply only to avatars on sittarget (return NULL_KEY if sittarget is not set) and cannot operate outside the linkset. A similar result can be obtained with llGetObjectDetails(uuid, [OBJECT_SIT_COUNT]).
|-
| llPlaySound llLoopSound llTriggerSound ... || [[osPlaySound]]<br\>[[osLoopSound]]<br\>[[osTriggerSound]] ... || All OSSL sound functions takes a linknumber argument.
|-
| llLinkPlaySound || || Universal link sound function (SOUND_PLAY, SOUND_LOOP, SOUND_TRIGGER, SOUND_SYNC). Equivalent to resp. osPlaySound, osLoopSound, osTriggerSound, osPlaySoundSlave, osLoopSoundSlave.
|-
| llGetNumberOfPrims llGetObjectPrimCount || [[osGetPrimCount]]() [[osGetPrimCount]](uuid) || OSSL version does not count sitting avatars and does work on attachments
|-
| llStartAnimation llStopAnimation ||[[osAvatarPlayAnimation]] [[osAvatarStopAnimation]] || Does not require PERMISSION_TRIGGER_ANIMATION OSSL can animate multiples avatars, when LSL is bound to the avatar having granted the permission.
|-
| llAttachToAvatar llDetachFromAvatar || [[osForceAttachToAvatar]] [[osForceDetachFromAvatar]] || Does not require PERMISSION_ATTACH. Target avatar is implicit. To attach explicitely to a given avatar, use osForceAttachToOtherAvatarFromInventory on the avatar's key.
|-
| llGetAgentList || [[osGetAgents]] [[osGetAvatarList]] [[OsGetNpcList|osGetNPCList]] || llGetAgentList returns a list of agent keys. osGetAgents, a list of agent names. osGetAvatarList, a strided list of agent (key, position, name). osGetNPCList : same as osGetAvatarList, but only NPCs.
|-
| llGetInventoryKey llGetInventoryName || [[osGetInventoryItemKey]] [[osGetInventoryName]] || llGetInventoryKey returns item id while osGetInventoryItemKey returns asset id. llGetInventoryName returns name from (index,type) while osGetInventoryName return name fro item id.
|-
| llKey2Name || [[osKey2Name]] || llKey2Name works on both avatars and objects. osKey2Name returns an empty string on objects.
|}

Server Commands

2025-01-20T12:43:38Z

JeffKelley: /* Object Commands */

{{Quicklinks|Server_Commands}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance find <uuid-or-start-of-uuid> - Find out which avatar uses the given asset as a baked texture, if any.
* appearance rebake <first-name> <last-name> - Send a request to the user's viewer for it to rebake and reupload its appearance textures.
* appearance send [<first-name> <last-name>] - Send appearance data for each avatar in the simulator to other viewers.
* appearance show [<first-name> <last-name>] - Show appearance information for avatars.

Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.
* land clear - Clears all parcels on the land.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object id <UUID-or-localID> - Delete a scene object by uuid or localID. Pre 0.7.5, this was "delete object uuid".
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object id <UUID-or-localID> - Show details of a scene object with the given UUID or localID. Pre 0.7.5, this was "show object uuid".
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part id <UUID-or-localID> - Show details of a scene object parts with the given UUID or localID. Pre 0.7.5, this was "show part uuid".

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
Sample usage:
estate show<enter>
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID which you can get from 'show names'

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
:Flags can be one of the following:
:'''DefaultRegion''' Used for new Rez. Random if multiple defined
:'''FallbackRegion''' Regions we redirect to when the destination is down
:'''RegionOnline''' Set when a region comes online, unset when it unregisters and DeleteOnUnregister is false
:'''NoDirectLogin''' Region unavailable for direct logins (by name)
:'''Persistent''' Don't remove on unregister
:'''LockedOut''' Don't allow registration
:'''NoMove '''Don't allow moving this region
:'''Reservation''' This is an inactive reservation
:'''Authenticate''' Require authentication
:'''Hyperlink''' Record represents a HG link
:'''DefaultHGRegion''' Record represents a default region for hypergrid teleports only.
:Note: flags are additive, there is no way to unset them from the console.
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file. (see note1)
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

Note1 : If you have a sim with multiple regions and you want to set all regions on that sim to be from one larger image you can use 'terrain load <file> <width in regions> <height in regions> <regionX> <regionY> where regionX and regionY are the coordinates of the bottom-left region.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

=== [[YEngine]] Commands ===
* yeng help
* yeng reset -all | <part-of-script-name>
* yeng resume - resume script processing
* yeng suspend - suspend script processing
* yeng ls -full -max=<number> -out=<filename> -queues -topcpu
* yeng cvv - show compiler version value
* yeng mvv [<newvalue>] - show migration version value
* yeng tracecalls [yes | no]
* yeng verbose [yes | no]
* yeng pev -all | <part-of-script-name> <event-name> <params...>

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset <ID> - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [Email] [Primary UUID] [Model} - creates a new user
:or just: create user - and server prompts for all data
:
:If UUID is nul or whitespace a UUID will be generated for you.
:
:Model is the "first lastname" of another user, that user's outfit will be cloned to the new user.
:
* reset user password - This command ''sets'' a new password for a user and directly updates the database. It does not ''reset'' the password to a default or temporary value, as the term might suggest.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0 (dead link)

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping - Link a HyperGrid region. Not sure how this differs from link-mapping.

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - simulator frames per second
* PhyFPS - physics frames per second
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

User:JeffKelley

2024-11-04T20:26:03Z

JeffKelley: /* Scripting */

== Me ==

I contribute occasionnally to this wiki, mainly in the database section.

== My links ==

===[[Release_Notes]]===
===[[Database:Documentation|Database]]===
*[[Assets]]
*[[Inventoryfolders]]
*[[Inventoryitems]]
*[[Prims_(database_table)|Prims]]
*[[Primitems]]
*[[Database:Primshapes|Primshapes]]

===[[Services]]===
*[[AssetService]]
*[[AvatarService]]
*[[GridService]]
*[[GroupsService]]
*[[GridUserService]]
*[[InventoryService]]
*[[PresenceService]]
*[[UserAccountService]]

Examples:
*[[ClothingManipulation]]
*[[UserManipulation]]

===[[Scripting]]===

*[[ScriptEngines]]
*[[XEngine]]
*[[YEngine]]
*[[OSSL_Implemented]]
*[[http://web.archive.org/web/20240713224456/http://wiki.dreamnation.net/index.php/XMREngine_Script_Engine XMRE]] on Wayback Machine

===[[Monitoring]]===
*[[Monitoring_Module]] + [[Collectd]]
*[[Web_Statistics_Module]]
*[[User:Allen_Kerensky/JSON_User_SimStats|JSON_User_SimStats]], [[UXSimStatus]], [[XSimStatus]]
*[[Logging]]

===AutoBackup===
*[[Feature_Proposals/AutoBackup]] (proposal)
*[[Autobackup]] (AutoBackupSkipAssets)
*[http://opensimulator.org/mantis/view.php?id=5440 MANTIS 5440] (discussion)
*[http://opensimulator.org/mantis/view.php?id=7240 MANTIS 7240] (AutoBackupKeepFilesForDays)

===[[Development#Integration|Integration]]===
*[[REST]]
*[[RestConsole]]
*[[RemoteAdmin]]
*[https://github.com/justincc/opensimulator-tools/tree/master/integration/php php tools] (justincc)

===Formats===
*[[Inventory_Archives|IAR]]
*[[OpenSim_Archives|OAR]]
*[[Asset_Formats|Assets]]

===Region Modules===
*[[Developing_OpenSim_Addins]]
*[[Getting_Started_with_Region_Modules]]
*[[Getting_Started_with_Region_Modules/New]]
*[[New_Region_Modules]]
*[[IRegionModule]]
*[[OSSL_Script_Library/ModSendCommand|ModSendCommand]]
*[[OSSL_Script_Library/ModInvoke|ModInvoke]]
*[http://bluewallvirtual.com/example_region_module Example Region Module] (Bluewall)

===[[Server_Commands]]===
*[[Inventory_Archives]] (IAR)
*[[OpenSim_Archives]] (OAR)
*[[Load_Oar]]
*[[Load_Oar_0.9.0+]]

===Pages in progress, or needing refinement===
*[[OSSL_vs_LSL]]
*[[Accessing_Prim_Properties]]
*[[Streaming_Media_in_OpenSim]]
*[[Streaming_sound_in_OpenSim]]
*[[Playing_Music_files_in_OpenSim]]
*[[Clearing_a_common_misconception_about_the_event_model]]
*[[Artist_Home_(2023_project)]] https://omrg.org/w/index.php?title=OpenSimulator_Content_Creators_Home

Server Commands

2024-10-30T15:27:43Z

JeffKelley: /* Object Commands */ Swapped Post/Pre 0.7.5

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance find <uuid-or-start-of-uuid> - Find out which avatar uses the given asset as a baked texture, if any.
* appearance rebake <first-name> <last-name> - Send a request to the user's viewer for it to rebake and reupload its appearance textures.
* appearance send [<first-name> <last-name>] - Send appearance data for each avatar in the simulator to other viewers.
* appearance show [<first-name> <last-name>] - Show appearance information for avatars.

Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.
* land clear - Clears all parcels on the land.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object id <UUID-or-localID> - Delete a scene object by uuid or localID. Pre 0.7.5, this was "show object uuid".
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object id <UUID-or-localID> - Show details of a scene object with the given UUID or localID. Pre 0.7.5, this was "show object uuid".
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part id <UUID-or-localID> - Show details of a scene object parts with the given UUID or localID. Pre 0.7.5, this was "show object uuid".

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
Sample usage:
estate show<enter>
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID which you can get from 'show names'

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
:Flags can be one of the following:
:'''DefaultRegion''' Used for new Rez. Random if multiple defined
:'''FallbackRegion''' Regions we redirect to when the destination is down
:'''RegionOnline''' Set when a region comes online, unset when it unregisters and DeleteOnUnregister is false
:'''NoDirectLogin''' Region unavailable for direct logins (by name)
:'''Persistent''' Don't remove on unregister
:'''LockedOut''' Don't allow registration
:'''NoMove '''Don't allow moving this region
:'''Reservation''' This is an inactive reservation
:'''Authenticate''' Require authentication
:'''Hyperlink''' Record represents a HG link
:'''DefaultHGRegion''' Record represents a default region for hypergrid teleports only.
:Note: flags are additive, there is no way to unset them from the console.
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file. (see note1)
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

Note1 : If you have a sim with multiple regions and you want to set all regions on that sim to be from one larger image you can use 'terrain load <file> <width in regions> <height in regions> <regionX> <regionY> where regionX and regionY are the coordinates of the bottom-left region.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

=== [[YEngine]] Commands ===
* yeng help
* yeng reset -all | <part-of-script-name>
* yeng resume - resume script processing
* yeng suspend - suspend script processing
* yeng ls -full -max=<number> -out=<filename> -queues -topcpu
* yeng cvv - show compiler version value
* yeng mvv [<newvalue>] - show migration version value
* yeng tracecalls [yes | no]
* yeng verbose [yes | no]
* yeng pev -all | <part-of-script-name> <event-name> <params...>

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset <ID> - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [Email] [Primary UUID] [Model} - creates a new user
:or just: create user - and server prompts for all data
:
:If UUID is nul or whitespace a UUID will be generated for you.
:
:Model is the "first lastname" of another user, that user's outfit will be cloned to the new user.
:
* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0 (dead link)

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping - Link a HyperGrid region. Not sure how this differs from link-mapping.

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - simulator frames per second
* PhyFPS - physics frames per second
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

User:JeffKelley

2024-10-14T21:09:20Z

JeffKelley: /* Pages in progress, or needing refinement */

== Me ==

I contribute occasionnally to this wiki, mainly in the database section.

== My links ==

===[[Release_Notes]]===
===[[Database:Documentation|Database]]===
*[[Assets]]
*[[Inventoryfolders]]
*[[Inventoryitems]]
*[[Prims_(database_table)|Prims]]
*[[Primitems]]
*[[Database:Primshapes|Primshapes]]

===[[Services]]===
*[[AssetService]]
*[[AvatarService]]
*[[GridService]]
*[[GroupsService]]
*[[GridUserService]]
*[[InventoryService]]
*[[PresenceService]]
*[[UserAccountService]]

Examples:
*[[ClothingManipulation]]
*[[UserManipulation]]

===[[Scripting]]===

*[[ScriptEngines]]
*[[XEngine]]
*[[YEngine]]
*[[OSSL_Implemented]]

===[[Monitoring]]===
*[[Monitoring_Module]] + [[Collectd]]
*[[Web_Statistics_Module]]
*[[User:Allen_Kerensky/JSON_User_SimStats|JSON_User_SimStats]], [[UXSimStatus]], [[XSimStatus]]
*[[Logging]]

===AutoBackup===
*[[Feature_Proposals/AutoBackup]] (proposal)
*[[Autobackup]] (AutoBackupSkipAssets)
*[http://opensimulator.org/mantis/view.php?id=5440 MANTIS 5440] (discussion)
*[http://opensimulator.org/mantis/view.php?id=7240 MANTIS 7240] (AutoBackupKeepFilesForDays)

===[[Development#Integration|Integration]]===
*[[REST]]
*[[RestConsole]]
*[[RemoteAdmin]]
*[https://github.com/justincc/opensimulator-tools/tree/master/integration/php php tools] (justincc)

===Formats===
*[[Inventory_Archives|IAR]]
*[[OpenSim_Archives|OAR]]
*[[Asset_Formats|Assets]]

===Region Modules===
*[[Developing_OpenSim_Addins]]
*[[Getting_Started_with_Region_Modules]]
*[[Getting_Started_with_Region_Modules/New]]
*[[New_Region_Modules]]
*[[IRegionModule]]
*[[OSSL_Script_Library/ModSendCommand|ModSendCommand]]
*[[OSSL_Script_Library/ModInvoke|ModInvoke]]
*[http://bluewallvirtual.com/example_region_module Example Region Module] (Bluewall)

===[[Server_Commands]]===
*[[Inventory_Archives]] (IAR)
*[[OpenSim_Archives]] (OAR)
*[[Load_Oar]]
*[[Load_Oar_0.9.0+]]

===Pages in progress, or needing refinement===
*[[OSSL_vs_LSL]]
*[[Accessing_Prim_Properties]]
*[[Streaming_Media_in_OpenSim]]
*[[Streaming_sound_in_OpenSim]]
*[[Playing_Music_files_in_OpenSim]]
*[[Clearing_a_common_misconception_about_the_event_model]]
*[[Artist_Home_(2023_project)]] https://omrg.org/w/index.php?title=OpenSimulator_Content_Creators_Home

Clearing a frequent misconception about the event model

2024-10-14T21:08:32Z

JeffKelley: JeffKelley moved page Clearing a frequent misconception about the event model to Clearing a common misconception about the event model

#REDIRECT [[Clearing a common misconception about the event model]]

Clearing a common misconception about the event model

2024-10-14T21:08:32Z

JeffKelley: JeffKelley moved page Clearing a frequent misconception about the event model to Clearing a common misconception about the event model

<div style="background-color:#ffcc99; padding:10px; padding-bottom:5px; border: 1px solid">DRAFT</div> 

Clearing a frequent misconception about the event model

Sometimes, we see code like this :

<pre>
00 string A_name,
01 key A_key;
02
03 state_entry()
04 {
05 llRezObject (A_name, .....);
06 DoThis();
07 DoThat();
08 }
09
10 object_rez(key id)
11 {
12 A_key = id;
13 }
</pre>

Some hope that object_rez will be executed 'as soon as' llRezObject returns, or 'while' state_entry is running. This is false. Despite the fact that the environment (script engine, simulator, network, operating system) is all multi-tasking, your script is NOT.

object_rez cannot run 'while' state_entry runs. This is concurrency, and it is the privilege of multi-tasking (or multi-threaded) languages. In a multi-threaded language, state_entry would be suspended to run object_rez, then resumed later. Like :

<pre>
05 llRezObject (A_name, .....);
12 A_key = id;
06 DoThis();
07 DoThat();
</pre>

LSL being single-threaded, state_entry has to complete before your script can do anything else. Then, it will dequeue the next event from the event queue, that may be (but not necessarily) object_rez. The flow of execution is actually :

<pre>
05 llRezObject (A_name, .....);
06 DoThis();
07 DoThat();
12 A_key = id;
</pre>

But it works !

Yes, it works. Because you have only one operation pending. Imagine:

<pre>
03 state_entry()
04 {
05 llRezObject (A_name, .....);
06 llRezObject (B_name, .....);
07 DoThis();
08 DoThat();
09 }
</pre>

How do you differentiate between key for objectA and key for objectB ?

The first object_rez gives A_key and the second B_key ?

Wrong.

llRezObject is an asynchronous operation and you have no control of what happens once initiated. objectA may take more time to rez than objectB for any reason. Think about initiating two i/o operations on DiskA and DiskB in C. Which completes first ? You cannot know. Your code must use some mechanism to bind i/o initiation to i/o completion. Then, when an operation completes, it can be bound to either DiskA or DiskB.

But this is LSL, not C, and there is nothing to bind object_rez to llRezObject. Fortunately, the solution is simple : Have only one rez pending at any time. Once llRezObject is called, wait for object_rez to fire before rezing next.

<pre>
00 string object_rezed;
01
02 state_entry()
03 {
04 object_rezed = GetNextObject();
05 llRezObject (object_rezed, .....); // Prime process
06 }
07
08 object_rez(key id)
09 {
10 // id is key for 'object_rezed'
11 object_rezed = GetNextObject();
12 if (object_rezed == "") return; // Stop process
13 llRezObject (object_rezed, .....); // Propagate process
14 }
</pre>

In line 10, id is guaranteed to be key of objet 'object_rezed'. You can now associate both. There is no risk of overflowing the event queue, as would be the case with a loop on llRezObject.

What may RezNext look like ? A simple dequeue from a list, maybe :

<pre>
50 list ObjectsToRez = [ "A", "B", "C", "D" ];
51
52 string GetNextObject()
53 {
54 string next_item = llList2List (ObjectsToRez, 0,0);
55 ObjectsToRez = llDeleteSubList (ObjectsToRez, 0,0);
56 return next_item;
57 }
</pre>

But I just want the id of the last object rezed.
Why is this so complex ? I would like to write

<pre>
key A_id = llRezObject (A_name, .....);
</pre>

This synchronous version would block your script for a long time. Think again about disk i/o. They are million times slower than you own code. Running your whole state_entry may take nanoseconds, while waiting the rez to complete may take millis.

During the time your script will be blocked and you will be unable to respond to another event. This is especially important in the case of communications. Imagine a synchronous dialog :

<pre>
string answer = llDialog (target, "What will we eat tonight?",
[ "Shushis", "Hamburger" ]);
</pre>

Surely, we would love to have the answer NOW (== at line 10). It would considerably streamline our code. But our script would be blocked for seconds, which is an eternity for the CPU.

The event model breaks sequentiality for the sake of responsiveness. You throw events. Some time later, you must be ready to handle their completion. You have to warp your code around the flow of events, initiating the transaction in one place, completing it elsewhere.

<pre>
10 state_entry()
11 {
12 llDialog (Do you want this or that);
13 }
14
15 listen (integer channel, .....)
16 {
17 // This may be the answer to my question
18 }
</pre>

Clearing a common misconception about the event model

2024-10-14T17:17:57Z

JeffKelley: First draft

User:JeffKelley

2024-10-13T16:28:38Z

JeffKelley: /* Pages in progress, or needing refinement */

== Me ==

I contribute occasionnally to this wiki, mainly in the database section.

== My links ==

===[[Release_Notes]]===
===[[Database:Documentation|Database]]===
*[[Assets]]
*[[Inventoryfolders]]
*[[Inventoryitems]]
*[[Prims_(database_table)|Prims]]
*[[Primitems]]
*[[Database:Primshapes|Primshapes]]

===[[Services]]===
*[[AssetService]]
*[[AvatarService]]
*[[GridService]]
*[[GroupsService]]
*[[GridUserService]]
*[[InventoryService]]
*[[PresenceService]]
*[[UserAccountService]]

Examples:
*[[ClothingManipulation]]
*[[UserManipulation]]

===[[Scripting]]===

*[[ScriptEngines]]
*[[XEngine]]
*[[YEngine]]
*[[OSSL_Implemented]]

===[[Monitoring]]===
*[[Monitoring_Module]] + [[Collectd]]
*[[Web_Statistics_Module]]
*[[User:Allen_Kerensky/JSON_User_SimStats|JSON_User_SimStats]], [[UXSimStatus]], [[XSimStatus]]
*[[Logging]]

===AutoBackup===
*[[Feature_Proposals/AutoBackup]] (proposal)
*[[Autobackup]] (AutoBackupSkipAssets)
*[http://opensimulator.org/mantis/view.php?id=5440 MANTIS 5440] (discussion)
*[http://opensimulator.org/mantis/view.php?id=7240 MANTIS 7240] (AutoBackupKeepFilesForDays)

===[[Development#Integration|Integration]]===
*[[REST]]
*[[RestConsole]]
*[[RemoteAdmin]]
*[https://github.com/justincc/opensimulator-tools/tree/master/integration/php php tools] (justincc)

===Formats===
*[[Inventory_Archives|IAR]]
*[[OpenSim_Archives|OAR]]
*[[Asset_Formats|Assets]]

===Region Modules===
*[[Developing_OpenSim_Addins]]
*[[Getting_Started_with_Region_Modules]]
*[[Getting_Started_with_Region_Modules/New]]
*[[New_Region_Modules]]
*[[IRegionModule]]
*[[OSSL_Script_Library/ModSendCommand|ModSendCommand]]
*[[OSSL_Script_Library/ModInvoke|ModInvoke]]
*[http://bluewallvirtual.com/example_region_module Example Region Module] (Bluewall)

===[[Server_Commands]]===
*[[Inventory_Archives]] (IAR)
*[[OpenSim_Archives]] (OAR)
*[[Load_Oar]]
*[[Load_Oar_0.9.0+]]

===Pages in progress, or needing refinement===
*[[OSSL_vs_LSL]]
*[[Accessing_Prim_Properties]]
*[[Streaming_Media_in_OpenSim]]
*[[Streaming_sound_in_OpenSim]]
*[[Playing_Music_files_in_OpenSim]]
*[[Clearing_a_frequent_misconception_about_the_event_model]]
*[[Artist_Home_(2023_project)]] https://omrg.org/w/index.php?title=OpenSimulator_Content_Creators_Home

User:JeffKelley

2024-10-10T19:07:10Z

JeffKelley: /* Pages in progress, or needing refinement */

== Me ==

I contribute occasionnally to this wiki, mainly in the database section.

== My links ==

===[[Release_Notes]]===
===[[Database:Documentation|Database]]===
*[[Assets]]
*[[Inventoryfolders]]
*[[Inventoryitems]]
*[[Prims_(database_table)|Prims]]
*[[Primitems]]
*[[Database:Primshapes|Primshapes]]

===[[Services]]===
*[[AssetService]]
*[[AvatarService]]
*[[GridService]]
*[[GroupsService]]
*[[GridUserService]]
*[[InventoryService]]
*[[PresenceService]]
*[[UserAccountService]]

Examples:
*[[ClothingManipulation]]
*[[UserManipulation]]

===[[Scripting]]===

*[[ScriptEngines]]
*[[XEngine]]
*[[YEngine]]
*[[OSSL_Implemented]]

===[[Monitoring]]===
*[[Monitoring_Module]] + [[Collectd]]
*[[Web_Statistics_Module]]
*[[User:Allen_Kerensky/JSON_User_SimStats|JSON_User_SimStats]], [[UXSimStatus]], [[XSimStatus]]
*[[Logging]]

===AutoBackup===
*[[Feature_Proposals/AutoBackup]] (proposal)
*[[Autobackup]] (AutoBackupSkipAssets)
*[http://opensimulator.org/mantis/view.php?id=5440 MANTIS 5440] (discussion)
*[http://opensimulator.org/mantis/view.php?id=7240 MANTIS 7240] (AutoBackupKeepFilesForDays)

===[[Development#Integration|Integration]]===
*[[REST]]
*[[RestConsole]]
*[[RemoteAdmin]]
*[https://github.com/justincc/opensimulator-tools/tree/master/integration/php php tools] (justincc)

===Formats===
*[[Inventory_Archives|IAR]]
*[[OpenSim_Archives|OAR]]
*[[Asset_Formats|Assets]]

===Region Modules===
*[[Developing_OpenSim_Addins]]
*[[Getting_Started_with_Region_Modules]]
*[[Getting_Started_with_Region_Modules/New]]
*[[New_Region_Modules]]
*[[IRegionModule]]
*[[OSSL_Script_Library/ModSendCommand|ModSendCommand]]
*[[OSSL_Script_Library/ModInvoke|ModInvoke]]
*[http://bluewallvirtual.com/example_region_module Example Region Module] (Bluewall)

===[[Server_Commands]]===
*[[Inventory_Archives]] (IAR)
*[[OpenSim_Archives]] (OAR)
*[[Load_Oar]]
*[[Load_Oar_0.9.0+]]

===Pages in progress, or needing refinement===
*[[OSSL_vs_LSL]]
*[[Accessing_Prim_Properties]]
*[[Streaming_Media_in_OpenSim]]
*[[Streaming_sound_in_OpenSim]]
*[[Playing_Music_files_in_OpenSim]]
*[[Clearing_a_frequent_misconception_about_the_event_system]]
*[[Artist_Home_(2023_project)]] https://omrg.org/w/index.php?title=OpenSimulator_Content_Creators_Home

OsGetLinkInventoryKey

2024-06-22T10:01:05Z

JeffKelley: Edited example comment

{{osslfunc
|threat_level=ignored
|permissions=Script owner needs modify, copy and transfer rights
|delay=0
|function_syntax=key osGetLinkInventoryKey(integer linkNumber, string name) 

|ossl_example=<source lang="lsl">
//
// osGetLinkInventoryKey Script Example
//
// This script runs in a child prim
// It will paint the prim with
// a texture in root inventory

default
{
state_entry()
{
string textureName = "K1100RS";
key textureUuid = osGetLinkInventoryKey (LINK_ROOT, textureName, INVENTORY_TEXTURE);
llOwnerSay ("Painting prim with texture "+textureUuid);
if (textureUuid != NULL_KEY)
llSetTexture (textureUuid, ALL_SIDES);
}
}
</source>
|description=Returns id(key) of a inventory item asset within a prim inventory. If name is not unique result maybe unpredictable. This function extends llGetInventoryKey( string name ) to links. Returns NULL_KEY if the item is not found or Owner has no rights
|additional_info=osGetInventoryItemKey added in 0.9.1.0 Dev, Implemented August, 16 2019 
osGetLinkInventoryKey added in 0.9.3.0 Dev, March 2024
}}
'''See Also:'''
* [[osGetInventoryName]]
* [[osGetInventoryDesc]]
* [[osGetInventoryLastOwner]]
* [[osGetLastChangedEventKey]]

OsGetLinkInventoryKey

2024-06-21T16:30:38Z

JeffKelley: Never edit a valid script before publishing.

{{osslfunc
|threat_level=ignored
|permissions=Script owner needs modify, copy and transfer rights
|delay=0
|function_syntax=key osGetLinkInventoryKey(integer linkNumber, string name) 

|ossl_example=<source lang="lsl">
//
// osGetLinkInventoryKey Script Example
//
// This script runs in link #2
// It will paint the prim with
// a texture in root inventory

default
{
state_entry()
{
string textureName = "K1100RS";
key textureUuid = osGetLinkInventoryKey (LINK_ROOT, textureName, INVENTORY_TEXTURE);
llOwnerSay ("Painting prim with texture "+textureUuid);
if (textureUuid != NULL_KEY)
llSetTexture (textureUuid, ALL_SIDES);
}
}
</source>
|description=Returns id(key) of a inventory item asset within a prim inventory. If name is not unique result maybe unpredictable. This function extends llGetInventoryKey( string name ) to links. Returns NULL_KEY if the item is not found or Owner has no rights
|additional_info=osGetInventoryItemKey added in 0.9.1.0 Dev, Implemented August, 16 2019 
osGetLinkInventoryKey added in 0.9.3.0 Dev, March 2024
}}
'''See Also:'''
* [[osGetInventoryName]]
* [[osGetInventoryDesc]]
* [[osGetInventoryLastOwner]]
* [[osGetLastChangedEventKey]]

OsGetLinkInventoryKey

2024-06-21T15:54:39Z

JeffKelley: Example added

{{osslfunc
|threat_level=ignored
|permissions=Script owner needs modify, copy and transfer rights
|delay=0
|function_syntax=key osGetLinkInventoryKey(integer linkNumber, string name) 

|ossl_example=<source lang="lsl">
//
// osGetLinkInventoryKey Script Example
//
// This script runs in link #2
// It will paint the prim with
// a texture in root inventory

default
{
state_entry()
{
string textureName = "K1100RS";
key textureUuid = osGetLinkInventoryKey (LINK_ROOT, textureName, INVENTORY_TEXTURE);
llOwnerSay ("Painting prim with texture "+textureUuid);
if (textureuuid != NULL_KEY)
llSetTexture (textureUuid, ALL_SIDES);
}
}
</source>
|description=Returns id(key) of a inventory item asset within a prim inventory. If name is not unique result maybe unpredictable. This function extends llGetInventoryKey( string name ) to links. Returns NULL_KEY if the item is not found or Owner has no rights
|additional_info=osGetInventoryItemKey added in 0.9.1.0 Dev, Implemented August, 16 2019 
osGetLinkInventoryKey added in 0.9.3.0 Dev, March 2024
}}
'''See Also:'''
* [[osGetInventoryName]]
* [[osGetInventoryDesc]]
* [[osGetInventoryLastOwner]]
* [[osGetLastChangedEventKey]]

OsGetLinkInventoryKey

2024-06-20T18:57:18Z

JeffKelley: Page creation

Category:OSSL Functions

2024-06-20T18:45:17Z

JeffKelley: /* Prim */ Adding osGetLinkInventoryKey

{{Quicklinks}}
 
<div style="background-color:#FFA500; padding:10px; padding-bottom:5px; border: 1px #FF544F solid">
This information is relative to (almost) the last OpenSimulator Development version. In some cases it may not apply to older versions.
</div>

== OSSL function permissions ==
Several OSSL functions have execution permission control to prevent abusive or dangerous use.

This is controlled by files osslDefaultEnable.ini and osslEnable.ini, by default in folder bin/config-include 
The use logic of these two files is identical to OpenSimDefaults.ini and OpenSim.ini

Older OpenSimulator versions only used file osslEnable.ini. 
Some older OpenSimulator versions had checks for all OSSLfunctions. 
That made no sense for many functions, so now many are always allowed wasting no time on useless checks. 

For details about these permissions, please read file OpenSimDefaults.ini

= osslDefaultEnable.ini =
This file contains the defaults for OSSL execution permissions set by OpenSimulator dev team. 
Instead of changing defaults defined in code, the OpenSimulator dev team may decide to just make changes in this file. 
This file was not present on older OpenSimulator versions. 
If you need to change permissions, copy the respective entry to osslEnable.ini and modify there. 

= osslEnable.ini =
This file contains the local overrides for OSSL permissions. 
It is read after osslDefaultEnable.ini, and any entry on it replaces the old one. 
This file is not provided on code packages, an osslEnable.ini.example is. 
At first time setup, you will need to copy the example file to osslEnable.ini and then edit it for your needs, using osslDefaults.ini as reference. 
This was the only file used on older OpenSimulator versions.

== Current OSSL Functions Implemented ==

=== Avatars ===
{{multicol}}

* [[osAgentSaveAppearance]]
* [[osAvatarName2Key]]
* [[osAvatarPlayAnimation]]
* [[osAvatarStopAnimation]]
* [[osAvatarType]]
* [[osCauseDamage]]
* [[osCauseHealing]]
* [[osDetectedCountry]]
* [[osDropAttachment]]
* [[osDropAttachmentAt]]
* [[osEjectFromGroup]]
* [[osForceAttachToAvatar]]
* [[osForceAttachToAvatarFromInventory]]
* [[osForceAttachToOtherAvatarFromInventory]]
* [[osForceDetachFromAvatar]]
* [[osForceDropAttachment]]
* [[osForceDropAttachmentAt]]
* [[osForceOtherSit]]
* [[osGetAgentIP]]
* [[osGetAgents]]
{{multicol-break}}
* [[osGetAgentCountry]]
* [[osGetAvatarHomeURI]]
* [[osGetAvatarList]]
* [[osGetGender]]
* [[osGetHealRate]]
* [[osGetHealth]]
* [[osGetNumberOfAttachments]]
* [[osGrantScriptPermissions]]
* [[osInviteToGroup]]
* [[osKickAvatar]]
* [[osOwnerSaveAppearance]]
* [[osRevokeScriptPermissions]]
* [[osSetHealRate]]
* [[osSetHealth]]
* [[osSetOwnerSpeed]]
* [[osSetSpeed]]
* [[osLocalTeleportAgent]]
* [[osTeleportAgent]]
* [[osTeleportOwner]]
* [[osReplaceAgentEnvironment]]
{{multicol-end}}

=== NPCs ===
{{multicol}}
* [[osIsNpc]]
* [[osNpcCreate]]
* [[osGetNpcList]]
* [[osNpcGetPos]]
* [[osNpcGetRot]]
* [[osNpcGetOwner]]
* [[osNpcLookAt]] {{E}}
* [[osNpcLoadAppearance]]
* [[osNpcMoveTo]]
* [[osNpcMoveToTarget]]
* [[osNpcPlayAnimation]]
* [[osNpcRemove]]
* [[osNpcSaveAppearance]]
{{multicol-break}}
* [[osNpcSay]]
* [[osNpcSayTo]]
* [[osNpcSetProfileAbout]]
* [[osNpcSetProfileImage]]
* [[osNpcSetRot]]
* [[osNpcShout]]
* [[osNpcSit]]
* [[osNpcStand]]
* [[osNpcStopMoveToTarget]]
* [[osNpcStopAnimation]]
* [[osNpcTouch]]
* [[osNpcWhisper]]
{{multicol-end}}

=== Prim ===
{{multicol}}
* [[osClearInertia]]
* [[osClearObjectAnimations]]
* [[osDie]]
* [[osForceBreakAllLinks]]
* [[osForceBreakLink]]
* [[osForceCreateLink]]
* [[osGetInertiaData]]
* [[osGetInventoryItemKey]]
* [[osGetInventoryName]]
* [[osGetInventoryNames]] {{new}}
* [[osGetInventoryItemKeys]] {{new}}
* [[osGetInventoryDesc]]
* [[osGetInventoryLastOwner]]
* [[osGetLinkInventoryName]] {{new}}
* [[osGetLinkInventoryNames]] {{new}}
* [[osGetInventoryItemKey| osGetLinkInventoryItemKey]] {{new}}
* [[osGetInventoryItemKeys | osGetLinkInventoryItemKeys]] {{new}}
* [[osGetLinkInventoryKey]] {{new}}
* [[osGetLinkInventoryDesc]] {{new}}
* [[osGiveLinkInventory]] {{new}}
* [[osGiveLinkInventoryList]] {{new}}
* [[osRemoveLinkInventory]] {{new}}
* [[osGetLastChangedEventKey]]
* [[osGetLinkNumber]]
* [[osGetLinkPrimitiveParams]]
* [[osGetPrimitiveParams]]
{{multicol-break}}
* [[osGetRezzingObject]]
* [[osGetSitActiveRange]]
* [[osGetLinkSitActiveRange]]
* [[osGetSitTargetPos]] {{new}}
* [[osGetSitTargetRot]] {{new}}
* [[osGetStandTarget]]
* [[osGetLinkStandTarget]]
* [[osLinkParticleSystem]] {{new}}
* [[osMessageAttachments]]
* [[osMessageObject]]
* [[osParticleSystem]] {{new}}
* [[osSetInertia]]
* [[osSetInertiaAsBox]]
* [[osSetInertiaAsCylinder]]
* [[osSetInertiaAsSphere]]
* [[osSetPrimitiveParams]]
* [[osSetProjectionParams]]
* [[osSetSitActiveRange]]
* [[osSetLinkSitActiveRange]]
* [[osSetStandTarget]]
* [[osSetLinkStandTarget]]
* [[osTeleportObject]]
* [[osVolumeDetect]]
* [[osGetPrimCount]] {{new}}
* [[osGetSittingAvatarsCount]] {{new}}

{{multicol-end}}

=== Prim Drawing / Dynamic Texture ===
{{multicol}}
* [[osDrawEllipse]]
* [[osDrawFilledEllipse]]
* [[osDrawFilledPolygon]]
* [[osDrawFilledRectangle]]
* [[osDrawImage]]
* [[osDrawLine]]
* [[osDrawPolygon]]
* [[osDrawRectangle]]
* [[osDrawResetTransform]]
* [[osDrawRotationTransform]]
* [[osDrawScaleTransform]]
* [[osDrawText]]
* [[osDrawTranslationTransform]]
* [[osGetDrawStringSize]]
{{multicol-break}}
* [[osMovePen]]
* [[osSetFontName]]
* [[osSetFontSize]]
* [[osSetPenCap]]
* [[osSetPenColor]]
* [[osSetPenSize]]
* [[osSetDynamicTextureData]]
* [[osSetDynamicTextureDataFace]]
* [[osSetDynamicTextureDataBlend]]
* [[osSetDynamicTextureDataBlendFace]]
* [[osSetDynamicTextureURL]]
* [[osSetDynamicTextureURLBlend]]
* [[osSetDynamicTextureURLBlendFace]]
{{multicol-end}}

=== Notecard ===
* [[osGetNotecard]]
* [[osGetNotecardLine]]
* [[osGetNumberOfNotecardLines]]
* [[osMakeNotecard]]

=== Sound ===
{{multicol}}
* [[osAdjustSoundVolume]]
* [[osCollisionSound]]
* [[osLoopSound]]
* [[osLoopSoundMaster]]
* [[osLoopSoundSlave]]
* [[osPlaySound]]
{{multicol-break}}
* [[osPlaySoundSlave]]
* [[osPreloadSound]]
* [[osSetSoundRadius]]
* [[osStopSound]]
* [[osTriggerSound]]
* [[osTriggerSoundLimited]]
{{multicol-end}}

=== HTTP ===
* [[osRequestSecureURL]]
* [[osRequestURL]]
* [[osSetContentType]]

=== Parcel ===
{{multicol}}
* [[osParcelJoin]]
* [[osParcelSubdivide]]
* [[osGetParcelDwell]]
{{multicol-break}}
* [[osSetParcelDetails]]
* [[osGetParcelDetails]]
* [[osGetParcelIDs]]
* [[osGetParcelID]]
{{multicol-end}}

=== Terrain ===
* [[osGetTerrainHeight]]
* [[osSetTerrainHeight]]
* [[osSetTerrainTexture]]
* [[osSetTerrainTextureHeight]]
* [[osTerrainFlush]]

=== Region / Parcel Environment ===
{{multicol}}
* [[osGetCurrentSunHour]]
* [[osGetApparentTime]]
* [[osGetApparentTimeString]]
* [[osGetApparentRegionTime]]
* [[osGetApparentRegionTimeString]]
* [[osGetWindParam]]
{{multicol-break}}
* [[osSetRegionWaterHeight]]
* [[osSetWindParam]]
* [[osWindActiveModelPluginName]]
* [[osReplaceParcelEnvironment]]
* [[osReplaceRegionEnvironment]]
* [[osResetEnvironment]]
{{multicol-end}}

=== Grid / Region Information ===
{{multicol}}
* [[osCheckODE]]
* [[osGetGridCustom]]
* [[osGetGridGatekeeperURI]]
* [[osGetGridHomeURI]]
* [[osGetGridLoginURI]]
* [[osGetGridName]]
* [[osGetGridNick]]
* [[osGetMapTexture]]
* [[osGetPhysicsEngineName]]
* [[osGetPhysicsEngineType]]
{{multicol-break}}
* [[osGetRegionMapTexture]]
* [[osGetRegionSize]]
* [[osGetRegionStats]]
* [[osGetScriptEngineName]]
* [[osGetSimulatorMemory]]
* [[osGetSimulatorMemoryKB]]
* [[osGetSimulatorVersion]]
* [[osLoadedCreationDate]]
* [[osLoadedCreationID]]
* [[osLoadedCreationTime]]
{{multicol-end}}

=== Administration ===
* [[osConsoleCommand]]
* [[osRegionNotice]]
* [[osRegionRestart]]
* [[osSetParcelMediaURL]]
* [[osSetParcelMusicURL]]
* [[osSetParcelSIPAddress]]

=== Script ===
*[[osResetAllScripts]]

=== String Manipulation ===
{{multicol}}
* [[osFormatString]]
* [[osListenRegex]]
* [[osMatchString]]
* [[osRegexIsMatch]]
* [[osReplaceString]]
* [[osStringSubString]]
{{multicol-break}}
* [[osStringStartsWith]]
* [[osStringEndsWith]]
* [[osStringIndexOf]]
* [[osStringLastIndexOf]]
* [[osStringRemove]]
* [[osStringReplace]]
{{multicol-end}}

=== Misc ===
{{multicol}}
* [[osAESEncrypt]] {{new}}
* [[osAESDecrypt]] {{new}}
* [[osAESEncryptTo]] {{new}}
* [[osAESDecryptFrom]] {{new}}
* [[osAngleBetween]]
* [[osApproxEquals]]
* [[osGetPSTWallclock]]
* [[osListSortInPlace]]
* [[osListSortInPlaceStrided]] {{new}}
* [[osIsUUID]]
{{multicol-break}}
* [[osIsNotValidNumber]]
* [[osKey2Name]]
* [[osMax]]
* [[osMin]]
* [[osRound]]
* [[osSHA256]]
* [[osSlerp]]
* [[osUnixTimeToTimestamp]]
* [[osVecDistSquare]]
* [[osVecMagSquare]]
{{multicol-end}}

=== Deprecated ===
* [[osParcelSetDetails|<strike>osParcelSetDetails</strike>]] - Use [[osSetParcelDetails]]
* [[osSetPenColour|<strike>osSetPenColour</strike>]] - Use [[osSetPenColor]]
* [[osSunGetParam|<strike>osSunGetParam</strike>]] - Use [[osGetSunParam]]
* [[osSunSetParam|<strike>osSunSetParam</strike>]] - Use [[osSetSunParam]]
* [[osTerrainGetHeight|<strike>osTerrainGetHeight</strike>]] - Use [[osGetTerrainHeight]]
* [[osTerrainSetHeight|<strike>osTerrainSetHeight</strike>]] - Use [[osSetTerrainHeight]]
*<strike>osWindParamGet</strike> - Use [[osGetWindParam]]
*<strike>osWindParamSet</strike> - Use [[osSetWindParam]]
* [[osList2Double|<strike>osList2Double</strike>]] - Use llList2Float
* [[osGetSunParam]]
* [[osSetEstateSunSettings]]
* [[osSetRegionSunSettings]]
* [[osSetSunParam]]
* [[osSetPrimFloatOnWater]]

== See Also ==

* [[OSSL_vs_LSL|LSL&OSSL : Neighbour functions, similarities and differences]]
* [[Accessing_Prim_Properties|LSL&OSSL : Guide to prims addressing (by linknum, by uuid)]]
* [[LSL Status|LSL/OSSL Status Page]]
*OSSL
** [[OSSL_Implemented|OSSL Implemented Functions]]
** [[OSSL Constants|OSSL Constants]]
** [[OSSL Status/Types|OSSL Types Status Page]]
** [[OSSL Status/Events|OSSL Events Status Page]]

** [[Dynamic_textures|OSSL osDynamicTextures Functions Index Page]]
** [[OSSL TextureDrawing|OSSL TextureDrawing Extended Information]]
** [[OSSLNPC|OSSL functions for working with NPCs]]

** [[OSSL Proposals|OSSL Proposed Functions]]
** [[OSSL Enabling Functions]]
** [[OSSL Standards|OSSL Standards]]

* LS
** [[LightShare#LightShare Scripting|LightShare Functions]]

* MOD
** [[OSSL Script Library/ModSendCommand|modSendCommand()]]
** [[OSSL Script Library/ModInvoke|Custom functions using modInvoke()]]

* NPC
** [[Appearance_Formats|Appearance Notecard Format]]

[[Category:Scripting]]
[[Category:Scripts]]
[[Category:OSSL]]

OsGetLinkInventoryName

2024-05-18T20:50:10Z

JeffKelley: Missing 't'

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=string osGetLinkInventoryName(integer linkNumber, key itemId) 
|ossl_example=<source lang="lsl">
// Example for osGetLinkInventoryName
// This script uses the osGetLinkInventoryName function to get the name of an inventory item via the key and child prim number

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the key of the inventory item
key itemUUID = "INVENTORY_ITEM_KEY";

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the inventory item name via its key and the child prim number
string itemName = osGetLinkInventoryName(CHILD_PRIM_NUMBER, itemUUID);

// Check if the name is not empty
if (itemName != "")
{
// Output the item name to owner chat
llOwnerSay("Name of the inventory item with UUID " + (string)itemUUID + ": " + itemName);
}
else
{
// If the name is empty or the item is not found indicate as such
llOwnerSay("The inventory item with UUID " + (string)itemUUID + " may be empty or not found");
}
}
}
</source>
|description=
Return the name of an item located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0

osGetLinkInventoryName (linkNumber, itemId) is '''not''' an extension of llGetInventoryName (integer type, integer number) to links. 
To extend llGetInventoryName (type, number) to links, we must call osGetLinkInventoryNames (note the final 's') to get the list of 
inventory names for this type, sort the list, then extract the item at index 'number'. 

<source lang="lsl">
string myGetLinkInventoryName (integer linkNumber, integer type, integer number)
{
list names = osGetLinkInventoryNames (linkNumber, type);
names = llListSort (names, 1, TRUE);
return llList2String (names, number);
}
</source>
}}

OsGetLinkInventoryName

2024-05-18T20:49:24Z

JeffKelley: Missing space

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=string osGetLinkInventoryName(integer linkNumber, key itemId) 
|ossl_example=<source lang="lsl">
// Example for osGetLinkInventoryName
// This script uses the osGetLinkInventoryName function to get the name of an inventory item via the key and child prim number

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the key of the inventory item
key itemUUID = "INVENTORY_ITEM_KEY";

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the inventory item name via its key and the child prim number
string itemName = osGetLinkInventoryName(CHILD_PRIM_NUMBER, itemUUID);

// Check if the name is not empty
if (itemName != "")
{
// Output the item name to owner chat
llOwnerSay("Name of the inventory item with UUID " + (string)itemUUID + ": " + itemName);
}
else
{
// If the name is empty or the item is not found indicate as such
llOwnerSay("The inventory item with UUID " + (string)itemUUID + " may be empty or not found");
}
}
}
</source>
|description=
Return the name of an item located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0

osGetLinkInventoryName (linkNumber, itemId) is '''not''' an extension of llGetInventoryName (integer type, integer number) to links. 
To extend llGetInventoryName (type, number) to links, we must call osGetLinkInventoryNames (note the final 's') to get the list of 
inventory names for this type, sort the list, then extract the item a index 'number'. 

<source lang="lsl">
string myGetLinkInventoryName (integer linkNumber, integer type, integer number)
{
list names = osGetLinkInventoryNames (linkNumber, type);
names = llListSort (names, 1, TRUE);
return llList2String (names, number);
}
</source>
}}

OsGetLinkInventoryName

2024-05-18T16:43:07Z

JeffKelley:

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=string osGetLinkInventoryName(integer linkNumber, key itemId) 
|ossl_example=<source lang="lsl">
// Example for osGetLinkInventoryName
// This script uses the osGetLinkInventoryName function to get the name of an inventory item via the key and child prim number

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the key of the inventory item
key itemUUID = "INVENTORY_ITEM_KEY";

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the inventory item name via its key and the child prim number
string itemName = osGetLinkInventoryName(CHILD_PRIM_NUMBER, itemUUID);

// Check if the name is not empty
if (itemName != "")
{
// Output the item name to owner chat
llOwnerSay("Name of the inventory item with UUID " + (string)itemUUID + ": " + itemName);
}
else
{
// If the name is empty or the item is not found indicate as such
llOwnerSay("The inventory item with UUID " + (string)itemUUID + " may be empty or not found");
}
}
}
</source>
|description=
Return the name of an item located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0

osGetLinkInventoryName (linkNumber, itemId) is '''not''' an extension of llGetInventoryName (integer type, integer number) to links. 
To extend llGetInventoryName (type, number) to links, we must callosGetLinkInventoryNames (note the final 's') to get the list of 
inventory names for this type, sort the list, then extract the item a index 'number'. 

<source lang="lsl">
string myGetLinkInventoryName (integer linkNumber, integer type, integer number)
{
list names = osGetLinkInventoryNames (linkNumber, type);
names = llListSort (names, 1, TRUE);
return llList2String (names, number);
}
</source>
}}

OsGetLinkInventoryName

2024-05-18T16:23:28Z

JeffKelley:

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=string osGetLinkInventoryName(integer linkNumber, key itemId) 
|ossl_example=<source lang="lsl">
// Example for osGetLinkInventoryName
// This script uses the osGetLinkInventoryName function to get the name of an inventory item via the key and child prim number

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the key of the inventory item
key itemUUID = "INVENTORY_ITEM_KEY";

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the inventory item name via its key and the child prim number
string itemName = osGetLinkInventoryName(CHILD_PRIM_NUMBER, itemUUID);

// Check if the name is not empty
if (itemName != "")
{
// Output the item name to owner chat
llOwnerSay("Name of the inventory item with UUID " + (string)itemUUID + ": " + itemName);
}
else
{
// If the name is empty or the item is not found indicate as such
llOwnerSay("The inventory item with UUID " + (string)itemUUID + " may be empty or not found");
}
}
}
</source>
|description=
Return the name of an item located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0

 

osGetLinkInventoryName (linkNumber, itemId) is '''not''' an extension 
of llGetInventoryName (integer type, integer number) to links. 
To extend llGetInventoryName (type, number) to links, we must call 
osGetLinkInventoryNames (note the 's') to get the list of inventory names 
for this type, sort the list, then extract the item a index 'number'. 

<source lang="lsl">
string myGetLinkInventoryName (integer linkNumber, integer type, integer number)
{
list names = osGetLinkInventoryNames (linkNumber, type);
names = llListSort (names, 1, TRUE);
return llList2String (names, number);
}
</source>
}}

Build Instructions

2024-05-15T19:39:54Z

JeffKelley: /* Install dotnet under Debian/Ubuntu */

{{Quicklinks|Build_Instructions}}

This page covers building OpenSimulator from source code on multiple platforms. Please help us keep this page up to date as the project progresses. If you just want to run OpenSimulator, [[Download]] and [[Configuration|run]] the binary build instead. In the most cases, you should be fine with binaries.

= Obtaining the Source Code =

Check out the [[Download]] page for instructions on obtaining an OpenSimulator source release. If you want the current development code (i.e. the Git master branch) see [[Developer_Documentation#Source_Code_Repository_Access]].

= Building =

Although this page is long, building is generally quite simple. See the BUILDING.txt file in the distribution itself for simplified instructions.

== Version 0.9.3.0 and above ==
Microsoft stopped the development of .Net Framework and Mono, replacing them by new dotnet
This is a significant breaking change that we try to follow on 0.9.3.0.

=== Get source code ===

get or update source from git

git clone git://opensimulator.org/git/opensim

=== Building on Windows ===
To building under Windows, the following is required:

* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]

optionally also

* Visual Studio .NET, version 2022 or later

Create the project files running:

runprebuild.bat

Load the generated OpenSim.sln into Visual Studio and build the solution, or just run
compile.bat

to run you may also need
* to install the [https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170 run time files for vc++]
* to authorize the install of older .NetFramework 3.5

Configure, See [[Configuration]].

Now just run OpenSim.exe from the bin folder, and set up the region.

=== Building on Linux / Mac ===

you will need
* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]
* libgdiplus
**if you have mono 6.x complete, you already have libgdiplus, otherwise you need to install it using a package manager for your operating system, like apt, brew, macports, etc. For example on debian:
*** apt-get update && apt-get install -y apt-utils libgdiplus libc6-dev

Create the project files, run:

./runprebuild.sh

then run
dotnet build --configuration Release OpenSim.sln

or just
./compile.sh

Configure. See [[Configuration]].

run ./opensim.sh from the bin folder, and set up the region

== Older Versions ==
Source for old .Net Framework 4.x and Mono is in branch Mono-Net4X
This is mostly same code as 0.9.2.2 release.

== Requirements ==

OpenSimulator 0.9.0.x requires either
* [http://msdn.microsoft.com/en-us/netframework/cc378097 .NET Framework 4.0] on Windows
* [https://www.mono-project.com/download/stable/ Mono] on Linux or Mac. Mono 2.10.8 is the minimum version.
You may also need nant tool.

OpenSimulator >= 0.9.1 (including current master) requires
* [http://msdn.microsoft.com/en-us/netframework/cc378097 .NET Framework 4.6] on Windows
* [https://www.mono-project.com/download/stable/ Mono] on Linux or Mac. Mono 5.12 is the minimum recommended version. '''Note:''' rather than using your Linux distro's Mono packages, which may be missing required components, please [https://www.mono-project.com/download/stable/ install from the official Mono repo for your distro].
recommend compiling with msbuild.

Other platforms may have own mono distributions, or may need to compile mono on them.

Other libraries used by OpenSimulator can be found at our opensim-libs git repo:

git clone git://opensimulator.org/git/opensim-libs

libOpenMetaVerse used can be found at https://bitbucket.org/opensimulator/

You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries

== MS Windows ==

=== Supported Compilers ===
* [https://visualstudio.microsoft.com/downloads/ Visual Studio Community 2017]
* Or any version that does support the .Net version. At least VS2010 for versions prior to 0.91, VS2015 for 0.91 and after.
* OpenSimulator >=0.9.2.0 can compile for .Net Framework 4.8 using runprebuild48.bat instead of runprebuild.bat below and with VS2017/19/22

=== Compiling in an IDE ===
# Run "runprebuild.bat"
# Open the resulting "OpenSim.sln" in Visual Studio IDE.
# Select Debug or Release configuration
# Menu Build -> Build Solution.

===Compiling at the Command Prompt ===
# Run "runprebuild.bat".
# Run the resulting "compile.bat" file.

== Linux and Other Mono Platforms ==

=== Install dotnet under Debian/Ubuntu ===

For Ubuntu 22.04 LTS and higher, dotnet is available in the distribution's repos.

For Ubuntu 20.04 LTS and lower, and for all versions of Debian, add Microsoft repository to your installation :

<source lang="bash">
# Get OS version info
source /etc/os-release

# Download Microsoft signing key and repository
wget https://packages.microsoft.com/config/$ID/$VERSION_ID/packages-microsoft-prod.deb -O packages-microsoft-prod.deb

# Install Microsoft signing key and repository
sudo dpkg -i packages-microsoft-prod.deb

# Clean up
rm packages-microsoft-prod.deb

# Update packages
sudo apt update
</source>

Then :

<source lang="bash">
sudo apt update
sudo apt install dotnet-sdk-8.0
</source>

https://learn.microsoft.com/en-us/dotnet/core/install/linux-ubuntu 
https://learn.microsoft.com/en-us/dotnet/core/install/linux-debian 

=== Prepare to compile ===
To create the several project files run on the folder opensim:

./runprebuild.sh

==== Compile with Nant ====
On some mono versions, in particular old ones may need the use of nant to proper compile OpenSimulator, in that case just run:

nant

==== Compile with xbuild ====

On mono versions you can just use xbuild. ''(msbuild is recommended for 0.9.1.0.0+)''

xbuild

xbuild is no longer recommended on mono 5.x, but currently still works (5.12)

''>>>> xbuild tool is deprecated and will be removed in future updates, use msbuild instead <<<<''

On more recent mono versions Release configuration may give some performance gain, but you do lose some debug capabilities.
to compile Release configuration:
xbuild /p:Configuration=Release

==== Compile with msbuild ====
For Opensim 0.9.1 you can still use xbuild but Mono recommends the use of msbuild. You might need to install the package msbuild in addition to mono-complete for that. (Currently msbuild is included if you install mono-complete, on Ubuntu, from the official mono repositories. https://www.mono-project.com/download/stable/#download-lin )

Use xbuild on the other cases as a last resort.

Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.

to compile with Debug configuration:
msbuild

to compile with Release configuration:
msbuild /p:Configuration=Release

to compile with the debug configuration and detailed opensim.log file can then be read with a text editor:
msbuild /p:Configuration=Debug /fileLogger /flp:logfile=opensim.log /v:d

you can specify the following values for the level of detail of the opensim.log file:
q [quiet], m [minimal], n [normal], d [detailed] and diag [diagnostic].

To compile for .Net Framework 4.8 with mono >=6.12. you can run runprebuild48.sh instead of runprebuild.sh above. Not much gain doing that, if any.

== Ahead of Time compilation (AOT)==
As you all know the files *.exe and .dll created by the compiling process above do no contain native code for the machine. 
With those files, the native code required by the cpu is created at runtime, as needed, in a process known as Just in Time (JIT) 
It is possible to do another compile stage on those files to create native code, that will ready when the program starts. This is the Ahead of time process (AOT). 
Since JIT is done at runtime, it has limited time to do extensive code optimizations, AOT on the other hand can do all. 
AOT should this way be faster to load, save some the memory needed by JIT work, and reduce latency due to code generation when a new code section is needed. 
This way AOT helps reduce the huge performance gap between C# and a more proper language like C++, even considering JIT can do some optimization dependent on current code execution state, that AOT can't. (if you think c# is as fast as competent c++ code, better change what you are smoking...) 
In fact both .net and mono do AOT on their components during install 
JIT will still be active, compiling some other code at run time. OpenSim and used .net/mono framework parts depend on it. 

For Linux, 0.9.2.0 now includes scripts makeaot.sh and cleanaot.sh to help testing AOT. 
Run makeaot.sh after the compile stage above, to generate the native code files. The option -O=all must be added to mono when executing opensim.exe, ex: 
mono --desktop -O=all OpenSim.exe
Script cleanaot.sh removes the binary files used by AOT. You must run it if you recompile the code (to be safe even if running makeaot). 
DO NOT FORGET to run makeaot.sh or cleanaot.sh after recompile! 
The generated files are specific for that machine. Do not copy the native code files to other machine, unless it is absolutely identical 
The original .exe and .dll are still needed 

AOT is also possible in windows, but using different tools, and those add things to central repository on the machine, harder to isolate and maintain. see [https://docs.microsoft.com/en-us/dotnet/framework/tools/ngen-exe-native-image-generator ngen] 

Macs are.. Macs.. Future models may totally forbid JIT, like Apple mobile products do. Mono AOT on current Macs may work as on Linux 

In practical use, don't expect much more than a bit faster loading. 
Additionally, since compilation is different, it may add new issues. So test with care 
Opensim performance issues are mostly on its own code, terrible bad communications protocols, use of bad .net/mono framework code (demo quality in same cases), etc. 
And of course eternally broken GC 
But... well every ns counts.. 

= Configuration =

See [[Configuration]].

[[Category:Users]]
[[Category:Users]]
[[Category:Getting Started]]

Build Instructions

2024-05-15T19:38:51Z

JeffKelley: /* Linux and Other Mono Platforms */ Installing dotnet

{{Quicklinks|Build_Instructions}}

This page covers building OpenSimulator from source code on multiple platforms. Please help us keep this page up to date as the project progresses. If you just want to run OpenSimulator, [[Download]] and [[Configuration|run]] the binary build instead. In the most cases, you should be fine with binaries.

= Obtaining the Source Code =

Check out the [[Download]] page for instructions on obtaining an OpenSimulator source release. If you want the current development code (i.e. the Git master branch) see [[Developer_Documentation#Source_Code_Repository_Access]].

= Building =

Although this page is long, building is generally quite simple. See the BUILDING.txt file in the distribution itself for simplified instructions.

== Version 0.9.3.0 and above ==
Microsoft stopped the development of .Net Framework and Mono, replacing them by new dotnet
This is a significant breaking change that we try to follow on 0.9.3.0.

=== Get source code ===

get or update source from git

git clone git://opensimulator.org/git/opensim

=== Building on Windows ===
To building under Windows, the following is required:

* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]

optionally also

* Visual Studio .NET, version 2022 or later

Create the project files running:

runprebuild.bat

Load the generated OpenSim.sln into Visual Studio and build the solution, or just run
compile.bat

to run you may also need
* to install the [https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170 run time files for vc++]
* to authorize the install of older .NetFramework 3.5

Configure, See [[Configuration]].

Now just run OpenSim.exe from the bin folder, and set up the region.

=== Building on Linux / Mac ===

you will need
* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]
* libgdiplus
**if you have mono 6.x complete, you already have libgdiplus, otherwise you need to install it using a package manager for your operating system, like apt, brew, macports, etc. For example on debian:
*** apt-get update && apt-get install -y apt-utils libgdiplus libc6-dev

Create the project files, run:

./runprebuild.sh

then run
dotnet build --configuration Release OpenSim.sln

or just
./compile.sh

Configure. See [[Configuration]].

run ./opensim.sh from the bin folder, and set up the region

== Older Versions ==
Source for old .Net Framework 4.x and Mono is in branch Mono-Net4X
This is mostly same code as 0.9.2.2 release.

== Requirements ==

OpenSimulator 0.9.0.x requires either
* [http://msdn.microsoft.com/en-us/netframework/cc378097 .NET Framework 4.0] on Windows
* [https://www.mono-project.com/download/stable/ Mono] on Linux or Mac. Mono 2.10.8 is the minimum version.
You may also need nant tool.

OpenSimulator >= 0.9.1 (including current master) requires
* [http://msdn.microsoft.com/en-us/netframework/cc378097 .NET Framework 4.6] on Windows
* [https://www.mono-project.com/download/stable/ Mono] on Linux or Mac. Mono 5.12 is the minimum recommended version. '''Note:''' rather than using your Linux distro's Mono packages, which may be missing required components, please [https://www.mono-project.com/download/stable/ install from the official Mono repo for your distro].
recommend compiling with msbuild.

Other platforms may have own mono distributions, or may need to compile mono on them.

Other libraries used by OpenSimulator can be found at our opensim-libs git repo:

git clone git://opensimulator.org/git/opensim-libs

libOpenMetaVerse used can be found at https://bitbucket.org/opensimulator/

You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries

== MS Windows ==

=== Supported Compilers ===
* [https://visualstudio.microsoft.com/downloads/ Visual Studio Community 2017]
* Or any version that does support the .Net version. At least VS2010 for versions prior to 0.91, VS2015 for 0.91 and after.
* OpenSimulator >=0.9.2.0 can compile for .Net Framework 4.8 using runprebuild48.bat instead of runprebuild.bat below and with VS2017/19/22

=== Compiling in an IDE ===
# Run "runprebuild.bat"
# Open the resulting "OpenSim.sln" in Visual Studio IDE.
# Select Debug or Release configuration
# Menu Build -> Build Solution.

===Compiling at the Command Prompt ===
# Run "runprebuild.bat".
# Run the resulting "compile.bat" file.

== Linux and Other Mono Platforms ==

=== Install dotnet under Debian/Ubuntu ===

For Ubuntu 22.04 LTS and higher, dotnet is available in the distribution's repos. For Ubuntu 20.04 LTS and lower, and for all versions of Debian, add Microsoft repository to your installation :

<source lang="bash">
# Get OS version info
source /etc/os-release

# Download Microsoft signing key and repository
wget https://packages.microsoft.com/config/$ID/$VERSION_ID/packages-microsoft-prod.deb -O packages-microsoft-prod.deb

# Install Microsoft signing key and repository
sudo dpkg -i packages-microsoft-prod.deb

# Clean up
rm packages-microsoft-prod.deb

# Update packages
sudo apt update
</source>

Then :

<source lang="bash">
sudo apt update
sudo apt install dotnet-sdk-8.0
</source>

https://learn.microsoft.com/en-us/dotnet/core/install/linux-ubuntu 
https://learn.microsoft.com/en-us/dotnet/core/install/linux-debian 

=== Prepare to compile ===
To create the several project files run on the folder opensim:

./runprebuild.sh

==== Compile with Nant ====
On some mono versions, in particular old ones may need the use of nant to proper compile OpenSimulator, in that case just run:

nant

==== Compile with xbuild ====

On mono versions you can just use xbuild. ''(msbuild is recommended for 0.9.1.0.0+)''

xbuild

xbuild is no longer recommended on mono 5.x, but currently still works (5.12)

''>>>> xbuild tool is deprecated and will be removed in future updates, use msbuild instead <<<<''

On more recent mono versions Release configuration may give some performance gain, but you do lose some debug capabilities.
to compile Release configuration:
xbuild /p:Configuration=Release

==== Compile with msbuild ====
For Opensim 0.9.1 you can still use xbuild but Mono recommends the use of msbuild. You might need to install the package msbuild in addition to mono-complete for that. (Currently msbuild is included if you install mono-complete, on Ubuntu, from the official mono repositories. https://www.mono-project.com/download/stable/#download-lin )

Use xbuild on the other cases as a last resort.

Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.

to compile with Debug configuration:
msbuild

to compile with Release configuration:
msbuild /p:Configuration=Release

to compile with the debug configuration and detailed opensim.log file can then be read with a text editor:
msbuild /p:Configuration=Debug /fileLogger /flp:logfile=opensim.log /v:d

you can specify the following values for the level of detail of the opensim.log file:
q [quiet], m [minimal], n [normal], d [detailed] and diag [diagnostic].

To compile for .Net Framework 4.8 with mono >=6.12. you can run runprebuild48.sh instead of runprebuild.sh above. Not much gain doing that, if any.

== Ahead of Time compilation (AOT)==
As you all know the files *.exe and .dll created by the compiling process above do no contain native code for the machine. 
With those files, the native code required by the cpu is created at runtime, as needed, in a process known as Just in Time (JIT) 
It is possible to do another compile stage on those files to create native code, that will ready when the program starts. This is the Ahead of time process (AOT). 
Since JIT is done at runtime, it has limited time to do extensive code optimizations, AOT on the other hand can do all. 
AOT should this way be faster to load, save some the memory needed by JIT work, and reduce latency due to code generation when a new code section is needed. 
This way AOT helps reduce the huge performance gap between C# and a more proper language like C++, even considering JIT can do some optimization dependent on current code execution state, that AOT can't. (if you think c# is as fast as competent c++ code, better change what you are smoking...) 
In fact both .net and mono do AOT on their components during install 
JIT will still be active, compiling some other code at run time. OpenSim and used .net/mono framework parts depend on it. 

For Linux, 0.9.2.0 now includes scripts makeaot.sh and cleanaot.sh to help testing AOT. 
Run makeaot.sh after the compile stage above, to generate the native code files. The option -O=all must be added to mono when executing opensim.exe, ex: 
mono --desktop -O=all OpenSim.exe
Script cleanaot.sh removes the binary files used by AOT. You must run it if you recompile the code (to be safe even if running makeaot). 
DO NOT FORGET to run makeaot.sh or cleanaot.sh after recompile! 
The generated files are specific for that machine. Do not copy the native code files to other machine, unless it is absolutely identical 
The original .exe and .dll are still needed 

AOT is also possible in windows, but using different tools, and those add things to central repository on the machine, harder to isolate and maintain. see [https://docs.microsoft.com/en-us/dotnet/framework/tools/ngen-exe-native-image-generator ngen] 

Macs are.. Macs.. Future models may totally forbid JIT, like Apple mobile products do. Mono AOT on current Macs may work as on Linux 

In practical use, don't expect much more than a bit faster loading. 
Additionally, since compilation is different, it may add new issues. So test with care 
Opensim performance issues are mostly on its own code, terrible bad communications protocols, use of bad .net/mono framework code (demo quality in same cases), etc. 
And of course eternally broken GC 
But... well every ns counts.. 

= Configuration =

See [[Configuration]].

[[Category:Users]]
[[Category:Users]]
[[Category:Getting Started]]

OsGetLinkInventoryNames

2024-03-29T11:59:48Z

JeffKelley: Note about order

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=list osGetLinkInventoryNames(integer linkNumber, integer type) 
|ossl_example=<source lang="lsl">
// Example for osGetLinkInventoryNames
// This script uses the osGetLinkInventoryNames function to return a list of inventory items of a specified type in a specified child prim

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the inventory type
integer INVENTORY_TYPE = INVENTORY_ALL;

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the list of inventory items by name
list inventoryNames = osGetLinkInventoryNames(CHILD_PRIM_NUMBER, INVENTORY_TYPE);

// Check if the list contains items
if (llGetListLength(inventoryNames) > 0)
{
// Go through the list and output the names to owner chat
integer numItems = llGetListLength(inventoryNames);
string itemNames = "Inventory items:\n";
integer i;
for (i = 0; i < numItems; ++i)
{
string itemName = llList2String(inventoryNames, i);
itemNames += itemName + "\n";
}
llOwnerSay(itemNames);
}
else
{
// If nothing is found indicate as such
llOwnerSay("The inventory of the child prim is empty or does not contains items of this inventory type");
}
}
}
</source>
|description=
Return a list of items names by type (or INVENTORY_ALL) located in a child prim inventory.
List ordering is arbitrary. Successive calls may return different orders.
|additional_info=This function was added in 0.9.3.0
}}

OsGetInventoryItemKeys

2024-03-29T11:59:00Z

JeffKelley: Note about order

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=list osGetInventoryItemKeys(integer type) 
list osGetLinkInventoryItemKeys(integer linkNumber, integer type) 

|ossl_example=<source lang="lsl">
// Example for osGetInventoryItemKeys
// This script uses the osGetInventoryKeys function to return a list of keys based on inventory type

// Define the inventory type
integer INVENTORY_TYPE = INVENTORY_ALL;

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the list of keys
list itemUUIDs = osGetInventoryItemKeys(INVENTORY_TYPE);

// Check if the list contains items
if (llGetListLength(itemUUIDs) > 0)
{
// Go through the list and output it to owner chat
integer numItems = llGetListLength(itemUUIDs);
string uuidList = "UUIDs of the inventory items:\n";
integer i;
for (i = 0; i < numItems; ++i)
{
string itemUUID = llList2String(itemUUIDs, i);
uuidList += itemUUID + "\n";
}
llOwnerSay(uuidList);
}
else
{
// If the list is empty indicate as such
llOwnerSay("Inventory is empty or not items of inventory type were found");
}
}
}

</source>
<source lang="lsl">

// Example for osGetLinkInventoryItemKeys
// This script uses the osGetLinkInventoryItemKeys function to return a list of inventory items from a given child prim

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the inventory type to fetch a list of
integer INVENTORY_TYPE = INVENTORY_ALL;

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the list of keys for the inventory items of the child prim
list itemUUIDs = osGetLinkInventoryItemKeys(CHILD_PRIM_NUMBER, INVENTORY_TYPE);

// Check if the list contains items
if (llGetListLength(itemUUIDs) > 0)
{
// Go through the list and output it to owner chat
integer numItems = llGetListLength(itemUUIDs);
string uuidList = "Inventory UUIDs:\n";
integer i;
for (i = 0; i < numItems; ++i)
{
string itemUUID = llList2String(itemUUIDs, i);
uuidList += itemUUID + "\n";
}
llOwnerSay(uuidList);
}
else
{
// If there are not returns indicate as such
llOwnerSay("There are no items of that inventory type in the child prim");
}
}
}

</source>
|description=
Return a list of the items UUIDs by type (or INVENTORY_ALL) located in the host or child prim prim inventory.
List ordering is arbitrary. Successive calls may return different orders. 
Note that unlike llGetInventoryKey, this function returns the item ID, not ID of its asset.
|additional_info=Added in 0.9.3.0
}}

OsGetInventoryNames

2024-03-29T11:56:59Z

JeffKelley: Note about order

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=list osGetInventoryNames(integer type) 
|ossl_example=<source lang="lsl">
// Example for osGetInventoryNames
// This script uses the function osGetInventoryNames to return a list of inventory items by name
// based on the inventory type (INVENTORY_ALL)
// The found item names are output to owner chat

// Define the inventory type constant
integer INVENTORY_TYPE = INVENTORY_ALL;

// Event handler, that is executed on script start
default
{
state_entry()
{
// Use osGetInventoryNames to fetch the list of inventory items by name
list inventoryList = osGetInventoryNames(INVENTORY_TYPE);

// Check if the list is empty
if (llGetListLength(inventoryList) > 0)
{
// Go through the list and output each item to chat
integer numItems = llGetListLength(inventoryList);
string itemNames = "Inventory item(s):\n";
integer i;
for (i = 0; i < numItems; ++i)
{
string itemName = llList2String(inventoryList, i);
itemNames += itemName + "\n";
}
llOwnerSay(itemNames);
}
else
{
// If the list is empty give indication as such
llOwnerSay("Inventory is empty.");
}
}
}
</source>
|description=
Return a list of items names by type (or INVENTORY_ALL) located in the prim inventory.
List ordering is arbitrary. Successive calls may return different orders.
|additional_info=This function was added in 0.9.3.0
}}

OsGetInventoryItemKeys

2024-03-19T05:47:24Z

JeffKelley: Clarified GetInventoryKey/GetInventoryItemKey difference

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=list osGetInventoryItemKeys(integer type) 
list osGetLinkInventoryItemKeys(integer linkNumber, integer type) 

|ossl_example=<source lang="lsl">
// Example for osGetInventoryItemKeys
// This script uses the osGetInventoryKeys function to return a list of keys based on inventory type

// Define the inventory type
integer INVENTORY_TYPE = INVENTORY_ALL;

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the list of keys
list itemUUIDs = osGetInventoryItemKeys(INVENTORY_TYPE);

// Check if the list contains items
if (llGetListLength(itemUUIDs) > 0)
{
// Go through the list and output it to owner chat
integer numItems = llGetListLength(itemUUIDs);
string uuidList = "UUIDs of the inventory items:\n";
integer i;
for (i = 0; i < numItems; ++i)
{
string itemUUID = llList2String(itemUUIDs, i);
uuidList += itemUUID + "\n";
}
llOwnerSay(uuidList);
}
else
{
// If the list is empty indicate as such
llOwnerSay("Inventory is empty or not items of inventory type were found");
}
}
}

// Example for osGetLinkInventoryItemKeys
// This script uses the osGetLinkInventoryItemKeys function to return a list of inventory items from a given child prim

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the inventory type to fetch a list of
integer INVENTORY_TYPE = INVENTORY_ALL;

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the list of keys for the inventory items of the child prim
list itemUUIDs = osGetLinkInventoryItemKeys(CHILD_PRIM_NUMBER, INVENTORY_TYPE);

// Check if the list contains items
if (llGetListLength(itemUUIDs) > 0)
{
// Go through the list and output it to owner chat
integer numItems = llGetListLength(itemUUIDs);
string uuidList = "Inventory UUIDs:\n";
integer i;
for (i = 0; i < numItems; ++i)
{
string itemUUID = llList2String(itemUUIDs, i);
uuidList += itemUUID + "\n";
}
llOwnerSay(uuidList);
}
else
{
// If there are not returns indicate as such
llOwnerSay("There are no items of that inventory type in the child prim");
}
}
}

</source>
|description=
Return a list of the items UUIDs by type (or INVENTORY_ALL) located in the host or child prim prim inventory.
Note that unlike llGetInventoryKey, this function returns the item ID, not ID of its asset.
|additional_info=Added in 0.9.3.0
}}

OsGetInventoryItemKey

2024-03-19T05:47:21Z

JeffKelley: Clarified GetInventoryKey/GetInventoryItemKey difference

{{osslfunc
|threat_level=ignored
|permissions=Script owner needs modify, copy and transfer rights
|delay=0
|function_syntax=key osGetInventoryItemKey(string name) 
key osGetLinkInventoryItemKey(integer linkNumber, string name) 

|ossl_example=<source lang="lsl">
//
// osGetInventoryItemKey Script Exemple
// Author: Ubit
//

default
{
state_entry()
{
llSay(PUBLIC_CHANNEL, "Touch me to see osGetInventoryItemKey usage.");
}

touch_start(integer number)
{
key ItemKey = osGetInventoryItemKey("MyItemName");
if (ItemKey != NULL_KEY)llSay(PUBLIC_CHANNEL, "Item key is " + osGetInventoryDesc(ItemKey));
else llSay(PUBLIC_CHANNEL, "The item key is a NULL_KEY, item not found or owner has no rights ...");
}
}

// Example for osGetLinkInventoryItemKey
// This script uses the osGetLinkInventoryKey function to fetch the key of a specified inventory item in a specified child prim

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the inventory item name
string itemName = "INVENTORY_ITEM_NAME";

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the key of the inventory item by name in child prim
key itemUUID = osGetLinkInventoryItemKey(CHILD_PRIM_NUMBER, itemName);

// Check if the returned key is not NULL_KEY
if (itemUUID != NULL_KEY)
{
// Output the key to owner chat
llOwnerSay("UUID of the inventory item '" + itemName + "': " + (string)itemUUID);
}
else
{
// If the key is NULL_KEY then the item was not found
llOwnerSay("No inventory item named '" + itemName + "' was found");
}
}
}
</source>
|description=Returns id(key) of a inventory item within a prim inventory. If name is not unique result maybe unpredictable. Note that unlike llGetInventoryKey, this function returns the item ID, not ID of its asset.. Returns NULL_KEY if the item is not found or Owner has no rights
|additional_info=osGetInventoryItemKey added in 0.9.1.0 Dev, Implemented August, 16 2019 
osGetLinkInventoryKey added in 0.9.3.0 Dev, March 2024
}}
'''See Also:'''
* [[osGetInventoryName]]
* [[osGetInventoryDesc]]
* [[osGetInventoryLastOwner]]
* [[osGetLastChangedEventKey]]

Accessing Prim Properties

2024-03-09T20:20:38Z

JeffKelley: /* Writing accessors */ Added overloading

{{Quicklinks|Accessing_Prim_Properties}}
 

==A bit of history==

First, there was llSetColor.

Then, there was llSetLinkColor. That was a huge step forward, since it was releaving you from the burden to script each and every prim in your hair. Don't laugh. You may still find such blatantly outdated scripts on the Hypergrid. Do us a favor. Don't propagate them. Trash them. Rewrite them.

Later, it was recognized that the ability to access every property of a prim in a linkset from a master script was a Good Thing. It makes your application simpler to understand and to maintain, and helps reduce script count. llSetLinkPrimitiveParams was born.

Finally, OpenSimulator added it's own touch. Why not manipulate prims ''outside'' the linkset from a master script ? And we had osSetPrimitiveParams.

llGet/SetLinkPrimitiveParams, osGet/SetPrimitiveParams are the workhorse of prim manipulations. You can access every existing property of a prim from a centralized location. Streamlined, faster code. No more need for chat, or LinkedMessages between prims.

A special note about llGetObjectLinkKey : Introduced September, 2022, this function is the glue you need to access prims outside the linkset. Once you get the id of an external object (maybe using llSensor), you may call llGetObjectPrimCount (also consider osGetPrimCount which does not count sitting avatars) then iterate on llGetObjectLinkKey to get the id of each prim in the remote object. Finally, apply osGet/SetPrimitiveParams.

The following tables tries to sort out the functions available to manipulate prims, for each addressing method.

{| class="wikitable" style="margin:auto;text-align:center"
|-
! Target is script's host (prim containing the script)
! Target is link number (inside the linkset)
! Target is prim id (any prim you own in the scene)
|-
| llGetOwner || ||
|-
| llGetKey || llGetLinkKey(num) ||
|-
| llSetText || ||
|-
| llGetRot / llSetRot || ||
|-
| llGetScale / llSetScale || ||
|-
| llGetAlpha / llSetAlpha || llSetLinkAlpha(num) ||
|-
| llGetColor / llSetColor || llSetLinkColor(num) ||
|-
| llGetPos / llSetPos || ||
|-
| llGetObjectName / llSetObjectName || llGetLinkName(num) ||
|-(num)
| llGetObjectDesc / llSetObjectDesc || ||
|-
| llGetNumberOfSides || llGetLinkNumberOfSides(num) ||
|-
| llGetTexture / llSetTexture || llSetLinkTexture(num) ||
|-
| llSetTextureAnim || llSetLinkTextureAnim(num) ||
|-
| llParticleSystem || llLinkParticleSystem(num) ||
|-
| llSetPrimMediaParams || llSetLinkMedia(num) ||
|-
| || || llGetObjectPrimCount(uuid)
|-
| || || llGetObjectDetails(uuid)
|-
| || || llGetObjectLinkKey(uuid,num)
|-
!colspan="3" | "Universal" access (list of rules)

|-
| llGet/SetPrimitiveParams || llGet/SetLinkPrimitiveParams(num) || osGet/SetPrimitiveParams(uuid)
|}
 

==Example : A replicator==
Put this script in a box, along with a single-prim object named "seed". It will iterate on each prim of a named object you own in the scene, then rez an identical prim at a given offset, perfectly replicating the source object, even meshes. Sleeps are here for demo. Remove them for speedy replication. CLEANUP option will get rid of rezed prims.
<source lang="lsl">
string targetName = "Example"; // The name of an object you own in the scene
string seedName = "seed"; // Name of the seed prim
vector offset = <5,0,0>; // Offset of the dupicata

integer primcnt;
integer primnum;
key rootKey;

integer TupleLength (integer param)
{
if (param == PRIM_GLOW) return 1;
if (param == PRIM_COLOR) return 2;
if (param == PRIM_TEXGEN) return 1;
if (param == PRIM_TEXTURE) return 4;
if (param == PRIM_NORMAL) return 4;
if (param == PRIM_SPECULAR) return 7;
if (param == PRIM_BUMP_SHINY) return 2;
if (param == PRIM_FULLBRIGHT) return 1;

return 0; // Not a by-side parameter
}

list IterateFaces (list p, integer param)
{
integer tuplelength = TupleLength (param);
integer numsides = llGetListLength(p) / tuplelength;

// Une seule face, retourner [ param, ALL_SIDES, p ]
if (numsides == 1) return [ param, ALL_SIDES ] + p;

list result = [ ];
for (integer s=0; s<numsides; s++) {
list tuple = llList2List (p, s*tuplelength, (s+1)*tuplelength-1);
result += [ param, s ] + tuple;
}
return result;
}

CopyParams (key srcprim, key dstprim, integer param) {
if (TupleLength(param) == 0)
{
list p = osGetPrimitiveParams (srcprim, [ param ]);
if (param == PRIM_POSITION) p = [ llList2Vector (p,0) + offset ];
osSetPrimitiveParams (dstprim, [ param ] + p);
}
else
{
list p = osGetPrimitiveParams (srcprim, [ param, ALL_SIDES ]);
p = IterateFaces (p, param);
osSetPrimitiveParams (dstprim, p);
}
llSleep (0.1);
}

RezAPrim ()
{
if (++primnum > primcnt) llResetScript();
llRezObject (seedName, llGetPos()+<0,0,1>, ZERO_VECTOR, ZERO_ROTATION, 0);
}

PrimRezed (key dstkey)
{
llOwnerSay ("Processing link "+(string)primnum+" of "+(string)primcnt);
key srckey = llGetObjectLinkKey (rootKey, primnum);
llSleep (0.1);

CopyParams (srckey, dstkey, PRIM_POSITION);
CopyParams (srckey, dstkey, PRIM_ROTATION);
CopyParams (srckey, dstkey, PRIM_TYPE);
CopyParams (srckey, dstkey, PRIM_SIZE);
CopyParams (srckey, dstkey, PRIM_COLOR);
CopyParams (srckey, dstkey, PRIM_TEXTURE);
CopyParams (srckey, dstkey, PRIM_NORMAL);
CopyParams (srckey, dstkey, PRIM_SPECULAR);
CopyParams (srckey, dstkey, PRIM_TEXGEN);
CopyParams (srckey, dstkey, PRIM_BUMP_SHINY);
CopyParams (srckey, dstkey, PRIM_FULLBRIGHT);
CopyParams (srckey, dstkey, PRIM_PHYSICS_SHAPE_TYPE);

RezAPrim ();
}

key OwnerOf (key id)
{
list l = llGetObjectDetails (id, [ OBJECT_OWNER ]);
return llList2Key (l, 0);
}

default
{
state_entry()
{
llSetText ("READY", <0,1,0>, 1.0);
}

touch_start (integer n)
{
state dialog;
}
}

integer dlgchan = 99;
integer dlglistener;
state dialog
{
state_entry()
{
llSetText ("LISTENING", <0,1,0>, 1.0);
llDialog (llGetOwner(), "Action?", ["CLEANUP", "REPLICATE"], dlgchan);
dlglistener = llListen (dlgchan, "", llGetOwner(), "");
llSetTimerEvent (10);
}

listen (integer chan, string name, key id, string msg)
{
if (msg == "CLEANUP") state cleanup;
if (msg == "REPLICATE") state replicate;
}

timer ()
{
state default;
}

state_exit ()
{
llSetTimerEvent (0.0);
llListenRemove (dlglistener);
}
}

state cleanup
{
state_entry()
{
llSetText ("CLEANUP", <0,1,0>, 1.0);
llSensor (seedName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
llOwnerSay ("Garbage collecting "+(string)num);
for (integer i=0; i<num; i++) osDie (llDetectedKey(i));
state default;
}

no_sensor() {
llOwnerSay ("All clean.");
state default;
}
}

state replicate
{
state_entry()
{
llSetText ("REPLICATE", <0,1,0>, 1.0);
llSensor (targetName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
rootKey = llDetectedKey (0);

if (OwnerOf(rootKey) != llGetOwner())
{
llOwnerSay ("I don't own "+targetName+". Aborting.");
state default;
}

primcnt = llGetObjectPrimCount (rootKey);
primnum = 0; RezAPrim ();
}

no_sensor() {
llOwnerSay ("Object "+targetName+" was not found.");
state default;
}

object_rez (key uuid) {
PrimRezed (uuid);
}
}
</source>

==Writing accessors==

The Get/SetPrimitiveParams family of functions is awesomely powerful. It is also [https://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast quite arcane to write and decipher]. A way to get rid of these long lists of parameters cluttering your code is to encapsulate Get/SetPrimitiveParams in individual get/set accessors, actually 'filling the blanks' in the above table. Although this is much pleasant to read, note that doing so may hurt performance when you want to change many properties at once, which SetPrimitiveParams can do in one call. The following library is offered as an example.

<source lang="lsl">
// Index of properties for PRIM_TYPE_BOX, PRIM_TYPE_CYLINDER, PRIM_TYPE_PRISM

integer INDEX_TYPE = 0;
integer INDEX_HOLE = 1;
integer INDEX_CUT = 2;
integer INDEX_HOLLOW = 3;
integer INDEX_TWIST = 4;
integer INDEX_TAPER = 5;
integer INDEX_SHEAR = 6;

// Index of properties for PRIM_TEXTURE

integer INDEX_TEXTURE = 0;
integer INDEX_REPEATS = 1;
integer INDEX_OFFSETS = 2;
integer INDEX_ROTATION = 3;

// client script
// +---------------+------------+
// Taper | -1.0 0 +1.0 | 2.0 0.0 |
// Shear | -0.5 0 +0.5 | -0.5 +0.5 |
// Twist | -180 0 +180 | -1.0 +1.0 |
// +---------------+------------+

//
// Set accessors
//

mySetLinkName (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_NAME, text]);
}

mySetLinkDesc (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_DESC, text]);
}

mySetLinkText (integer link, string text, vector color) {
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXT, text, color, 1.0]);
}

mySetLinkColor (integer link, vector color, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_COLOR, face, color, 1.0]);
}

mySetLinkBright (integer link, integer bright, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_FULLBRIGHT, face, bright]);
}

mySetLinkGlow (integer link, float glow, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_GLOW, face, glow]);
}

// Les 3 suivants ne marchent pas pour ALL_SIDES

mySetLinkTexture (integer link, key texture, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [texture], INDEX_TEXTURE, INDEX_TEXTURE);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkRepeat (integer link, vector repeat, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [repeat], INDEX_REPEATS, INDEX_REPEATS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkOffset (integer link, vector offset, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [offset], INDEX_OFFSETS, INDEX_OFFSETS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkPos (integer link, vector pos) {
llSetLinkPrimitiveParamsFast (link, [PRIM_POS_LOCAL, pos]);
}

mySetLinkRot (integer link, rotation rot) {
llSetLinkPrimitiveParamsFast (link, [PRIM_ROT_LOCAL, rot]);
}

mySetLinkSize (integer link, vector size) {
llSetLinkPrimitiveParamsFast (link, [PRIM_SIZE, size]);
}

mySetLinkCut (integer link, vector cut) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [cut], INDEX_CUT, INDEX_CUT);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTwist (integer link, vector twist) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [twist], INDEX_TWIST, INDEX_TWIST);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTaper (integer link, vector taper) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [taper], INDEX_TAPER, INDEX_TAPER);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkShear (integer link, vector shear) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [shear], INDEX_SHEAR, INDEX_SHEAR);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkHollow (integer link, float hollow) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [hollow], INDEX_HOLLOW, INDEX_HOLLOW);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

//
// Get accessors
//

string myGetLinkName (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_NAME]);
return llList2String (l,0);
}

string myGetLinkDesc (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_DESC]);
return llList2String (l,0);
}

string myGetLinkText (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXT]);
return llList2String (l,0);
}

vector myGetLinkColor (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_COLOR, face]);
return llList2Vector (l,0);
}

integer myGetLinkBright (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_FULLBRIGHT, face]);
return llList2Integer (l,0);
}

float myGetLinkGlow (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_GLOW, face]);
return llList2Float (l,0);
}

key myGetLinkTexture (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Key(l,0);
}

vector myGetLinkRepeat (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,1);
}

vector myGetLinkOffset (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,2);
}

vector myGetLinkPos (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_POS_LOCAL]);
return llList2Vector (l,0);
}

vector myGetLinkSize (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_SIZE]);
return llList2Vector (l,0);
}

vector myGetLinkCut (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_CUT);
}

vector myGetLinkTwist (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TWIST);
}

vector myGetLinkTaper (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TAPER);
}

vector myGetLinkShear (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_SHEAR);
}

float myGetLinkHollow (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Float (l, INDEX_HOLLOW);
}
</source>
LL accessors can be effortlessly converted to OS versions. Just change prim_num to prim_key in argument list, and pick the right os/ll function. Finally, you can use function overloading to write universal routines :
<source lang="lsl">
SetPrimColor (key prim, vector color, integer side)
{
osSetPrimitiveParams (prim, [PRIM_COLOR, side, color, 1.0]);
}

SetPrimColor (integer prim, vector color, integer side)
{
llSetLinkPrimitiveParamsFast (prim, [PRIM_COLOR, side, color, 1.0]);
}
</source>

[[Category:Scripting]]
[[Category:Scripts]]
[[Category:OSSL]]

Accessing Prim Properties/de

2024-03-03T17:16:18Z

JeffKelley: /* Beispiel: Ein Replikator */ missing state transition

{{Quicklinks|Accessing_Prim_Properties}}
 

= Zugreifen auf Prim Eigenschaften =

==Ein wenig Geschichte==

Zuerst gab es llSetColor.

Dann gab es llSetLinkColor. Das war ein großer Fortschritt, da es Sie von der Last befreit hat, jedes einzelne Prim in Ihrem Haar zu skripten. Lache nicht. Möglicherweise finden Sie solche offensichtlich veralteten Skripte immer noch auf dem Hypergrid. Tun Sie uns einen Gefallen. Verbreiten Sie sie nicht. Mach sie kaputt. Schreiben Sie sie um.

Später erkannte man, dass die Möglichkeit, über ein Masterskript auf jede Eigenschaft eines Prims in einem Linkset zuzugreifen, eine gute Sache war. Dadurch wird Ihre Anwendung einfacher zu verstehen und zu warten und die Anzahl der Skripte wird reduziert. llSetLinkPrimitiveParams war geboren.

Schließlich hat OpenSimulator seine eigene Note hinzugefügt. Warum nicht Prims ''outside'' des Linkset von einem Masterskript aus manipulieren? Und wir hatten osSetPrimitiveParams.

llGet/SetLinkPrimitiveParams, osGet/SetPrimitiveParams sind das Arbeitstier der Prim-Manipulationen. Sie können von einem zentralen Ort aus auf alle vorhandenen Eigenschaften eines Prims zugreifen. Optimierter, schnellerer Code. Kein Chat oder LinkedMessages zwischen Prims mehr erforderlich.

Ein besonderer Hinweis zu llGetObjectLinkKey : Diese Funktion wurde im September 2022 eingeführt und ist der Kleber, den Sie benötigen, um auf Prims außerhalb des Linksets zuzugreifen. Sobald Sie die ID eines externen Objekts erhalten haben (vielleicht mit llSensor), können Sie llGetObjectPrimCount aufrufen (bedenken Sie auch osGetPrimCount, das sitzende Avatare nicht zählt) und dann mit llGetObjectLinkKey iterieren, um die ID jedes Prims im Remote-Objekt zu erhalten. Wenden Sie abschließend osGet/SetPrimitiveParams an.

In den folgenden Tabellen wird versucht, die zur Manipulation von Prims verfügbaren Funktionen für jede Adressierungsmethode zu sortieren.

{| class="wikitable" style="margin:auto;text-align:center"
|-
! Ziel ist der Host des Skripts (Prim, der das Skript enthält)
! Ziel ist die Linknummer (innerhalb des Linksets)
! Ziel ist die Prim-ID (jedes Prim, das Sie in der Szene besitzen)
|-
| llGetOwner || ||
|-
| llGetKey || llGetLinkKey(num) ||
|-
| llSetText || ||
|-
| llGetRot / llSetRot || ||
|-
| llGetScale / llSetScale || ||
|-
| llGetAlpha / llSetAlpha || llSetLinkAlpha(num) ||
|-
| llGetColor / llSetColor || llSetLinkColor(num) ||
|-
| llGetPos / llSetPos || ||
|-
| llGetObjectName / llSetObjectName || llGetLinkName(num) ||
|-(num)
| llGetObjectDesc / llSetObjectDesc || ||
|-
| llGetNumberOfSides || llGetLinkNumberOfSides(num) ||
|-
| llGetTexture / llSetTexture || llSetLinkTexture(num) ||
|-
| llSetTextureAnim || llSetLinkTextureAnim(num) ||
|-
| llParticleSystem || llLinkParticleSystem(num) ||
|-
| llSetPrimMediaParams || llSetLinkMedia(num) ||
|-
| || || llGetObjectPrimCount(uuid)
|-
| || || llGetObjectDetails(uuid)
|-
| || || llGetObjectLinkKey(uuid,num)
|-
!colspan="3" | "Universeller“ Zugriff (Regelliste)

|-
| llGet/SetPrimitiveParams || llGet/SetLinkPrimitiveParams(num) || osGet/SetPrimitiveParams(uuid)
|}
 

==Beispiel: Ein Replikator==
Fügen Sie dieses Skript zusammen mit einem Single-Prim-Objekt namens „seed“ in eine Box ein.

Es iteriert auf jedem Prim eines benannten Objekts, das Sie in der Szene besitzen, und rezerrt dann ein identisches Prim mit einem bestimmten Offset,

wodurch das Quellobjekt, sogar die Netze, perfekt repliziert wird. Sleeps sind zur Demo hier.

Entfernen Sie sie für eine schnelle Replikation. Mit der CLEANUP-Option werden gelöschte Prims entfernt.
<source lang="lsl">
string targetName = "Example"; // Name des Zielobjekts, das dupliziert werden soll
string seedName = "seed"; // Name des Ausgangs-Prims, der dupliziert werden soll
vector offset = <5,0,0>; // Versatz für die Duplikate

integer primcnt; // Anzahl der Prims im Wurzelobjekt
integer primnum; // Aktuelle Nummer des zu kopierenden Prims
key rootKey; // Schlüssel des Wurzelobjekts

// Funktion zur Bestimmung der Länge eines Tupels basierend auf dem Parameter
integer TupleLength (integer param)
{
if (param == PRIM_GLOW) return 1;
if (param == PRIM_COLOR) return 2;
if (param == PRIM_TEXGEN) return 1;
if (param == PRIM_TEXTURE) return 4;
if (param == PRIM_NORMAL) return 4;
if (param == PRIM_SPECULAR) return 7;
if (param == PRIM_BUMP_SHINY) return 2;
if (param == PRIM_FULLBRIGHT) return 1;

return 0; // Not a by-side parameter
}

// Funktion zum Iterieren durch die Seiten (Faces) eines Prims und Rückgabe der Parametertupel für jede Seite
list IterateFaces (list p, integer param)
{
integer tuplelength = TupleLength (param);
integer numsides = llGetListLength(p) / tuplelength;

// Une seule face, retourner [ param, ALL_SIDES, p ]
if (numsides == 1) return [ param, ALL_SIDES ] + p;

list result = [ ];
for (integer s=0; s<numsides; s++) {
list tuple = llList2List (p, s*tuplelength, (s+1)*tuplelength-1);
result += [ param, s ] + tuple;
}
return result;
}

// Funktion zum Kopieren der Parameter eines Prims von einer Quelle zu einem Ziel
CopyParams (key srcprim, key dstprim, integer param) {
if (TupleLength(param) == 0)
{
list p = osGetPrimitiveParams (srcprim, [ param ]);
if (param == PRIM_POSITION) p = [ llList2Vector (p,0) + offset ];
osSetPrimitiveParams (dstprim, [ param ] + p);
}
else
{
list p = osGetPrimitiveParams (srcprim, [ param, ALL_SIDES ]);
p = IterateFaces (p, param);
osSetPrimitiveParams (dstprim, p);
}
llSleep (0.1);
}

// Funktion zum Erstellen eines neuen Prims
RezAPrim ()
{
if (++primnum > primcnt) llResetScript();
llRezObject (seedName, llGetPos()+<0,0,1>, ZERO_VECTOR, ZERO_ROTATION, 0);
}

// Funktion, die aufgerufen wird, wenn ein Prim rezisiert wurde
// Kopiert die Parameter des ursprünglichen Prims auf den rezisierten Prim
PrimRezed (key dstkey)
{
llOwnerSay ("Processing link "+(string)primnum+" of "+(string)primcnt);
key srckey = llGetObjectLinkKey (rootKey, primnum);
llSleep (0.1);

CopyParams (srckey, dstkey, PRIM_POSITION);
CopyParams (srckey, dstkey, PRIM_ROTATION);
CopyParams (srckey, dstkey, PRIM_TYPE);
CopyParams (srckey, dstkey, PRIM_SIZE);
CopyParams (srckey, dstkey, PRIM_COLOR);
CopyParams (srckey, dstkey, PRIM_TEXTURE);
CopyParams (srckey, dstkey, PRIM_NORMAL);
CopyParams (srckey, dstkey, PRIM_SPECULAR);
CopyParams (srckey, dstkey, PRIM_TEXGEN);
CopyParams (srckey, dstkey, PRIM_BUMP_SHINY);
CopyParams (srckey, dstkey, PRIM_FULLBRIGHT);
CopyParams (srckey, dstkey, PRIM_PHYSICS_SHAPE_TYPE);

RezAPrim ();
}

// Funktion zum Abrufen des Besitzers eines Objekts anhand der Objekt-ID
key OwnerOf (key id)
{
list l = llGetObjectDetails (id, [ OBJECT_OWNER ]);
return llList2Key (l, 0);
}

default
{
state_entry()
{
// Initialisierung des Skripts
llSetText ("READY", <0,1,0>, 1.0);
}

touch_start (integer n)
{
// Wenn das Objekt berührt wird, wechselt der Zustand in den Dialog-Modus
state dialog;
}
}

integer dlgchan = 99;
integer dlglistener;
state dialog
{
state_entry()
{
// Initialisierung des Dialog-Modus
llSetText ("LISTENING", <0,1,0>, 1.0);
llDialog (llGetOwner(), "Action?", ["CLEANUP", "REPLICATE"], dlgchan);
dlglistener = llListen (dlgchan, "", llGetOwner(), "");
llSetTimerEvent (10);
}

// Abhören von Dialognachrichten und Auslösen entsprechender Aktionen
listen (integer chan, string name, key id, string msg)
{
if (msg == "CLEANUP") state cleanup;
if (msg == "REPLICATE") state replicate;
}

timer ()
{
// Timer-Ereignis zum Zurückkehren in den Standardzustand nach einer bestimmten Zeit
state default;
}

state_exit ()
{
// Aufräumen beim Verlassen des Dialog-Modus
llSetTimerEvent (0.0);
llListenRemove (dlglistener);
}
}

state cleanup
{
state_entry()
{
// Zustand für die Bereinigung von Prims
llSetText ("CLEANUP", <0,1,0>, 1.0);
llSensor (seedName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
// Ereignis, das ausgelöst wird, wenn Sensoren aktiv sind
llOwnerSay ("Garbage collecting "+(string)num);
for (integer i=0; i<num; i++) osDie (llDetectedKey(i));
state default;
}

no_sensor() {
// Ereignis, das ausgelöst wird, wenn keine Sensoren aktiv sind
llOwnerSay ("All clean.");
state default;
}
}

state replicate
{
state_entry()
{
// Zustand für die Replikation von Prims
llSetText ("REPLICATE", <0,1,0>, 1.0);
llSensor (targetName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
// Ereignis, das ausgelöst wird, wenn Sensoren aktiv sind
rootKey = llDetectedKey (0);

if (OwnerOf(rootKey) != llGetOwner())
{
llOwnerSay ("I don't own "+targetName+". Aborting.");
state default;
}

primcnt = llGetObjectPrimCount (rootKey);
primnum = 0; RezAPrim ();
}

no_sensor() {
// Ereignis, das ausgelöst wird, wenn keine Sensoren aktiv sind
llOwnerSay ("Object "+targetName+" was not found.");
state default;
}

object_rez (key uuid) {
// Ereignis, das ausgelöst wird, wenn ein Objekt rezisiert wird
PrimRezed (uuid);
}
}
</source>

==Schreibzugriffsmethoden==

Die Funktionsfamilie Get/SetPrimitiveParams ist unglaublich leistungsstark.

Es ist auch [https://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast ziemlich geheimnisvoll zu schreiben und zu entschlüsseln].

Eine Möglichkeit, diese langen Parameterlisten loszuwerden, die Ihren Code überladen, besteht darin,

Get/SetPrimitiveParams in einzelne get/set-Accessoren zu kapseln und so tatsächlich die Lücken in der obigen Tabelle zu füllen.

Obwohl dies sehr angenehm zu lesen ist, beachten Sie, dass dies die Leistung beeinträchtigen kann,

wenn Sie viele Eigenschaften auf einmal ändern möchten, was SetPrimitiveParams in einem Aufruf tun kann.

Als Beispiel wird die folgende Bibliothek angeboten.

<source lang="lsl">
// Indizes der Eigenschaften für PRIM_TYPE_BOX, PRIM_TYPE_CYLINDER, PRIM_TYPE_PRISM

integer INDEX_TYPE = 0; // Typ
integer INDEX_HOLE = 1; // Lochgröße
integer INDEX_CUT = 2; // Schnittgröße
integer INDEX_HOLLOW = 3; // Leeregröße
integer INDEX_TWIST = 4; // Verdrehung
integer INDEX_TAPER = 5; // Zulauf
integer INDEX_SHEAR = 6; // Scherung

// Indizes der Eigenschaften für PRIM_TEXTURE

integer INDEX_TEXTURE = 0; // Textur
integer INDEX_REPEATS = 1; // Wiederholungen
integer INDEX_OFFSETS = 2; // Versatz
integer INDEX_ROTATION = 3; // Rotation

// Indizes der Eigenschaften für PRIM_COLOR
// client script
// +---------------+------------+
// Taper | -1.0 0 +1.0 | 2.0 0.0 |
// Shear | -0.5 0 +0.5 | -0.5 +0.5 |
// Twist | -180 0 +180 | -1.0 +1.0 |
// +---------------+------------+

// Set-Methoden

mySetLinkName (integer link, string text) {
// Setzt den Namen eines Links
llSetLinkPrimitiveParamsFast (link, [PRIM_NAME, text]);
}

mySetLinkDesc (integer link, string text) {
// Setzt die Beschreibung eines Links
llSetLinkPrimitiveParamsFast (link, [PRIM_DESC, text]);
}

mySetLinkText (integer link, string text, vector color) {
// Setzt den Text eines Links mit Farbe
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXT, text, color, 1.0]);
}

mySetLinkColor (integer link, vector color, integer face) {
// Setzt die Farbe eines Links für eine bestimmte Seite
llSetLinkPrimitiveParamsFast (link, [PRIM_COLOR, face, color, 1.0]);
}

mySetLinkBright (integer link, integer bright, integer face) {
// Setzt die Helligkeit eines Links für eine bestimmte Seite
llSetLinkPrimitiveParamsFast (link, [PRIM_FULLBRIGHT, face, bright]);
}

mySetLinkGlow (integer link, float glow, integer face) {
// Setzt das Leuchten eines Links für eine bestimmte Seite
llSetLinkPrimitiveParamsFast (link, [PRIM_GLOW, face, glow]);
}

// Die folgenden drei funktionieren nicht für ALL_SIDES

mySetLinkTexture (integer link, key texture, integer face) {
// Setzt die Textur eines Links für eine bestimmte Seite
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [texture], INDEX_TEXTURE, INDEX_TEXTURE);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkRepeat (integer link, vector repeat, integer face) {
// Setzt die Texturwiederholungen eines Links für eine bestimmte Seite
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [repeat], INDEX_REPEATS, INDEX_REPEATS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkOffset (integer link, vector offset, integer face) {
// Setzt den Texturversatz eines Links für eine bestimmte Seite
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [offset], INDEX_OFFSETS, INDEX_OFFSETS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkPos (integer link, vector pos) {
// Setzt die Position eines Links relativ zum Elternobjekt
llSetLinkPrimitiveParamsFast (link, [PRIM_POS_LOCAL, pos]);
}

mySetLinkRot (integer link, rotation rot) {
// Setzt die Rotation eines Links relativ zum Elternobjekt
llSetLinkPrimitiveParamsFast (link, [PRIM_ROT_LOCAL, rot]);
}

mySetLinkSize (integer link, vector size) {
// Setzt die Größe eines Links
llSetLinkPrimitiveParamsFast (link, [PRIM_SIZE, size]);
}

mySetLinkCut (integer link, vector cut) {
// Setzt den Schnitt eines Links (nur für Boxen, Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [cut], INDEX_CUT, INDEX_CUT);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTwist (integer link, vector twist) {
// Setzt die Verdrehung eines Links (nur für Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [twist], INDEX_TWIST, INDEX_TWIST);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTaper (integer link, vector taper) {
// Setzt den Zulauf eines Links (nur für Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [taper], INDEX_TAPER, INDEX_TAPER);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkShear (integer link, vector shear) {
// Setzt die Scherung eines Links (nur für Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [shear], INDEX_SHEAR, INDEX_SHEAR);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkHollow (integer link, float hollow) {
// Setzt die Hohlheit eines Links (nur für Boxen, Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [hollow], INDEX_HOLLOW, INDEX_HOLLOW);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

// Get-Methoden

string myGetLinkName (integer link) {
// Gibt den Namen eines Links zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_NAME]);
return llList2String (l,0);
}

string myGetLinkDesc (integer link) {
// Gibt die Beschreibung eines Links zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_DESC]);
return llList2String (l,0);
}

string myGetLinkText (integer link) {
// Gibt den Text eines Links zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXT]);
return llList2String (l,0);
}

vector myGetLinkColor (integer link, integer face) {
// Gibt die Farbe eines Links für eine bestimmte Seite zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_COLOR, face]);
return llList2Vector (l,0);
}

integer myGetLinkBright (integer link, integer face) {
// Gibt die Helligkeit eines Links für eine bestimmte Seite zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_FULLBRIGHT, face]);
return llList2Integer (l,0);
}

float myGetLinkGlow (integer link, integer face) {
// Gibt das Leuchten eines Links für eine bestimmte Seite zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_GLOW, face]);
return llList2Float (l,0);
}

key myGetLinkTexture (integer link, integer face) {
// Gibt die Textur eines Links für eine bestimmte Seite zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Key(l,0);
}

vector myGetLinkRepeat (integer link, integer face) {
// Gibt die Texturwiederholungen eines Links für eine bestimmte Seite zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,1);
}

vector myGetLinkOffset (integer link, integer face) {
// Gibt den Texturversatz eines Links für eine bestimmte Seite zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,2);
}

vector myGetLinkPos (integer link) {
// Gibt die Position eines Links relativ zum Elternobjekt zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_POS_LOCAL]);
return llList2Vector (l,0);
}

vector myGetLinkSize (integer link) {
// Gibt die Größe eines Links zurück
list l = llGetLinkPrimitiveParams (link, [PRIM_SIZE]);
return llList2Vector (l,0);
}

vector myGetLinkCut (integer link) {
// Gibt den Schnitt eines Links zurück (nur für Boxen, Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_CUT);
}

vector myGetLinkTwist (integer link) {
// Gibt die Verdrehung eines Links zurück (nur für Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TWIST);
}

vector myGetLinkTaper (integer link) {
// Gibt den Zulauf eines Links zurück (nur für Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TAPER);
}

vector myGetLinkShear (integer link) {
// Gibt die Scherung eines Links zurück (nur für Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_SHEAR);
}

float myGetLinkHollow (integer link) {
// Gibt die Hohlheit eines Links zurück (nur für Boxen, Zylinder und Prismen)
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Float (l, INDEX_HOLLOW);
}
</source>

[[Category:Scripting]]
[[Category:German Translations]]

Accessing Prim Properties

2024-03-03T17:14:47Z

JeffKelley: /* Example : A replicator */ missing state transition

{{Quicklinks|Accessing_Prim_Properties}}
 

==A bit of history==

First, there was llSetColor.

Then, there was llSetLinkColor. That was a huge step forward, since it was releaving you from the burden to script each and every prim in your hair. Don't laugh. You may still find such blatantly outdated scripts on the Hypergrid. Do us a favor. Don't propagate them. Trash them. Rewrite them.

Later, it was recognized that the ability to access every property of a prim in a linkset from a master script was a Good Thing. It makes your application simpler to understand and to maintain, and helps reduce script count. llSetLinkPrimitiveParams was born.

Finally, OpenSimulator added it's own touch. Why not manipulate prims ''outside'' the linkset from a master script ? And we had osSetPrimitiveParams.

llGet/SetLinkPrimitiveParams, osGet/SetPrimitiveParams are the workhorse of prim manipulations. You can access every existing property of a prim from a centralized location. Streamlined, faster code. No more need for chat, or LinkedMessages between prims.

A special note about llGetObjectLinkKey : Introduced September, 2022, this function is the glue you need to access prims outside the linkset. Once you get the id of an external object (maybe using llSensor), you may call llGetObjectPrimCount (also consider osGetPrimCount which does not count sitting avatars) then iterate on llGetObjectLinkKey to get the id of each prim in the remote object. Finally, apply osGet/SetPrimitiveParams.

The following tables tries to sort out the functions available to manipulate prims, for each addressing method.

{| class="wikitable" style="margin:auto;text-align:center"
|-
! Target is script's host (prim containing the script)
! Target is link number (inside the linkset)
! Target is prim id (any prim you own in the scene)
|-
| llGetOwner || ||
|-
| llGetKey || llGetLinkKey(num) ||
|-
| llSetText || ||
|-
| llGetRot / llSetRot || ||
|-
| llGetScale / llSetScale || ||
|-
| llGetAlpha / llSetAlpha || llSetLinkAlpha(num) ||
|-
| llGetColor / llSetColor || llSetLinkColor(num) ||
|-
| llGetPos / llSetPos || ||
|-
| llGetObjectName / llSetObjectName || llGetLinkName(num) ||
|-(num)
| llGetObjectDesc / llSetObjectDesc || ||
|-
| llGetNumberOfSides || llGetLinkNumberOfSides(num) ||
|-
| llGetTexture / llSetTexture || llSetLinkTexture(num) ||
|-
| llSetTextureAnim || llSetLinkTextureAnim(num) ||
|-
| llParticleSystem || llLinkParticleSystem(num) ||
|-
| llSetPrimMediaParams || llSetLinkMedia(num) ||
|-
| || || llGetObjectPrimCount(uuid)
|-
| || || llGetObjectDetails(uuid)
|-
| || || llGetObjectLinkKey(uuid,num)
|-
!colspan="3" | "Universal" access (list of rules)

|-
| llGet/SetPrimitiveParams || llGet/SetLinkPrimitiveParams(num) || osGet/SetPrimitiveParams(uuid)
|}
 

==Example : A replicator==
Put this script in a box, along with a single-prim object named "seed". It will iterate on each prim of a named object you own in the scene, then rez an identical prim at a given offset, perfectly replicating the source object, even meshes. Sleeps are here for demo. Remove them for speedy replication. CLEANUP option will get rid of rezed prims.
<source lang="lsl">
string targetName = "Example"; // The name of an object you own in the scene
string seedName = "seed"; // Name of the seed prim
vector offset = <5,0,0>; // Offset of the dupicata

integer primcnt;
integer primnum;
key rootKey;

integer TupleLength (integer param)
{
if (param == PRIM_GLOW) return 1;
if (param == PRIM_COLOR) return 2;
if (param == PRIM_TEXGEN) return 1;
if (param == PRIM_TEXTURE) return 4;
if (param == PRIM_NORMAL) return 4;
if (param == PRIM_SPECULAR) return 7;
if (param == PRIM_BUMP_SHINY) return 2;
if (param == PRIM_FULLBRIGHT) return 1;

return 0; // Not a by-side parameter
}

list IterateFaces (list p, integer param)
{
integer tuplelength = TupleLength (param);
integer numsides = llGetListLength(p) / tuplelength;

// Une seule face, retourner [ param, ALL_SIDES, p ]
if (numsides == 1) return [ param, ALL_SIDES ] + p;

list result = [ ];
for (integer s=0; s<numsides; s++) {
list tuple = llList2List (p, s*tuplelength, (s+1)*tuplelength-1);
result += [ param, s ] + tuple;
}
return result;
}

CopyParams (key srcprim, key dstprim, integer param) {
if (TupleLength(param) == 0)
{
list p = osGetPrimitiveParams (srcprim, [ param ]);
if (param == PRIM_POSITION) p = [ llList2Vector (p,0) + offset ];
osSetPrimitiveParams (dstprim, [ param ] + p);
}
else
{
list p = osGetPrimitiveParams (srcprim, [ param, ALL_SIDES ]);
p = IterateFaces (p, param);
osSetPrimitiveParams (dstprim, p);
}
llSleep (0.1);
}

RezAPrim ()
{
if (++primnum > primcnt) llResetScript();
llRezObject (seedName, llGetPos()+<0,0,1>, ZERO_VECTOR, ZERO_ROTATION, 0);
}

PrimRezed (key dstkey)
{
llOwnerSay ("Processing link "+(string)primnum+" of "+(string)primcnt);
key srckey = llGetObjectLinkKey (rootKey, primnum);
llSleep (0.1);

CopyParams (srckey, dstkey, PRIM_POSITION);
CopyParams (srckey, dstkey, PRIM_ROTATION);
CopyParams (srckey, dstkey, PRIM_TYPE);
CopyParams (srckey, dstkey, PRIM_SIZE);
CopyParams (srckey, dstkey, PRIM_COLOR);
CopyParams (srckey, dstkey, PRIM_TEXTURE);
CopyParams (srckey, dstkey, PRIM_NORMAL);
CopyParams (srckey, dstkey, PRIM_SPECULAR);
CopyParams (srckey, dstkey, PRIM_TEXGEN);
CopyParams (srckey, dstkey, PRIM_BUMP_SHINY);
CopyParams (srckey, dstkey, PRIM_FULLBRIGHT);
CopyParams (srckey, dstkey, PRIM_PHYSICS_SHAPE_TYPE);

RezAPrim ();
}

key OwnerOf (key id)
{
list l = llGetObjectDetails (id, [ OBJECT_OWNER ]);
return llList2Key (l, 0);
}

default
{
state_entry()
{
llSetText ("READY", <0,1,0>, 1.0);
}

touch_start (integer n)
{
state dialog;
}
}

integer dlgchan = 99;
integer dlglistener;
state dialog
{
state_entry()
{
llSetText ("LISTENING", <0,1,0>, 1.0);
llDialog (llGetOwner(), "Action?", ["CLEANUP", "REPLICATE"], dlgchan);
dlglistener = llListen (dlgchan, "", llGetOwner(), "");
llSetTimerEvent (10);
}

listen (integer chan, string name, key id, string msg)
{
if (msg == "CLEANUP") state cleanup;
if (msg == "REPLICATE") state replicate;
}

timer ()
{
state default;
}

state_exit ()
{
llSetTimerEvent (0.0);
llListenRemove (dlglistener);
}
}

state cleanup
{
state_entry()
{
llSetText ("CLEANUP", <0,1,0>, 1.0);
llSensor (seedName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
llOwnerSay ("Garbage collecting "+(string)num);
for (integer i=0; i<num; i++) osDie (llDetectedKey(i));
state default;
}

no_sensor() {
llOwnerSay ("All clean.");
state default;
}
}

state replicate
{
state_entry()
{
llSetText ("REPLICATE", <0,1,0>, 1.0);
llSensor (targetName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
rootKey = llDetectedKey (0);

if (OwnerOf(rootKey) != llGetOwner())
{
llOwnerSay ("I don't own "+targetName+". Aborting.");
state default;
}

primcnt = llGetObjectPrimCount (rootKey);
primnum = 0; RezAPrim ();
}

no_sensor() {
llOwnerSay ("Object "+targetName+" was not found.");
state default;
}

object_rez (key uuid) {
PrimRezed (uuid);
}
}
</source>

==Writing accessors==

The Get/SetPrimitiveParams family of functions is awesomely powerful. It is also [https://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast quite arcane to write and decipher]. A way to get rid of these long lists of parameters cluttering your code is to encapsulate Get/SetPrimitiveParams in individual get/set accessors, actually 'filling the blanks' in the above table. Although this is much pleasant to read, note that doing so may hurt performance when you want to change many properties at once, which SetPrimitiveParams can do in one call. The following library is offered as an example.

<source lang="lsl">
// Index of properties for PRIM_TYPE_BOX, PRIM_TYPE_CYLINDER, PRIM_TYPE_PRISM

integer INDEX_TYPE = 0;
integer INDEX_HOLE = 1;
integer INDEX_CUT = 2;
integer INDEX_HOLLOW = 3;
integer INDEX_TWIST = 4;
integer INDEX_TAPER = 5;
integer INDEX_SHEAR = 6;

// Index of properties for PRIM_TEXTURE

integer INDEX_TEXTURE = 0;
integer INDEX_REPEATS = 1;
integer INDEX_OFFSETS = 2;
integer INDEX_ROTATION = 3;

// client script
// +---------------+------------+
// Taper | -1.0 0 +1.0 | 2.0 0.0 |
// Shear | -0.5 0 +0.5 | -0.5 +0.5 |
// Twist | -180 0 +180 | -1.0 +1.0 |
// +---------------+------------+

//
// Set accessors
//

mySetLinkName (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_NAME, text]);
}

mySetLinkDesc (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_DESC, text]);
}

mySetLinkText (integer link, string text, vector color) {
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXT, text, color, 1.0]);
}

mySetLinkColor (integer link, vector color, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_COLOR, face, color, 1.0]);
}

mySetLinkBright (integer link, integer bright, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_FULLBRIGHT, face, bright]);
}

mySetLinkGlow (integer link, float glow, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_GLOW, face, glow]);
}

// Les 3 suivants ne marchent pas pour ALL_SIDES

mySetLinkTexture (integer link, key texture, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [texture], INDEX_TEXTURE, INDEX_TEXTURE);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkRepeat (integer link, vector repeat, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [repeat], INDEX_REPEATS, INDEX_REPEATS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkOffset (integer link, vector offset, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [offset], INDEX_OFFSETS, INDEX_OFFSETS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkPos (integer link, vector pos) {
llSetLinkPrimitiveParamsFast (link, [PRIM_POS_LOCAL, pos]);
}

mySetLinkRot (integer link, rotation rot) {
llSetLinkPrimitiveParamsFast (link, [PRIM_ROT_LOCAL, rot]);
}

mySetLinkSize (integer link, vector size) {
llSetLinkPrimitiveParamsFast (link, [PRIM_SIZE, size]);
}

mySetLinkCut (integer link, vector cut) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [cut], INDEX_CUT, INDEX_CUT);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTwist (integer link, vector twist) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [twist], INDEX_TWIST, INDEX_TWIST);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTaper (integer link, vector taper) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [taper], INDEX_TAPER, INDEX_TAPER);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkShear (integer link, vector shear) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [shear], INDEX_SHEAR, INDEX_SHEAR);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkHollow (integer link, float hollow) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [hollow], INDEX_HOLLOW, INDEX_HOLLOW);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

//
// Get accessors
//

string myGetLinkName (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_NAME]);
return llList2String (l,0);
}

string myGetLinkDesc (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_DESC]);
return llList2String (l,0);
}

string myGetLinkText (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXT]);
return llList2String (l,0);
}

vector myGetLinkColor (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_COLOR, face]);
return llList2Vector (l,0);
}

integer myGetLinkBright (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_FULLBRIGHT, face]);
return llList2Integer (l,0);
}

float myGetLinkGlow (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_GLOW, face]);
return llList2Float (l,0);
}

key myGetLinkTexture (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Key(l,0);
}

vector myGetLinkRepeat (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,1);
}

vector myGetLinkOffset (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,2);
}

vector myGetLinkPos (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_POS_LOCAL]);
return llList2Vector (l,0);
}

vector myGetLinkSize (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_SIZE]);
return llList2Vector (l,0);
}

vector myGetLinkCut (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_CUT);
}

vector myGetLinkTwist (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TWIST);
}

vector myGetLinkTaper (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TAPER);
}

vector myGetLinkShear (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_SHEAR);
}

float myGetLinkHollow (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Float (l, INDEX_HOLLOW);
}
</source>

[[Category:Scripting]]

Accessing Prim Properties

2024-03-02T18:22:09Z

JeffKelley: Fixed script

==A bit of history==

First, there was llSetColor.

Then, there was llSetLinkColor. That was a huge step forward, since it was releaving you from the burden to script each and every prim in your hair. Don't laugh. You may still find such blatantly outdated scripts on the Hypergrid. Do us a favor. Don't propagate them. Trash them. Rewrite them.

Later, it was recognized that the ability to access every property of a prim in a linkset from a master script was a Good Thing. It makes your application simpler to understand and to maintain, and helps reduce script count. llSetLinkPrimitiveParams was born.

Finally, OpenSimulator added it's own touch. Why not manipulate prims ''outside'' the linkset from a master script ? And we had osSetPrimitiveParams.

llGet/SetLinkPrimitiveParams, osGet/SetPrimitiveParams are the workhorse of prim manipulations. You can access every existing property of a prim from a centralized location. Streamlined, faster code. No more need for chat, or LinkedMessages between prims.

A special note about llGetObjectLinkKey : Introduced September, 2022, this function is the glue you need to access prims outside the linkset. Once you get the id of an external object (maybe using llSensor), you may call llGetObjectPrimCount (also consider osGetPrimCount which does not count sitting avatars) then iterate on llGetObjectLinkKey to get the id of each prim in the remote object. Finally, apply osGet/SetPrimitiveParams.

The following tables tries to sort out the functions available to manipulate prims, for each addressing method.

{| class="wikitable" style="margin:auto;text-align:center"
|-
! Target is script's host (prim containing the script)
! Target is link number (inside the linkset)
! Target is prim id (any prim you own in the scene)
|-
| llGetOwner || ||
|-
| llGetKey || llGetLinkKey(num) ||
|-
| llSetText || ||
|-
| llGetRot / llSetRot || ||
|-
| llGetScale / llSetScale || ||
|-
| llGetAlpha / llSetAlpha || llSetLinkAlpha(num) ||
|-
| llGetColor / llSetColor || llSetLinkColor(num) ||
|-
| llGetPos / llSetPos || ||
|-
| llGetObjectName / llSetObjectName || llGetLinkName(num) ||
|-(num)
| llGetObjectDesc / llSetObjectDesc || ||
|-
| llGetNumberOfSides || llGetLinkNumberOfSides(num) ||
|-
| llGetTexture / llSetTexture || llSetLinkTexture(num) ||
|-
| llSetTextureAnim || llSetLinkTextureAnim(num) ||
|-
| llParticleSystem || llLinkParticleSystem(num) ||
|-
| llSetPrimMediaParams || llSetLinkMedia(num) ||
|-
| || || llGetObjectPrimCount(uuid)
|-
| || || llGetObjectDetails(uuid)
|-
| || || llGetObjectLinkKey(uuid,num)
|-
!colspan="3" | "Universal" access (list of rules)

|-
| llGet/SetPrimitiveParams || llGet/SetLinkPrimitiveParams(num) || osGet/SetPrimitiveParams(uuid)
|}
 

==Example : A replicator==
Put this script in a box, along with a single-prim object named "seed". It will iterate on each prim of a named object you own in the scene, then rez an identical prim at a given offset, perfectly replicating the source object, even meshes. Sleeps are here for demo. Remove them for speedy replication. CLEANUP option will get rid of rezed prims.
<source lang="lsl">
string targetName = "Example"; // The name of an object you own in the scene
string seedName = "seed"; // Name of the seed prim
vector offset = <5,0,0>; // Offset of the dupicata

integer primcnt;
integer primnum;
key rootKey;

integer TupleLength (integer param)
{
if (param == PRIM_GLOW) return 1;
if (param == PRIM_COLOR) return 2;
if (param == PRIM_TEXGEN) return 1;
if (param == PRIM_TEXTURE) return 4;
if (param == PRIM_NORMAL) return 4;
if (param == PRIM_SPECULAR) return 7;
if (param == PRIM_BUMP_SHINY) return 2;
if (param == PRIM_FULLBRIGHT) return 1;

return 0; // Not a by-side parameter
}

list IterateFaces (list p, integer param)
{
integer tuplelength = TupleLength (param);
integer numsides = llGetListLength(p) / tuplelength;

// Une seule face, retourner [ param, ALL_SIDES, p ]
if (numsides == 1) return [ param, ALL_SIDES ] + p;

list result = [ ];
for (integer s=0; s<numsides; s++) {
list tuple = llList2List (p, s*tuplelength, (s+1)*tuplelength-1);
result += [ param, s ] + tuple;
}
return result;
}

CopyParams (key srcprim, key dstprim, integer param) {
if (TupleLength(param) == 0)
{
list p = osGetPrimitiveParams (srcprim, [ param ]);
if (param == PRIM_POSITION) p = [ llList2Vector (p,0) + offset ];
osSetPrimitiveParams (dstprim, [ param ] + p);
}
else
{
list p = osGetPrimitiveParams (srcprim, [ param, ALL_SIDES ]);
p = IterateFaces (p, param);
osSetPrimitiveParams (dstprim, p);
}
llSleep (0.1);
}

RezAPrim ()
{
if (++primnum > primcnt) llResetScript();
llRezObject (seedName, llGetPos()+<0,0,1>, ZERO_VECTOR, ZERO_ROTATION, 0);
}

PrimRezed (key dstkey)
{
llOwnerSay ("Processing link "+(string)primnum+" of "+(string)primcnt);
key srckey = llGetObjectLinkKey (rootKey, primnum);
llSleep (0.1);

CopyParams (srckey, dstkey, PRIM_POSITION);
CopyParams (srckey, dstkey, PRIM_ROTATION);
CopyParams (srckey, dstkey, PRIM_TYPE);
CopyParams (srckey, dstkey, PRIM_SIZE);
CopyParams (srckey, dstkey, PRIM_COLOR);
CopyParams (srckey, dstkey, PRIM_TEXTURE);
CopyParams (srckey, dstkey, PRIM_NORMAL);
CopyParams (srckey, dstkey, PRIM_SPECULAR);
CopyParams (srckey, dstkey, PRIM_TEXGEN);
CopyParams (srckey, dstkey, PRIM_BUMP_SHINY);
CopyParams (srckey, dstkey, PRIM_FULLBRIGHT);
CopyParams (srckey, dstkey, PRIM_PHYSICS_SHAPE_TYPE);

RezAPrim ();
}

key OwnerOf (key id)
{
list l = llGetObjectDetails (id, [ OBJECT_OWNER ]);
return llList2Key (l, 0);
}

default
{
state_entry()
{
llSetText ("READY", <0,1,0>, 1.0);
}

touch_start (integer n)
{
state dialog;
}
}

integer dlgchan = 99;
integer dlglistener;
state dialog
{
state_entry()
{
llSetText ("LISTENING", <0,1,0>, 1.0);
llDialog (llGetOwner(), "Action?", ["CLEANUP", "REPLICATE"], dlgchan);
dlglistener = llListen (dlgchan, "", llGetOwner(), "");
llSetTimerEvent (10);
}

listen (integer chan, string name, key id, string msg)
{
if (msg == "CLEANUP") state cleanup;
if (msg == "REPLICATE") state replicate;
}

timer ()
{
state default;
}

state_exit ()
{
llSetTimerEvent (0.0);
llListenRemove (dlglistener);
}
}

state cleanup
{
state_entry()
{
llSetText ("CLEANUP", <0,1,0>, 1.0);
llSensor (seedName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
llOwnerSay ("Garbage collecting "+(string)num);
for (integer i=0; i<num; i++) osDie (llDetectedKey(i));
state default;
}

no_sensor() {
llOwnerSay ("All clean.");
state default;
}
}

state replicate
{
state_entry()
{
llSetText ("REPLICATE", <0,1,0>, 1.0);
llSensor (targetName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
rootKey = llDetectedKey (0);

if (OwnerOf(rootKey) != llGetOwner())
{
llOwnerSay ("I don't own "+targetName+". Aborting.");
state default;
}

primcnt = llGetObjectPrimCount (rootKey);
primnum = 0; RezAPrim ();
}

no_sensor() {
llOwnerSay ("Object "+targetName+" was not found.");
}

object_rez (key uuid) {
PrimRezed (uuid);
}
}
</source>

==Writing accessors==

The Get/SetPrimitiveParams family of functions is awesomely powerful. It is also [https://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast quite arcane to write and decipher]. A way to get rid of these long lists of parameters cluttering your code is to encapsulate Get/SetPrimitiveParams in individual get/set accessors, actually 'filling the blanks' in the above table. Although this is much pleasant to read, note that doing so may hurt performance when you want to change many properties at once, which SetPrimitiveParams can do in one call. The following library is offered as an example.

<source lang="lsl">
// Index of properties for PRIM_TYPE_BOX, PRIM_TYPE_CYLINDER, PRIM_TYPE_PRISM

integer INDEX_TYPE = 0;
integer INDEX_HOLE = 1;
integer INDEX_CUT = 2;
integer INDEX_HOLLOW = 3;
integer INDEX_TWIST = 4;
integer INDEX_TAPER = 5;
integer INDEX_SHEAR = 6;

// Index of properties for PRIM_TEXTURE

integer INDEX_TEXTURE = 0;
integer INDEX_REPEATS = 1;
integer INDEX_OFFSETS = 2;
integer INDEX_ROTATION = 3;

// client script
// +---------------+------------+
// Taper | -1.0 0 +1.0 | 2.0 0.0 |
// Shear | -0.5 0 +0.5 | -0.5 +0.5 |
// Twist | -180 0 +180 | -1.0 +1.0 |
// +---------------+------------+

//
// Set accessors
//

mySetLinkName (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_NAME, text]);
}

mySetLinkDesc (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_DESC, text]);
}

mySetLinkText (integer link, string text, vector color) {
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXT, text, color, 1.0]);
}

mySetLinkColor (integer link, vector color, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_COLOR, face, color, 1.0]);
}

mySetLinkBright (integer link, integer bright, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_FULLBRIGHT, face, bright]);
}

mySetLinkGlow (integer link, float glow, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_GLOW, face, glow]);
}

// Les 3 suivants ne marchent pas pour ALL_SIDES

mySetLinkTexture (integer link, key texture, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [texture], INDEX_TEXTURE, INDEX_TEXTURE);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkRepeat (integer link, vector repeat, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [repeat], INDEX_REPEATS, INDEX_REPEATS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkOffset (integer link, vector offset, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [offset], INDEX_OFFSETS, INDEX_OFFSETS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkPos (integer link, vector pos) {
llSetLinkPrimitiveParamsFast (link, [PRIM_POS_LOCAL, pos]);
}

mySetLinkRot (integer link, rotation rot) {
llSetLinkPrimitiveParamsFast (link, [PRIM_ROT_LOCAL, rot]);
}

mySetLinkSize (integer link, vector size) {
llSetLinkPrimitiveParamsFast (link, [PRIM_SIZE, size]);
}

mySetLinkCut (integer link, vector cut) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [cut], INDEX_CUT, INDEX_CUT);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTwist (integer link, vector twist) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [twist], INDEX_TWIST, INDEX_TWIST);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTaper (integer link, vector taper) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [taper], INDEX_TAPER, INDEX_TAPER);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkShear (integer link, vector shear) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [shear], INDEX_SHEAR, INDEX_SHEAR);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkHollow (integer link, float hollow) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [hollow], INDEX_HOLLOW, INDEX_HOLLOW);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

//
// Get accessors
//

string myGetLinkName (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_NAME]);
return llList2String (l,0);
}

string myGetLinkDesc (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_DESC]);
return llList2String (l,0);
}

string myGetLinkText (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXT]);
return llList2String (l,0);
}

vector myGetLinkColor (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_COLOR, face]);
return llList2Vector (l,0);
}

integer myGetLinkBright (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_FULLBRIGHT, face]);
return llList2Integer (l,0);
}

float myGetLinkGlow (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_GLOW, face]);
return llList2Float (l,0);
}

key myGetLinkTexture (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Key(l,0);
}

vector myGetLinkRepeat (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,1);
}

vector myGetLinkOffset (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,2);
}

vector myGetLinkPos (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_POS_LOCAL]);
return llList2Vector (l,0);
}

vector myGetLinkSize (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_SIZE]);
return llList2Vector (l,0);
}

vector myGetLinkCut (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_CUT);
}

vector myGetLinkTwist (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TWIST);
}

vector myGetLinkTaper (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TAPER);
}

vector myGetLinkShear (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_SHEAR);
}

float myGetLinkHollow (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Float (l, INDEX_HOLLOW);
}
</source>

Accessing Prim Properties

2024-03-01T20:02:50Z

JeffKelley: Example added

==A bit of history==

First, there was llSetColor.

Then, there was llSetLinkColor. That was a huge step forward, since it was releaving you from the burden to script each and every prim in your hair. Don't laugh. You may still find such blatantly outdated scripts on the Hypergrid. Do us a favor. Don't propagate them. Trash them. Rewrite them.

Later, it was recognized that the ability to access every property of a prim in a linkset from a master script was a Good Thing. It makes your application simpler to understand and to maintain, and helps reduce script count. llSetLinkPrimitiveParams was born.

Finally, OpenSimulator added it's own touch. Why not manipulate prims ''outside'' the linkset from a master script ? And we had osSetPrimitiveParams.

llGet/SetLinkPrimitiveParams, osGet/SetPrimitiveParams are the workhorse of prim manipulations. You can access every existing property of a prim from a centralized location. Streamlined, faster code. No more need for chat, or LinkedMessages between prims.

A special note about llGetObjectLinkKey : Introduced September, 2022, this function is the glue you need to access prims outside the linkset. Once you get the id of an external object (maybe using llSensor), you may call llGetObjectPrimCount (also consider osGetPrimCount which does not count sitting avatars) then iterate on llGetObjectLinkKey to get the id of each prim in the remote object. Finally, apply osGet/SetPrimitiveParams.

The following tables tries to sort out the functions available to manipulate prims, for each addressing method.

{| class="wikitable" style="margin:auto;text-align:center"
|-
! Target is script's host (prim containing the script)
! Target is link number (inside the linkset)
! Target is prim id (any prim you own in the scene)
|-
| llGetOwner || ||
|-
| llGetKey || llGetLinkKey(num) ||
|-
| llSetText || ||
|-
| llGetRot / llSetRot || ||
|-
| llGetScale / llSetScale || ||
|-
| llGetAlpha / llSetAlpha || llSetLinkAlpha(num) ||
|-
| llGetColor / llSetColor || llSetLinkColor(num) ||
|-
| llGetPos / llSetPos || ||
|-
| llGetObjectName / llSetObjectName || llGetLinkName(num) ||
|-(num)
| llGetObjectDesc / llSetObjectDesc || ||
|-
| llGetNumberOfSides || llGetLinkNumberOfSides(num) ||
|-
| llGetTexture / llSetTexture || llSetLinkTexture(num) ||
|-
| llSetTextureAnim || llSetLinkTextureAnim(num) ||
|-
| llParticleSystem || llLinkParticleSystem(num) ||
|-
| llSetPrimMediaParams || llSetLinkMedia(num) ||
|-
| || || llGetObjectPrimCount(uuid)
|-
| || || llGetObjectDetails(uuid)
|-
| || || llGetObjectLinkKey(uuid,num)
|-
!colspan="3" | "Universal" access (list of rules)

|-
| llGet/SetPrimitiveParams || llGet/SetLinkPrimitiveParams(num) || osGet/SetPrimitiveParams(uuid)
|}
 

==Example : A replicator==
Put this script in a box, along with a single-prim object named "seed". It will iterate on each prim of a named object you own in the scene, then rez an identical prim at a given offset, perfectly replicating the source object, even meshes. Sleeps are here for demo. Remove them for speedy replication. CLEANUP option will get rid of rezed prims.
<source lang="lsl">
string targetName = "Example"; // The name of an object you own in the scene
string seedName = "seed"; // Name of the seed prim
vector offset = <0,0,1>; // Offset of the dupicata

integer primcnt;
integer primnum;
key rootKey;

integer TupleLength (integer param)
{
if (param == PRIM_GLOW) return 1;
if (param == PRIM_COLOR) return 2;
if (param == PRIM_TEXGEN) return 1;
if (param == PRIM_TEXTURE) return 4;
if (param == PRIM_NORMAL) return 4;
if (param == PRIM_SPECULAR) return 7;
if (param == PRIM_BUMP_SHINY) return 2;
if (param == PRIM_FULLBRIGHT) return 1;

return 0; // Not a by-side parameter
}

list IterateFaces (list p, integer param)
{
integer tuplelength = TupleLength (param);
integer numsides = llGetListLength(p) / tuplelength;

// Une seule face, retourner [ param, ALL_SIDES, p ]
if (numsides == 1) return [ param, ALL_SIDES ] + p;

list result = [ ];
for (integer s=0; s<numsides; s++) {
list tuple = llList2List (p, s*tuplelength, (s+1)*tuplelength-1);
result += [ param, s ] + tuple;
}
return result;
}

CopyParams (key srcprim, key dstprim, integer param) {
if (TupleLength(param) == 0)
{
list p = osGetPrimitiveParams (srcprim, [ param ]);
if (param == PRIM_POSITION) p = [ llList2Vector (p,0) + <5,0,0> ];
osSetPrimitiveParams (dstprim, [ param ] + p);
}
else
{
list p = osGetPrimitiveParams (srcprim, [ param, ALL_SIDES ]);
p = IterateFaces (p, param);
osSetPrimitiveParams (dstprim, p);
}
llSleep (0.1);
}

RezAPrim ()
{
if (++primnum > primcnt) llResetScript();
llRezObject (seedName, llGetPos()+offset, ZERO_VECTOR, ZERO_ROTATION, 0);
}

PrimRezed (key dstkey)
{
llOwnerSay ("Processing link "+(string)primnum+" of "+(string)primcnt);
key srckey = llGetObjectLinkKey (rootKey, primnum);
llSleep (0.1);

CopyParams (srckey, dstkey, PRIM_POSITION);
CopyParams (srckey, dstkey, PRIM_ROTATION);
CopyParams (srckey, dstkey, PRIM_TYPE);
CopyParams (srckey, dstkey, PRIM_SIZE);
CopyParams (srckey, dstkey, PRIM_COLOR);
CopyParams (srckey, dstkey, PRIM_TEXTURE);
CopyParams (srckey, dstkey, PRIM_NORMAL);
CopyParams (srckey, dstkey, PRIM_SPECULAR);
CopyParams (srckey, dstkey, PRIM_TEXGEN);
CopyParams (srckey, dstkey, PRIM_BUMP_SHINY);
CopyParams (srckey, dstkey, PRIM_FULLBRIGHT);
CopyParams (srckey, dstkey, PRIM_PHYSICS_SHAPE_TYPE);

RezAPrim ();
}

key OwnerOf (key id)
{
list l = llGetObjectDetails (id, [ OBJECT_OWNER ]);
return llList2Key (l, 0);
}

default
{
state_entry()
{
llSetText ("READY", <0,1,0>, 1.0);
}

touch_start (integer n)
{
state dialog;
}
}

integer dlgchan = 99;
integer dlglistener;
state dialog
{
state_entry()
{
llSetText ("LISTENING", <0,1,0>, 1.0);
llDialog (llGetOwner(), "Action?", ["CLEANUP", "REPLICATE"], dlgchan);
dlglistener = llListen (dlgchan, "", llGetOwner(), "");
llSetTimerEvent (10);
}

listen (integer chan, string name, key id, string msg)
{
if (msg == "CLEANUP") state cleanup;
if (msg == "REPLICATE") state replicate;
}

timer ()
{
state default;
}

state_exit ()
{
llSetTimerEvent (0.0);
llListenRemove (dlglistener);
}
}

state cleanup
{
state_entry()
{
llSetText ("CLEANUP", <0,1,0>, 1.0);
llSensor (seedName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
llOwnerSay ("Garbage collecting "+(string)num);
for (integer i=0; i<num; i++) osDie (llDetectedKey(i));
state default;
}

no_sensor() {
llOwnerSay ("All clean.");
state default;
}
}

state replicate
{
state_entry()
{
llSetText ("REPLICATE", <0,1,0>, 1.0);
llSensor (targetName, NULL_KEY, PASSIVE|SCRIPTED, 100, PI);
}

sensor (integer num) {
rootKey = llDetectedKey (0);

if (OwnerOf(rootKey) != llGetOwner())
{
llOwnerSay ("I don't own "+targetName+". Aborting.");
state default;
}

primcnt = llGetObjectPrimCount (rootKey);
primnum = 0; RezAPrim ();
}

no_sensor() {
llOwnerSay ("Object "+targetName+" was not found.");
}

object_rez (key uuid) {
PrimRezed (uuid);
}
}
</source>

==Writing accessors==

The Get/SetPrimitiveParams family of functions is awesomely powerful. It is also [https://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast quite arcane to write and decipher]. A way to get rid of these long lists of parameters cluttering your code is to encapsulate Get/SetPrimitiveParams in individual get/set accessors, actually 'filling the blanks' in the above table. Although this is much pleasant to read, note that doing so may hurt performance when you want to change many properties at once, which SetPrimitiveParams can do in one call. The following library is offered as an example.

<source lang="lsl">
// Index of properties for PRIM_TYPE_BOX, PRIM_TYPE_CYLINDER, PRIM_TYPE_PRISM

integer INDEX_TYPE = 0;
integer INDEX_HOLE = 1;
integer INDEX_CUT = 2;
integer INDEX_HOLLOW = 3;
integer INDEX_TWIST = 4;
integer INDEX_TAPER = 5;
integer INDEX_SHEAR = 6;

// Index of properties for PRIM_TEXTURE

integer INDEX_TEXTURE = 0;
integer INDEX_REPEATS = 1;
integer INDEX_OFFSETS = 2;
integer INDEX_ROTATION = 3;

// client script
// +---------------+------------+
// Taper | -1.0 0 +1.0 | 2.0 0.0 |
// Shear | -0.5 0 +0.5 | -0.5 +0.5 |
// Twist | -180 0 +180 | -1.0 +1.0 |
// +---------------+------------+

//
// Set accessors
//

mySetLinkName (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_NAME, text]);
}

mySetLinkDesc (integer link, string text) {
llSetLinkPrimitiveParamsFast (link, [PRIM_DESC, text]);
}

mySetLinkText (integer link, string text, vector color) {
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXT, text, color, 1.0]);
}

mySetLinkColor (integer link, vector color, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_COLOR, face, color, 1.0]);
}

mySetLinkBright (integer link, integer bright, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_FULLBRIGHT, face, bright]);
}

mySetLinkGlow (integer link, float glow, integer face) {
llSetLinkPrimitiveParamsFast (link, [PRIM_GLOW, face, glow]);
}

// Les 3 suivants ne marchent pas pour ALL_SIDES

mySetLinkTexture (integer link, key texture, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [texture], INDEX_TEXTURE, INDEX_TEXTURE);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkRepeat (integer link, vector repeat, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [repeat], INDEX_REPEATS, INDEX_REPEATS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkOffset (integer link, vector offset, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
l = llListReplaceList(l, [offset], INDEX_OFFSETS, INDEX_OFFSETS);
llSetLinkPrimitiveParamsFast (link, [PRIM_TEXTURE, face] + l);
}

mySetLinkPos (integer link, vector pos) {
llSetLinkPrimitiveParamsFast (link, [PRIM_POS_LOCAL, pos]);
}

mySetLinkRot (integer link, rotation rot) {
llSetLinkPrimitiveParamsFast (link, [PRIM_ROT_LOCAL, rot]);
}

mySetLinkSize (integer link, vector size) {
llSetLinkPrimitiveParamsFast (link, [PRIM_SIZE, size]);
}

mySetLinkCut (integer link, vector cut) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [cut], INDEX_CUT, INDEX_CUT);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTwist (integer link, vector twist) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [twist], INDEX_TWIST, INDEX_TWIST);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkTaper (integer link, vector taper) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [taper], INDEX_TAPER, INDEX_TAPER);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkShear (integer link, vector shear) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [shear], INDEX_SHEAR, INDEX_SHEAR);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

mySetLinkHollow (integer link, float hollow) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
l = llListReplaceList(l, [hollow], INDEX_HOLLOW, INDEX_HOLLOW);
llSetLinkPrimitiveParamsFast (link, [PRIM_TYPE] + l);
}

//
// Get accessors
//

string myGetLinkName (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_NAME]);
return llList2String (l,0);
}

string myGetLinkDesc (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_DESC]);
return llList2String (l,0);
}

string myGetLinkText (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXT]);
return llList2String (l,0);
}

vector myGetLinkColor (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_COLOR, face]);
return llList2Vector (l,0);
}

integer myGetLinkBright (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_FULLBRIGHT, face]);
return llList2Integer (l,0);
}

float myGetLinkGlow (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_GLOW, face]);
return llList2Float (l,0);
}

key myGetLinkTexture (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Key(l,0);
}

vector myGetLinkRepeat (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,1);
}

vector myGetLinkOffset (integer link, integer face) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TEXTURE, face]);
return llList2Vector(l,2);
}

vector myGetLinkPos (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_POS_LOCAL]);
return llList2Vector (l,0);
}

vector myGetLinkSize (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_SIZE]);
return llList2Vector (l,0);
}

vector myGetLinkCut (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_CUT);
}

vector myGetLinkTwist (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TWIST);
}

vector myGetLinkTaper (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_TAPER);
}

vector myGetLinkShear (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Vector (l, INDEX_SHEAR);
}

float myGetLinkHollow (integer link) {
list l = llGetLinkPrimitiveParams (link, [PRIM_TYPE]);
return llList2Float (l, INDEX_HOLLOW);
}
</source>

OsGetSitTargetPos

2024-03-01T10:35:32Z

JeffKelley: Non-english word

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=vector osGetSitTargetPos() 
|ossl_example=<source lang="lsl">
// Unit test : Writing then reading SitTarget

default
{
state_entry()
{
vector write_pos = <1,2,3>;
vector write_rot = <4,5,6>;

llSitTarget (write_pos, llEuler2Rot(write_rot * DEG_TO_RAD));

vector read_pos = osGetSitTargetPos();
vector read_rot = llRot2Euler (osGetSitTargetRot()) * RAD_TO_DEG;

llOwnerSay (read_pos);
llOwnerSay (read_rot);
}
}

[12:45] Object: <1.000000, 2.000000, 3.000000>
[12:45] Object: <4.000000, 5.000000, 6.000000>
</source>
<source lang="lsl">
// Sit Adjuster, Jeff Kelley, 2024
//
// This script allows interactive adjustment of the sit position.
// Put the script in a seat, then sit. Mode (POSITION or ROTATION),
// avatar position and avatar rotation are displayed in green.
// Adjust the position using the arrow keys + PageUp/PageDown.
// Once satisfied, click on the seat to enter ROTATION mode
// and adjust the rotation. Toggle between POSITION and ROTATION
// as many times as necessary. Finally, standup. The new sittarget
// is now written, and the script deletes itself.
//
// PLEASE NOTE - It is strongly advised to disable the setting :
// Preferences > Move&View > Reset camera position on avatar movement
// so the camera won't jump when you hit the arrow keys.

////////////////////
// Avatar ajustement
////////////////////

integer MODE;
integer MODE_POS = 0;
integer MODE_ROT = 1;

float increment = 0.005; // The smaller, the slower
vector DELTA_X = < 1, 0, 0 > * increment;
vector DELTA_Y = < 0, 1, 0 > * increment;
vector DELTA_Z = < 0, 0, 1 > * increment;

vector AvatarPos; // Memorize last position
rotation AvatarRot; // Memorize last rotation

vector GetAvatarPos()
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
list l = llGetLinkPrimitiveParams (nprims, [PRIM_POS_LOCAL]);
AvatarPos = llList2Vector (l,0);
return AvatarPos;
}

rotation GetAvatarRot()
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
list l = llGetLinkPrimitiveParams (nprims, [PRIM_ROT_LOCAL]);
AvatarRot = llList2Rot (l,0);
return AvatarRot;
}

SetAvatarPos(vector pos)
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
llSetLinkPrimitiveParamsFast (nprims, [PRIM_POS_LOCAL, pos]);
}

SetAvatarRot(rotation rot)
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
llSetLinkPrimitiveParamsFast (nprims, [PRIM_ROT_LOCAL, rot]);
}

Move(vector deltapos, vector deltarot)
{
if (MODE == MODE_POS)
SetAvatarPos (GetAvatarPos() + deltapos);

if (MODE == MODE_ROT)
SetAvatarRot (GetAvatarRot() * llEuler2Rot(deltarot));

DisplayInfos();
}

///////////////////////////////
// Sit/Unsit, keyboard bindings
///////////////////////////////

integer KeysToBind = CONTROL_FWD | CONTROL_BACK | CONTROL_ROT_LEFT
| CONTROL_ROT_RIGHT | CONTROL_UP | CONTROL_DOWN;
vector drift;

Sit ()
{
key avatar = llGetPermissionsKey();
llTakeControls (KeysToBind, TRUE, FALSE);
MODE = MODE_POS;
DisplayUsage();
DisplayInfos();
drift = osGetSitTargetPos() - GetAvatarPos();
}

Unsit ()
{
key avatar = llGetPermissionsKey();
llSitTarget (AvatarPos+drift, AvatarRot);
llReleaseControls ();
DisplayClear();

llRemoveInventory (llGetScriptName());
}

//////////
// Display
//////////

DisplayClear()
{
llSetText ("", <0,1,0>, 1.0);
}

DisplayInfos()
{
string text;
vector color;
GetAvatarPos();
GetAvatarRot();

if (MODE == MODE_POS)
{
text = "MODE POSITION";
color = <0,1,0>;
}

if (MODE == MODE_ROT)
{
text = "MODE ROTATION";
color = <1,1,0>;
}

text += "\n" + (string) AvatarPos;
text += "\n" + (string) (llRot2Euler(AvatarRot)*RAD_TO_DEG);
llSetText (text, color, 1.0);
}

DisplayUsage()
{
llWhisper (0, "Use arrow keys + PageUP/PageDown");
llWhisper (0, "to adjust avatar position in X, Y and Z");
llWhisper (0, "Click the seat to toggle between position ane rotation");
llWhisper (0, "Standup to record the parameters in your seat");
}

/////////////////
// Event handlers
/////////////////

default
{
state_entry()
{
// If the seat has a previous sittarget, use it as a starting point.
// Else, define a random sittarget for llAvatarOnSitTarget to work.
vector sitPos = osGetSitTargetPos();
rotation sitRot = osGetSitTargetRot();

if (sitPos == ZERO_VECTOR)
{
sitPos = <0,0,1.0>;
sitRot = ZERO_ROTATION;
}

llSitTarget (sitPos, sitRot);
DisplayClear();
}

changed(integer change)
{
if (change & CHANGED_LINK)
{
key whosit = llAvatarOnSitTarget();
if (whosit == NULL_KEY) Unsit ();
else llRequestPermissions (whosit, PERMISSION_TAKE_CONTROLS);
}
}

run_time_permissions(integer perms)
{
if (perms == PERMISSION_TAKE_CONTROLS) Sit();
}

touch_start (integer n)
{
MODE = ! MODE;
DisplayInfos();
}

control (key id, integer level, integer edge)
{
integer start = level & edge;
integer end = ~level & edge;

if (level & CONTROL_FWD) { Move( DELTA_X, DELTA_Y); } // Up arrow
if (level & CONTROL_BACK) { Move(-DELTA_X, -DELTA_Y); } // Down arrow
if (level & CONTROL_ROT_LEFT) { Move( DELTA_Y, DELTA_Z); } // Left arrow
if (level & CONTROL_ROT_RIGHT) { Move(-DELTA_Y, -DELTA_Z); } // Right arrow
if (level & CONTROL_UP) { Move( DELTA_Z, DELTA_X); } // Page up
if (level & CONTROL_DOWN) { Move(-DELTA_Z, -DELTA_X); } // Page down
}
}
</source>
|description=
Return the sit target location as set by llSitTarget.
|additional_info=This function was added in 0.9.3.0
}}

OsGetSitTargetPos

2024-03-01T10:31:00Z

JeffKelley: grammar

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=vector osGetSitTargetPos() 
|ossl_example=<source lang="lsl">
// Unit test : Writing then reading SitTarget

default
{
state_entry()
{
vector write_pos = <1,2,3>;
vector write_rot = <4,5,6>;

llSitTarget (write_pos, llEuler2Rot(write_rot * DEG_TO_RAD));

vector read_pos = osGetSitTargetPos();
vector read_rot = llRot2Euler (osGetSitTargetRot()) * RAD_TO_DEG;

llOwnerSay (read_pos);
llOwnerSay (read_rot);
}
}

[12:45] Object: <1.000000, 2.000000, 3.000000>
[12:45] Object: <4.000000, 5.000000, 6.000000>
</source>
<source lang="lsl">
// Sit Adjuster, Jeff Kelley, 2024
//
// This script allows interactive adjustment of the sit position.
// Put the script in a seat, then sit. Mode (POSITION or ROTATION),
// avatar position and avatar rotation are displayed in green.
// Adjust the position using the arrow keys + PageUp/PageDown.
// Once satisfied, click on the seat to enter ROTATION mode
// and adjust the rotation. Toggle between POSITION and ROTATION
// as many times as necessary. Finally, standup. The new sittarget
// is now written, and the script deletes itself.
//
// PLEASE NOTE - It is strongly advised to disable the setting :
// Preferences > Move&View > Reset camera position on avatar movement
// so the camera won't jump when you hit the arrow keys.

////////////////////
// Avatar ajustement
////////////////////

integer MODE;
integer MODE_POS = 0;
integer MODE_ROT = 1;

float increment = 0.005; // The smaller, the slower
vector DELTA_X = < 1, 0, 0 > * increment;
vector DELTA_Y = < 0, 1, 0 > * increment;
vector DELTA_Z = < 0, 0, 1 > * increment;

vector AvatarPos; // Memorize last position
rotation AvatarRot; // Memorize last rotation

vector GetAvatarPos()
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
list l = llGetLinkPrimitiveParams (nprims, [PRIM_POS_LOCAL]);
AvatarPos = llList2Vector (l,0);
return AvatarPos;
}

rotation GetAvatarRot()
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
list l = llGetLinkPrimitiveParams (nprims, [PRIM_ROT_LOCAL]);
AvatarRot = llList2Rot (l,0);
return AvatarRot;
}

SetAvatarPos(vector pos)
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
llSetLinkPrimitiveParamsFast (nprims, [PRIM_POS_LOCAL, pos]);
}

SetAvatarRot(rotation rot)
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
llSetLinkPrimitiveParamsFast (nprims, [PRIM_ROT_LOCAL, rot]);
}

Move(vector deltapos, vector deltarot)
{
if (MODE == MODE_POS)
SetAvatarPos (GetAvatarPos() + deltapos);

if (MODE == MODE_ROT)
SetAvatarRot (GetAvatarRot() * llEuler2Rot(deltarot));

DisplayInfos();
}

///////////////////////////////
// Sit/Unsit, keyboard bindings
///////////////////////////////

integer KeysToBind = CONTROL_FWD | CONTROL_BACK | CONTROL_ROT_LEFT
| CONTROL_ROT_RIGHT | CONTROL_UP | CONTROL_DOWN;
vector drift;

Sit ()
{
key avatar = llGetPermissionsKey();
llTakeControls (KeysToBind, TRUE, FALSE);
MODE = MODE_POS;
DisplayUsage();
DisplayInfos();
drift = osGetSitTargetPos() - GetAvatarPos();
}

Unsit ()
{
key avatar = llGetPermissionsKey();
llSitTarget (AvatarPos+drift, AvatarRot);
llReleaseControls ();
DisplayClear();

llRemoveInventory (llGetScriptName());
}

//////////
// Display
//////////

DisplayClear()
{
llSetText ("", <0,1,0>, 1.0);
}

DisplayInfos()
{
string text;
vector color;
GetAvatarPos();
GetAvatarRot();

if (MODE == MODE_POS)
{
text = "MODE POSITION";
color = <0,1,0>;
}

if (MODE == MODE_ROT)
{
text = "MODE ROTATION";
color = <1,1,0>;
}

text += "\n" + (string) AvatarPos;
text += "\n" + (string) (llRot2Euler(AvatarRot)*RAD_TO_DEG);
llSetText (text, color, 1.0);
}

DisplayUsage()
{
llWhisper (0, "Use arrow keys + PageUP/PageDown");
llWhisper (0, "to adjust avatar position in X, Y et Z");
llWhisper (0, "Click the seat to toggle between position ane rotation");
llWhisper (0, "Standup to record the parameters in your seat");
}

/////////////////
// Event handlers
/////////////////

default
{
state_entry()
{
// If the seat has a previous sittarget, use it as a starting point.
// Else, define a random sittarget for llAvatarOnSitTarget to work.
vector sitPos = osGetSitTargetPos();
rotation sitRot = osGetSitTargetRot();

if (sitPos == ZERO_VECTOR)
{
sitPos = <0,0,1.0>;
sitRot = ZERO_ROTATION;
}

llSitTarget (sitPos, sitRot);
DisplayClear();
}

changed(integer change)
{
if (change & CHANGED_LINK)
{
key whosit = llAvatarOnSitTarget();
if (whosit == NULL_KEY) Unsit ();
else llRequestPermissions (whosit, PERMISSION_TAKE_CONTROLS);
}
}

run_time_permissions(integer perms)
{
if (perms == PERMISSION_TAKE_CONTROLS) Sit();
}

touch_start (integer n)
{
MODE = ! MODE;
DisplayInfos();
}

control (key id, integer level, integer edge)
{
integer start = level & edge;
integer end = ~level & edge;

if (level & CONTROL_FWD) { Move( DELTA_X, DELTA_Y); } // Up arrow
if (level & CONTROL_BACK) { Move(-DELTA_X, -DELTA_Y); } // Down arrow
if (level & CONTROL_ROT_LEFT) { Move( DELTA_Y, DELTA_Z); } // Left arrow
if (level & CONTROL_ROT_RIGHT) { Move(-DELTA_Y, -DELTA_Z); } // Right arrow
if (level & CONTROL_UP) { Move( DELTA_Z, DELTA_X); } // Page up
if (level & CONTROL_DOWN) { Move(-DELTA_Z, -DELTA_X); } // Page down
}
}
</source>
|description=
Return the sit target location as set by llSitTarget.
|additional_info=This function was added in 0.9.3.0
}}

OsGetSitTargetPos

2024-03-01T10:25:24Z

JeffKelley: Example added

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=vector osGetSitTargetPos() 
|ossl_example=<source lang="lsl">
// Unit test : Writing then reading SitTarget

default
{
state_entry()
{
vector write_pos = <1,2,3>;
vector write_rot = <4,5,6>;

llSitTarget (write_pos, llEuler2Rot(write_rot * DEG_TO_RAD));

vector read_pos = osGetSitTargetPos();
vector read_rot = llRot2Euler (osGetSitTargetRot()) * RAD_TO_DEG;

llOwnerSay (read_pos);
llOwnerSay (read_rot);
}
}

[12:45] Object: <1.000000, 2.000000, 3.000000>
[12:45] Object: <4.000000, 5.000000, 6.000000>
</source>
<source lang="lsl">
// Sit Adjuster, Jeff Kelley, 2024
//
// This script allows interactive adjustment of the seat position.
// Put the script in a seat, then sit. Mode (POSITION or ROTATION),
// avatar position and avatar rotation are displayed in green.
// Adjust the position using the arrow keys + PageUp/PageDown.
// Once satisfied, click on the seat to enter ROTATION mode
// and adjust the rotation. Toggle between POSITION and ROTATION
// as many times as necessary. Finally, standup. The new sittarget
// is now written, and the script deletes itself.
//
// PLEASE NOTE - It is strongly advised to disable the setting :
// Preferences > Move&View > Reset camera position on avatar movement
// so the camera won't jump when you hit the arrow keys.

////////////////////
// Avatar ajustement
////////////////////

integer MODE;
integer MODE_POS = 0;
integer MODE_ROT = 1;

float increment = 0.005; // The smaller, the slower
vector DELTA_X = < 1, 0, 0 > * increment;
vector DELTA_Y = < 0, 1, 0 > * increment;
vector DELTA_Z = < 0, 0, 1 > * increment;

vector AvatarPos; // Memorize last position
rotation AvatarRot; // Memorize last rotation

vector GetAvatarPos()
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
list l = llGetLinkPrimitiveParams (nprims, [PRIM_POS_LOCAL]);
AvatarPos = llList2Vector (l,0);
return AvatarPos;
}

rotation GetAvatarRot()
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
list l = llGetLinkPrimitiveParams (nprims, [PRIM_ROT_LOCAL]);
AvatarRot = llList2Rot (l,0);
return AvatarRot;
}

SetAvatarPos(vector pos)
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
llSetLinkPrimitiveParamsFast (nprims, [PRIM_POS_LOCAL, pos]);
}

SetAvatarRot(rotation rot)
{
integer nprims = llGetNumberOfPrims(); // Last link = avatar
llSetLinkPrimitiveParamsFast (nprims, [PRIM_ROT_LOCAL, rot]);
}

Move(vector deltapos, vector deltarot)
{
if (MODE == MODE_POS)
SetAvatarPos (GetAvatarPos() + deltapos);

if (MODE == MODE_ROT)
SetAvatarRot (GetAvatarRot() * llEuler2Rot(deltarot));

DisplayInfos();
}

///////////////////////////////
// Sit/Unsit, keyboard bindings
///////////////////////////////

integer KeysToBind = CONTROL_FWD | CONTROL_BACK | CONTROL_ROT_LEFT
| CONTROL_ROT_RIGHT | CONTROL_UP | CONTROL_DOWN;
vector drift;

Sit ()
{
key avatar = llGetPermissionsKey();
llTakeControls (KeysToBind, TRUE, FALSE);
MODE = MODE_POS;
DisplayUsage();
DisplayInfos();
drift = osGetSitTargetPos() - GetAvatarPos();
}

Unsit ()
{
key avatar = llGetPermissionsKey();
llSitTarget (AvatarPos+drift, AvatarRot);
llReleaseControls ();
DisplayClear();

llRemoveInventory (llGetScriptName());
}

//////////
// Display
//////////

DisplayClear()
{
llSetText ("", <0,1,0>, 1.0);
}

DisplayInfos()
{
string text;
vector color;
GetAvatarPos();
GetAvatarRot();

if (MODE == MODE_POS)
{
text = "MODE POSITION";
color = <0,1,0>;
}

if (MODE == MODE_ROT)
{
text = "MODE ROTATION";
color = <1,1,0>;
}

text += "\n" + (string) AvatarPos;
text += "\n" + (string) (llRot2Euler(AvatarRot)*RAD_TO_DEG);
llSetText (text, color, 1.0);
}

DisplayUsage()
{
llWhisper (0, "Use arrow keys + PageUP/PageDown");
llWhisper (0, "to adjust avatar position in X, Y et Z");
llWhisper (0, "Click the seat to toggle between position ane rotation");
llWhisper (0, "Standup to record the parameters in your seat");
}

/////////////////
// Event handlers
/////////////////

default
{
state_entry()
{
// If the seat has a previous sittarget, use it as a starting point.
// Else, define a random sittarget for llAvatarOnSitTarget to work.
vector sitPos = osGetSitTargetPos();
rotation sitRot = osGetSitTargetRot();

if (sitPos == ZERO_VECTOR)
{
sitPos = <0,0,1.0>;
sitRot = ZERO_ROTATION;
}

llSitTarget (sitPos, sitRot);
DisplayClear();
}

changed(integer change)
{
if (change & CHANGED_LINK)
{
key whosit = llAvatarOnSitTarget();
if (whosit == NULL_KEY) Unsit ();
else llRequestPermissions (whosit, PERMISSION_TAKE_CONTROLS);
}
}

run_time_permissions(integer perms)
{
if (perms == PERMISSION_TAKE_CONTROLS) Sit();
}

touch_start (integer n)
{
MODE = ! MODE;
DisplayInfos();
}

control (key id, integer level, integer edge)
{
integer start = level & edge;
integer end = ~level & edge;

if (level & CONTROL_FWD) { Move( DELTA_X, DELTA_Y); } // Up arrow
if (level & CONTROL_BACK) { Move(-DELTA_X, -DELTA_Y); } // Down arrow
if (level & CONTROL_ROT_LEFT) { Move( DELTA_Y, DELTA_Z); } // Left arrow
if (level & CONTROL_ROT_RIGHT) { Move(-DELTA_Y, -DELTA_Z); } // Right arrow
if (level & CONTROL_UP) { Move( DELTA_Z, DELTA_X); } // Page up
if (level & CONTROL_DOWN) { Move(-DELTA_Z, -DELTA_X); } // Page down
}
}
</source>
|description=
Return the sit target location as set by llSitTarget.
|additional_info=This function was added in 0.9.3.0
}}

OsGetSitTargetPos

2024-03-01T08:29:55Z

JeffKelley:

OsGetSitTargetPos

2024-03-01T08:25:30Z

JeffKelley: Created page with "{{osslfunc |threat_level=ignored |permissions=true |delay=0|function_syntax=vector osGetSitTargetPos() |ossl_example=<source lang="lsl"> </source> |description= Return th..."

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=vector osGetSitTargetPos() 
|ossl_example=<source lang="lsl">

</source>
|description=
Return the sit target location as set by llSitTarget.
|additional_info=This function was added in 0.9.3.0
}}

OsGetSitTargetRot

2024-03-01T08:25:28Z

JeffKelley: Created page with "{{osslfunc |threat_level=ignored |permissions=true |delay=0|function_syntax=rotation osGetSitTargetRot() |ossl_example=See osGetSitTargetPos |description= Return the s..."

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=rotation osGetSitTargetRot() 
|ossl_example=See [[osGetSitTargetPos]]
|description=
Return the sit target rotation as set by llSitTarget.
|additional_info=This function was added in 0.9.3.0
}}

Category:OSSL Functions

2024-03-01T08:09:59Z

JeffKelley: /* Prim */ ososGetSitTarget*

{{Quicklinks}}
 
<div style="background-color:#FFA500; padding:10px; padding-bottom:5px; border: 1px #FF544F solid">
This information is relative to (almost) the last OpenSimulator Development version. In some cases it may not apply to older versions.
</div>

== OSSL function permissions ==
Several OSSL functions have execution permission control to prevent abusive or dangerous use.

This is controlled by files osslDefaultEnable.ini and osslEnable.ini, by default in folder bin/config-include 
The use logic of these two files is identical to OpenSimDefaults.ini and OpenSim.ini

Older OpenSimulator versions only used file osslEnable.ini. 
Some older OpenSimulator versions had checks for all OSSLfunctions. 
That made no sense for many functions, so now many are always allowed wasting no time on useless checks. 

For details about these permissions, please read file OpenSimDefaults.ini

= osslDefaultEnable.ini =
This file contains the defaults for OSSL execution permissions set by OpenSimulator dev team. 
Instead of changing defaults defined in code, the OpenSimulator dev team may decide to just make changes in this file. 
This file was not present on older OpenSimulator versions. 
If you need to change permissions, copy the respective entry to osslEnable.ini and modify there. 

= osslEnable.ini =
This file contains the local overrides for OSSL permissions. 
It is read after osslDefaultEnable.ini, and any entry on it replaces the old one. 
This file is not provided on code packages, an osslEnable.ini.example is. 
At first time setup, you will need to copy the example file to osslEnable.ini and then edit it for your needs, using osslDefaults.ini as reference. 
This was the only file used on older OpenSimulator versions.

== Current OSSL Functions Implemented ==

=== Avatars ===
{{multicol}}

* [[osAgentSaveAppearance]]
* [[osAvatarName2Key]]
* [[osAvatarPlayAnimation]]
* [[osAvatarStopAnimation]]
* [[osAvatarType]]
* [[osCauseDamage]]
* [[osCauseHealing]]
* [[osDetectedCountry]]
* [[osDropAttachment]]
* [[osDropAttachmentAt]]
* [[osEjectFromGroup]]
* [[osForceAttachToAvatar]]
* [[osForceAttachToAvatarFromInventory]]
* [[osForceAttachToOtherAvatarFromInventory]]
* [[osForceDetachFromAvatar]]
* [[osForceDropAttachment]]
* [[osForceDropAttachmentAt]]
* [[osForceOtherSit]]
* [[osGetAgentIP]]
* [[osGetAgents]]
{{multicol-break}}
* [[osGetAgentCountry]]
* [[osGetAvatarHomeURI]]
* [[osGetAvatarList]]
* [[osGetGender]]
* [[osGetHealRate]]
* [[osGetHealth]]
* [[osGetNumberOfAttachments]]
* [[osGrantScriptPermissions]]
* [[osInviteToGroup]]
* [[osKickAvatar]]
* [[osOwnerSaveAppearance]]
* [[osRevokeScriptPermissions]]
* [[osSetHealRate]]
* [[osSetHealth]]
* [[osSetOwnerSpeed]]
* [[osSetSpeed]]
* [[osLocalTeleportAgent]]
* [[osTeleportAgent]]
* [[osTeleportOwner]]
* [[osReplaceAgentEnvironment]]
{{multicol-end}}

=== NPCs ===
{{multicol}}
* [[osIsNpc]]
* [[osNpcCreate]]
* [[osGetNpcList]]
* [[osNpcGetPos]]
* [[osNpcGetRot]]
* [[osNpcGetOwner]]
* [[osNpcLookAt]] {{E}}
* [[osNpcLoadAppearance]]
* [[osNpcMoveTo]]
* [[osNpcMoveToTarget]]
* [[osNpcPlayAnimation]]
* [[osNpcRemove]]
* [[osNpcSaveAppearance]]
{{multicol-break}}
* [[osNpcSay]]
* [[osNpcSayTo]]
* [[osNpcSetProfileAbout]]
* [[osNpcSetProfileImage]]
* [[osNpcSetRot]]
* [[osNpcShout]]
* [[osNpcSit]]
* [[osNpcStand]]
* [[osNpcStopMoveToTarget]]
* [[osNpcStopAnimation]]
* [[osNpcTouch]]
* [[osNpcWhisper]]
{{multicol-end}}

=== Prim ===
{{multicol}}
* [[osClearInertia]]
* [[osClearObjectAnimations]]
* [[osDie]]
* [[osForceBreakAllLinks]]
* [[osForceBreakLink]]
* [[osForceCreateLink]]
* [[osGetInertiaData]]
* [[osGetInventoryItemKey]]
* [[osGetInventoryName]]
* [[osGetInventoryNames]] {{new}}
* [[osGetInventoryKeys]] {{new}}
* [[osGetInventoryDesc]]
* [[osGetInventoryLastOwner]]
* [[osGetLinkInventoryName]] {{new}}
* [[osGetLinkInventoryNames]] {{new}}
* [[osGetLinkInventoryKey]] {{new}}
* [[osGetLinkInventoryKeys]] {{new}}
* [[osGetLinkInventoryDesc]] {{new}}
* [[osGiveLinkInventory]] {{new}}
* [[osGiveLinkInventoryList]] {{new}}
* [[osRemoveLinkInventory]] {{new}}
* [[osGetLastChangedEventKey]]
* [[osGetLinkNumber]]
* [[osGetLinkPrimitiveParams]]
* [[osGetPrimitiveParams]]
{{multicol-break}}
* [[osGetRezzingObject]]
* [[osGetSitActiveRange]]
* [[osGetLinkSitActiveRange]]
* [[osGetSitTargetPos]] {{new}}
* [[osGetSitTargetRot]] {{new}}
* [[osGetStandTarget]]
* [[osGetLinkStandTarget]]
* [[osLinkParticleSystem]] {{new}}
* [[osMessageAttachments]]
* [[osMessageObject]]
* [[osParticleSystem]] {{new}}
* [[osSetInertia]]
* [[osSetInertiaAsBox]]
* [[osSetInertiaAsCylinder]]
* [[osSetInertiaAsSphere]]
* [[osSetPrimitiveParams]]
* [[osSetProjectionParams]]
* [[osSetSitActiveRange]]
* [[osSetLinkSitActiveRange]]
* [[osSetStandTarget]]
* [[osSetLinkStandTarget]]
* [[osTeleportObject]]
* [[osVolumeDetect]]
* [[osGetPrimCount]] {{new}}
* [[osGetSittingAvatarsCount]] {{new}}

{{multicol-end}}

=== Prim Drawing / Dynamic Texture ===
{{multicol}}
* [[osDrawEllipse]]
* [[osDrawFilledEllipse]]
* [[osDrawFilledPolygon]]
* [[osDrawFilledRectangle]]
* [[osDrawImage]]
* [[osDrawLine]]
* [[osDrawPolygon]]
* [[osDrawRectangle]]
* [[osDrawResetTransform]]
* [[osDrawRotationTransform]]
* [[osDrawScaleTransform]]
* [[osDrawText]]
* [[osDrawTranslationTransform]]
* [[osGetDrawStringSize]]
{{multicol-break}}
* [[osMovePen]]
* [[osSetFontName]]
* [[osSetFontSize]]
* [[osSetPenCap]]
* [[osSetPenColor]]
* [[osSetPenSize]]
* [[osSetDynamicTextureData]]
* [[osSetDynamicTextureDataFace]]
* [[osSetDynamicTextureDataBlend]]
* [[osSetDynamicTextureDataBlendFace]]
* [[osSetDynamicTextureURL]]
* [[osSetDynamicTextureURLBlend]]
* [[osSetDynamicTextureURLBlendFace]]
{{multicol-end}}

=== Notecard ===
* [[osGetNotecard]]
* [[osGetNotecardLine]]
* [[osGetNumberOfNotecardLines]]
* [[osMakeNotecard]]

=== Sound ===
{{multicol}}
* [[osAdjustSoundVolume]]
* [[osCollisionSound]]
* [[osLoopSound]]
* [[osLoopSoundMaster]]
* [[osLoopSoundSlave]]
* [[osPlaySound]]
{{multicol-break}}
* [[osPlaySoundSlave]]
* [[osPreloadSound]]
* [[osSetSoundRadius]]
* [[osStopSound]]
* [[osTriggerSound]]
* [[osTriggerSoundLimited]]
{{multicol-end}}

=== HTTP ===
* [[osRequestSecureURL]]
* [[osRequestURL]]
* [[osSetContentType]]

=== Parcel ===
{{multicol}}
* [[osParcelJoin]]
* [[osParcelSubdivide]]
* [[osGetParcelDwell]]
{{multicol-break}}
* [[osSetParcelDetails]]
* [[osGetParcelDetails]]
* [[osGetParcelIDs]]
* [[osGetParcelID]]
{{multicol-end}}

=== Terrain ===
* [[osGetTerrainHeight]]
* [[osSetTerrainHeight]]
* [[osSetTerrainTexture]]
* [[osSetTerrainTextureHeight]]
* [[osTerrainFlush]]

=== Region / Parcel Environment ===
{{multicol}}
* [[osGetCurrentSunHour]]
* [[osGetApparentTime]]
* [[osGetApparentTimeString]]
* [[osGetApparentRegionTime]]
* [[osGetApparentRegionTimeString]]
* [[osGetWindParam]]
{{multicol-break}}
* [[osSetRegionWaterHeight]]
* [[osSetWindParam]]
* [[osWindActiveModelPluginName]]
* [[osReplaceParcelEnvironment]]
* [[osReplaceRegionEnvironment]]
* [[osResetEnvironment]]
{{multicol-end}}

=== Grid / Region Information ===
{{multicol}}
* [[osCheckODE]]
* [[osGetGridCustom]]
* [[osGetGridGatekeeperURI]]
* [[osGetGridHomeURI]]
* [[osGetGridLoginURI]]
* [[osGetGridName]]
* [[osGetGridNick]]
* [[osGetMapTexture]]
* [[osGetPhysicsEngineName]]
* [[osGetPhysicsEngineType]]
{{multicol-break}}
* [[osGetRegionMapTexture]]
* [[osGetRegionSize]]
* [[osGetRegionStats]]
* [[osGetScriptEngineName]]
* [[osGetSimulatorMemory]]
* [[osGetSimulatorMemoryKB]]
* [[osGetSimulatorVersion]]
* [[osLoadedCreationDate]]
* [[osLoadedCreationID]]
* [[osLoadedCreationTime]]
{{multicol-end}}

=== Administration ===
* [[osConsoleCommand]]
* [[osRegionNotice]]
* [[osRegionRestart]]
* [[osSetParcelMediaURL]]
* [[osSetParcelMusicURL]]
* [[osSetParcelSIPAddress]]

=== Script ===
*[[osResetAllScripts]]

=== String Manipulation ===
{{multicol}}
* [[osFormatString]]
* [[osListenRegex]]
* [[osMatchString]]
* [[osRegexIsMatch]]
* [[osReplaceString]]
* [[osStringSubString]]
{{multicol-break}}
* [[osStringStartsWith]]
* [[osStringEndsWith]]
* [[osStringIndexOf]]
* [[osStringLastIndexOf]]
* [[osStringRemove]]
* [[osStringReplace]]
{{multicol-end}}

=== Misc ===
{{multicol}}
* [[osAESEncrypt]] {{new}}
* [[osAESDecrypt]] {{new}}
* [[osAESEncryptTo]] {{new}}
* [[osAESDecryptFrom]] {{new}}
* [[osAngleBetween]]
* [[osApproxEquals]]
* [[osGetPSTWallclock]]
* [[osListSortInPlace]]
* [[osListSortInPlaceStrided]] {{new}}
* [[osIsUUID]]
{{multicol-break}}
* [[osIsNotValidNumber]]
* [[osKey2Name]]
* [[osMax]]
* [[osMin]]
* [[osRound]]
* [[osSHA256]]
* [[osSlerp]]
* [[osUnixTimeToTimestamp]]
* [[osVecDistSquare]]
* [[osVecMagSquare]]
{{multicol-end}}

=== Deprecated ===
* [[osParcelSetDetails|<strike>osParcelSetDetails</strike>]] - Use [[osSetParcelDetails]]
* [[osSetPenColour|<strike>osSetPenColour</strike>]] - Use [[osSetPenColor]]
* [[osSunGetParam|<strike>osSunGetParam</strike>]] - Use [[osGetSunParam]]
* [[osSunSetParam|<strike>osSunSetParam</strike>]] - Use [[osSetSunParam]]
* [[osTerrainGetHeight|<strike>osTerrainGetHeight</strike>]] - Use [[osGetTerrainHeight]]
* [[osTerrainSetHeight|<strike>osTerrainSetHeight</strike>]] - Use [[osSetTerrainHeight]]
*<strike>osWindParamGet</strike> - Use [[osGetWindParam]]
*<strike>osWindParamSet</strike> - Use [[osSetWindParam]]
* [[osList2Double|<strike>osList2Double</strike>]] - Use llList2Float
* [[osGetSunParam]]
* [[osSetEstateSunSettings]]
* [[osSetRegionSunSettings]]
* [[osSetSunParam]]
* [[osSetPrimFloatOnWater]]

== See Also ==

* [[OSSL_vs_LSL|LSL&OSSL : Neighbour functions, similarities and differences]]
* [[Accessing_Prim_Properties|LSL&OSSL : Guide to prims addressing (by linknum, by uuid)]]
* [[LSL Status|LSL/OSSL Status Page]]
*OSSL
** [[OSSL_Implemented|OSSL Implemented Functions]]
** [[OSSL Constants|OSSL Constants]]
** [[OSSL Status/Types|OSSL Types Status Page]]
** [[OSSL Status/Events|OSSL Events Status Page]]

** [[Dynamic_textures|OSSL osDynamicTextures Functions Index Page]]
** [[OSSL TextureDrawing|OSSL TextureDrawing Extended Information]]
** [[OSSLNPC|OSSL functions for working with NPCs]]

** [[OSSL Proposals|OSSL Proposed Functions]]
** [[OSSL Enabling Functions]]
** [[OSSL Standards|OSSL Standards]]

* LS
** [[LightShare#LightShare Scripting|LightShare Functions]]

* MOD
** [[OSSL Script Library/ModSendCommand|modSendCommand()]]
** [[OSSL Script Library/ModInvoke|Custom functions using modInvoke()]]

* NPC
** [[Appearance_Formats|Appearance Notecard Format]]

[[Category:OSSL]]
[[Category:Scripts]]

OsGetInventoryNames

2024-02-27T06:38:51Z

JeffKelley: added return type

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=list osGetInventoryNames(integer type) 
|ossl_example=<source lang="lsl">
// Example for osGetInventoryNames
// This script uses the function osGetInventoryNames to return a list of inventory items by name
// based on the inventory type (INVENTORY_ALL)
// The found item names are output to owner chat

// Define the inventory type constant
integer INVENTORY_TYPE = INVENTORY_ALL;

// Event handler, that is executed on script start
default
{
state_entry()
{
// Use osGetInventoryNames to fetch the list of inventory items by name
list inventoryList = osGetInventoryNames(INVENTORY_TYPE);

// Check if the list is empty
if (llGetListLength(inventoryList) > 0)
{
// Go through the list and output each item to chat
integer numItems = llGetListLength(inventoryList);
string itemNames = "Inventory item(s):\n";
integer i;
for (i = 0; i < numItems; ++i)
{
string itemName = llList2String(inventoryList, i);
itemNames += itemName + "\n";
}
llOwnerSay(itemNames);
}
else
{
// If the list is empty give indication as such
llOwnerSay("Inventory is empty.");
}
}
}
</source>
|description=
Return a list of items names by type (or INVENTORY_ALL) located in the prim inventory.
|additional_info=This function was added in 0.9.3.0
}}

OsGetLinkInventoryDesc

2024-02-27T06:38:05Z

JeffKelley: added return type

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=string osGetLinkInventoryDesc(integer linkNumber, string itemNameorid) 
|ossl_example=<source lang="lsl">
// Example for osGetLinkInventoryDesc
// This script uses the osGetLinkInventoryDesc function to get the description of a specified inventory item
// It looks for the item via key or name in the specified linked prim

// Define the link number in which to look
integer CHILD_PRIM_NUMBER = 2;
// Define the inventory name or key
string itemNameOrID = "INVENTORY_KEY_OR_NAME";

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the description of the specified item from the linked prim
string itemDescription = osGetLinkInventoryDesc(CHILD_PRIM_NUMBER, itemNameOrID);

// Check if the description is not empty
if (itemDescription != "")
{
// Output to owner chat channel
llOwnerSay("Description reads: " + itemDescription);
}
else
{
// Notify if the description is empty or the item is missing entirely
llOwnerSay("Description empty or item not found");
}
}
}
</source>
|description=
Return the description of an item located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0
}}

OsGetLinkInventoryNames

2024-02-27T06:37:49Z

JeffKelley: added return type

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=list osGetLinkInventoryNames(integer linkNumber, integer type) 
|ossl_example=<source lang="lsl">
// Example for osGetLinkInventoryNames
// This script uses the osGetLinkInventoryNames function to return a list of inventory items of a specified type in a specified child prim

// Define the child prim
integer CHILD_PRIM_NUMBER = 2;
// Define the inventory type
integer INVENTORY_TYPE = INVENTORY_ALL;

// Event handler, that is executed on script start
default
{
state_entry()
{
// Get the list of inventory items by name
list inventoryNames = osGetLinkInventoryNames(CHILD_PRIM_NUMBER, INVENTORY_TYPE);

// Check if the list contains items
if (llGetListLength(inventoryNames) > 0)
{
// Go through the list and output the names to owner chat
integer numItems = llGetListLength(inventoryNames);
string itemNames = "Inventory items:\n";
integer i;
for (i = 0; i < numItems; ++i)
{
string itemName = llList2String(inventoryNames, i);
itemNames += itemName + "\n";
}
llOwnerSay(itemNames);
}
else
{
// If nothing is found indicate as such
llOwnerSay("The inventory of the child prim is empty or does not contains items of this inventory type");
}
}
}
</source>
|description=
Return a list of items names by type (or INVENTORY_ALL) located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0
}}

OsGetLinkInventoryName

2024-02-27T06:37:44Z

JeffKelley: added return type

OsGiveLinkInventoryList

2024-02-26T18:40:46Z

JeffKelley:

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=3|function_syntax=osGiveLinkInventoryList(integer linkNumber, key destination, string category, list inventory) 
|ossl_example=<source lang="lsl">
</source>
|description=
Give a group of items located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0
}}

OsRemoveLinkInventory

2024-02-26T18:15:13Z

JeffKelley: Created page with "{{osslfunc |threat_level=ignored |permissions=true |delay=0|function_syntax=osRemoveLinkInventory(integer linkNumber, string name) |ossl_example=<source lang="lsl"> </sour..."

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=osRemoveLinkInventory(integer linkNumber, string name) 
|ossl_example=<source lang="lsl">
</source>
|description=
Remove an item from a child prim inventory.
|additional_info=This function was added in 0.9.3.0
}}

OsGiveLinkInventoryList

2024-02-26T18:14:21Z

JeffKelley: Created page with "{{osslfunc |threat_level=ignored |permissions=true |delay=0|function_syntax=osGiveLinkInventoryList(integer linkNumber, key destination, string category, list inventory) |..."

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=osGiveLinkInventoryList(integer linkNumber, key destination, string category, list inventory) 
|ossl_example=<source lang="lsl">
</source>
|description=
Give a group of items located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0
}}

Category:OSSL Functions

2024-02-26T18:12:03Z

JeffKelley: /* Prim */

{{Quicklinks}}
 
<div style="background-color:#FFA500; padding:10px; padding-bottom:5px; border: 1px #FF544F solid">
This information is relative to (almost) the last OpenSimulator Development version. In some cases it may not apply to older versions.
</div>

== OSSL function permissions ==
Several OSSL functions have execution permission control to prevent abusive or dangerous use.

This is controlled by files osslDefaultEnable.ini and osslEnable.ini, by default in folder bin/config-include 
The use logic of these two files is identical to OpenSimDefaults.ini and OpenSim.ini

Older OpenSimulator versions only used file osslEnable.ini. 
Some older OpenSimulator versions had checks for all OSSLfunctions. 
That made no sense for many functions, so now many are always allowed wasting no time on useless checks. 

For details about these permissions, please read file OpenSimDefaults.ini

= osslDefaultEnable.ini =
This file contains the defaults for OSSL execution permissions set by OpenSimulator dev team. 
Instead of changing defaults defined in code, the OpenSimulator dev team may decide to just make changes in this file. 
This file was not present on older OpenSimulator versions. 
If you need to change permissions, copy the respective entry to osslEnable.ini and modify there. 

= osslEnable.ini =
This file contains the local overrides for OSSL permissions. 
It is read after osslDefaultEnable.ini, and any entry on it replaces the old one. 
This file is not provided on code packages, an osslEnable.ini.example is. 
At first time setup, you will need to copy the example file to osslEnable.ini and then edit it for your needs, using osslDefaults.ini as reference. 
This was the only file used on older OpenSimulator versions.

== Current OSSL Functions Implemented ==

=== Avatars ===
{{multicol}}

* [[osAgentSaveAppearance]]
* [[osAvatarName2Key]]
* [[osAvatarPlayAnimation]]
* [[osAvatarStopAnimation]]
* [[osAvatarType]]
* [[osCauseDamage]]
* [[osCauseHealing]]
* [[osDetectedCountry]]
* [[osDropAttachment]]
* [[osDropAttachmentAt]]
* [[osEjectFromGroup]]
* [[osForceAttachToAvatar]]
* [[osForceAttachToAvatarFromInventory]]
* [[osForceAttachToOtherAvatarFromInventory]]
* [[osForceDetachFromAvatar]]
* [[osForceDropAttachment]]
* [[osForceDropAttachmentAt]]
* [[osForceOtherSit]]
* [[osGetAgentIP]]
* [[osGetAgents]]
{{multicol-break}}
* [[osGetAgentCountry]]
* [[osGetAvatarHomeURI]]
* [[osGetAvatarList]]
* [[osGetGender]]
* [[osGetHealRate]]
* [[osGetHealth]]
* [[osGetNumberOfAttachments]]
* [[osGrantScriptPermissions]]
* [[osInviteToGroup]]
* [[osKickAvatar]]
* [[osOwnerSaveAppearance]]
* [[osRevokeScriptPermissions]]
* [[osSetHealRate]]
* [[osSetHealth]]
* [[osSetOwnerSpeed]]
* [[osSetSpeed]]
* [[osLocalTeleportAgent]]
* [[osTeleportAgent]]
* [[osTeleportOwner]]
* [[osReplaceAgentEnvironment]]
{{multicol-end}}

=== NPCs ===
{{multicol}}
* [[osIsNpc]]
* [[osNpcCreate]]
* [[osGetNpcList]]
* [[osNpcGetPos]]
* [[osNpcGetRot]]
* [[osNpcGetOwner]]
* [[osNpcLookAt]] {{E}}
* [[osNpcLoadAppearance]]
* [[osNpcMoveTo]]
* [[osNpcMoveToTarget]]
* [[osNpcPlayAnimation]]
* [[osNpcRemove]]
* [[osNpcSaveAppearance]]
{{multicol-break}}
* [[osNpcSay]]
* [[osNpcSayTo]]
* [[osNpcSetProfileAbout]]
* [[osNpcSetProfileImage]]
* [[osNpcSetRot]]
* [[osNpcShout]]
* [[osNpcSit]]
* [[osNpcStand]]
* [[osNpcStopMoveToTarget]]
* [[osNpcStopAnimation]]
* [[osNpcTouch]]
* [[osNpcWhisper]]
{{multicol-end}}

=== Prim ===
{{multicol}}
* [[osClearInertia]]
* [[osClearObjectAnimations]]
* [[osDie]]
* [[osForceBreakAllLinks]]
* [[osForceBreakLink]]
* [[osForceCreateLink]]
* [[osGetInertiaData]]
* [[osGetInventoryItemKey]]
* [[osGetInventoryName]]
* [[osGetInventoryNames]] {{new}}
* [[osGetInventoryKeys]] {{new}}
* [[osGetInventoryDesc]]
* [[osGetInventoryLastOwner]]
* [[osGetLinkInventoryName]] {{new}}
* [[osGetLinkInventoryNames]] {{new}}
* [[osGetLinkInventoryKey]] {{new}}
* [[osGetLinkInventoryKeys]] {{new}}
* [[osGetLinkInventoryDesc]] {{new}}
* [[osGiveLinkInventory]] {{new}}
* [[osGiveLinkInventoryList]] {{new}}
* [[osRemoveLinkInventory]] {{new}}
* [[osGetLastChangedEventKey]]
* [[osGetLinkNumber]]
{{multicol-break}}
* [[osGetLinkPrimitiveParams]]
* [[osGetPrimitiveParams]]
* [[osGetRezzingObject]]
* [[osGetSitActiveRange]]
* [[osGetLinkSitActiveRange]]
* [[osGetStandTarget]]
* [[osGetLinkStandTarget]]
* [[osLinkParticleSystem]] {{new}}
* [[osMessageAttachments]]
* [[osMessageObject]]
* [[osParticleSystem]] {{new}}
* [[osSetInertia]]
* [[osSetInertiaAsBox]]
* [[osSetInertiaAsCylinder]]
* [[osSetInertiaAsSphere]]
* [[osSetPrimitiveParams]]
* [[osSetProjectionParams]]
* [[osSetSitActiveRange]]
* [[osSetLinkSitActiveRange]]
* [[osSetStandTarget]]
* [[osSetLinkStandTarget]]
* [[osTeleportObject]]
* [[osVolumeDetect]]
* [[osGetPrimCount]] {{new}}
* [[osGetSittingAvatarsCount]] {{new}}

{{multicol-end}}

=== Prim Drawing / Dynamic Texture ===
{{multicol}}
* [[osDrawEllipse]]
* [[osDrawFilledEllipse]]
* [[osDrawFilledPolygon]]
* [[osDrawFilledRectangle]]
* [[osDrawImage]]
* [[osDrawLine]]
* [[osDrawPolygon]]
* [[osDrawRectangle]]
* [[osDrawResetTransform]]
* [[osDrawRotationTransform]]
* [[osDrawScaleTransform]]
* [[osDrawText]]
* [[osDrawTranslationTransform]]
* [[osGetDrawStringSize]]
{{multicol-break}}
* [[osMovePen]]
* [[osSetFontName]]
* [[osSetFontSize]]
* [[osSetPenCap]]
* [[osSetPenColor]]
* [[osSetPenSize]]
* [[osSetDynamicTextureData]]
* [[osSetDynamicTextureDataFace]]
* [[osSetDynamicTextureDataBlend]]
* [[osSetDynamicTextureDataBlendFace]]
* [[osSetDynamicTextureURL]]
* [[osSetDynamicTextureURLBlend]]
* [[osSetDynamicTextureURLBlendFace]]
{{multicol-end}}

=== Notecard ===
* [[osGetNotecard]]
* [[osGetNotecardLine]]
* [[osGetNumberOfNotecardLines]]
* [[osMakeNotecard]]

=== Sound ===
{{multicol}}
* [[osAdjustSoundVolume]]
* [[osCollisionSound]]
* [[osLoopSound]]
* [[osLoopSoundMaster]]
* [[osLoopSoundSlave]]
* [[osPlaySound]]
{{multicol-break}}
* [[osPlaySoundSlave]]
* [[osPreloadSound]]
* [[osSetSoundRadius]]
* [[osStopSound]]
* [[osTriggerSound]]
* [[osTriggerSoundLimited]]
{{multicol-end}}

=== HTTP ===
* [[osRequestSecureURL]]
* [[osRequestURL]]
* [[osSetContentType]]

=== Parcel ===
{{multicol}}
* [[osParcelJoin]]
* [[osParcelSubdivide]]
* [[osGetParcelDwell]]
{{multicol-break}}
* [[osSetParcelDetails]]
* [[osGetParcelDetails]]
* [[osGetParcelIDs]]
* [[osGetParcelID]]
{{multicol-end}}

=== Terrain ===
* [[osGetTerrainHeight]]
* [[osSetTerrainHeight]]
* [[osSetTerrainTexture]]
* [[osSetTerrainTextureHeight]]
* [[osTerrainFlush]]

=== Region / Parcel Environment ===
{{multicol}}
* [[osGetCurrentSunHour]]
* [[osGetApparentTime]]
* [[osGetApparentTimeString]]
* [[osGetApparentRegionTime]]
* [[osGetApparentRegionTimeString]]
* [[osGetWindParam]]
{{multicol-break}}
* [[osSetRegionWaterHeight]]
* [[osSetWindParam]]
* [[osWindActiveModelPluginName]]
* [[osReplaceParcelEnvironment]]
* [[osReplaceRegionEnvironment]]
* [[osResetEnvironment]]
{{multicol-end}}

=== Grid / Region Information ===
{{multicol}}
* [[osCheckODE]]
* [[osGetGridCustom]]
* [[osGetGridGatekeeperURI]]
* [[osGetGridHomeURI]]
* [[osGetGridLoginURI]]
* [[osGetGridName]]
* [[osGetGridNick]]
* [[osGetMapTexture]]
* [[osGetPhysicsEngineName]]
* [[osGetPhysicsEngineType]]
{{multicol-break}}
* [[osGetRegionMapTexture]]
* [[osGetRegionSize]]
* [[osGetRegionStats]]
* [[osGetScriptEngineName]]
* [[osGetSimulatorMemory]]
* [[osGetSimulatorMemoryKB]]
* [[osGetSimulatorVersion]]
* [[osLoadedCreationDate]]
* [[osLoadedCreationID]]
* [[osLoadedCreationTime]]
{{multicol-end}}

=== Administration ===
* [[osConsoleCommand]]
* [[osRegionNotice]]
* [[osRegionRestart]]
* [[osSetParcelMediaURL]]
* [[osSetParcelMusicURL]]
* [[osSetParcelSIPAddress]]

=== Script ===
*[[osResetAllScripts]]

=== String Manipulation ===
{{multicol}}
* [[osFormatString]]
* [[osListenRegex]]
* [[osMatchString]]
* [[osRegexIsMatch]]
* [[osReplaceString]]
* [[osStringSubString]]
{{multicol-break}}
* [[osStringStartsWith]]
* [[osStringEndsWith]]
* [[osStringIndexOf]]
* [[osStringLastIndexOf]]
* [[osStringRemove]]
* [[osStringReplace]]
{{multicol-end}}

=== Misc ===
{{multicol}}
* [[osAESEncrypt]] {{new}}
* [[osAESDecrypt]] {{new}}
* [[osAESEncryptTo]] {{new}}
* [[osAESDecryptFrom]] {{new}}
* [[osAngleBetween]]
* [[osApproxEquals]]
* [[osGetPSTWallclock]]
* [[osListSortInPlace]]
* [[osListSortInPlaceStrided]] {{new}}
* [[osIsUUID]]
{{multicol-break}}
* [[osIsNotValidNumber]]
* [[osKey2Name]]
* [[osMax]]
* [[osMin]]
* [[osRound]]
* [[osSHA256]]
* [[osSlerp]]
* [[osUnixTimeToTimestamp]]
* [[osVecDistSquare]]
* [[osVecMagSquare]]
{{multicol-end}}

=== Deprecated ===
* [[osParcelSetDetails|<strike>osParcelSetDetails</strike>]] - Use [[osSetParcelDetails]]
* [[osSetPenColour|<strike>osSetPenColour</strike>]] - Use [[osSetPenColor]]
* [[osSunGetParam|<strike>osSunGetParam</strike>]] - Use [[osGetSunParam]]
* [[osSunSetParam|<strike>osSunSetParam</strike>]] - Use [[osSetSunParam]]
* [[osTerrainGetHeight|<strike>osTerrainGetHeight</strike>]] - Use [[osGetTerrainHeight]]
* [[osTerrainSetHeight|<strike>osTerrainSetHeight</strike>]] - Use [[osSetTerrainHeight]]
*<strike>osWindParamGet</strike> - Use [[osGetWindParam]]
*<strike>osWindParamSet</strike> - Use [[osSetWindParam]]
* [[osList2Double|<strike>osList2Double</strike>]] - Use llList2Float
* [[osGetSunParam]]
* [[osSetEstateSunSettings]]
* [[osSetRegionSunSettings]]
* [[osSetSunParam]]
* [[osSetPrimFloatOnWater]]

== See Also ==

* [[OSSL_vs_LSL|LSL&OSSL : Neighbour functions, similarities and differences]]
* [[Accessing_Prim_Properties|LSL&OSSL : Guide to prims addressing (by linknum, by uuid)]]
* [[LSL Status|LSL/OSSL Status Page]]
*OSSL
** [[OSSL_Implemented|OSSL Implemented Functions]]
** [[OSSL Constants|OSSL Constants]]
** [[OSSL Status/Types|OSSL Types Status Page]]
** [[OSSL Status/Events|OSSL Events Status Page]]

** [[Dynamic_textures|OSSL osDynamicTextures Functions Index Page]]
** [[OSSL TextureDrawing|OSSL TextureDrawing Extended Information]]
** [[OSSLNPC|OSSL functions for working with NPCs]]

** [[OSSL Proposals|OSSL Proposed Functions]]
** [[OSSL Enabling Functions]]
** [[OSSL Standards|OSSL Standards]]

* LS
** [[LightShare#LightShare Scripting|LightShare Functions]]

* MOD
** [[OSSL Script Library/ModSendCommand|modSendCommand()]]
** [[OSSL Script Library/ModInvoke|Custom functions using modInvoke()]]

* NPC
** [[Appearance_Formats|Appearance Notecard Format]]

[[Category:OSSL]]
[[Category:Scripts]]

Category:OSSL Functions

2024-02-24T14:22:50Z

JeffKelley: /* Misc */

{{Quicklinks}}
 
<div style="background-color:#FFA500; padding:10px; padding-bottom:5px; border: 1px #FF544F solid">
This information is relative to (almost) the last OpenSimulator Development version. In some cases it may not apply to older versions.
</div>

== OSSL function permissions ==
Several OSSL functions have execution permission control to prevent abusive or dangerous use.

This is controlled by files osslDefaultEnable.ini and osslEnable.ini, by default in folder bin/config-include 
The use logic of these two files is identical to OpenSimDefaults.ini and OpenSim.ini

Older OpenSimulator versions only used file osslEnable.ini. 
Some older OpenSimulator versions had checks for all OSSLfunctions. 
That made no sense for many functions, so now many are always allowed wasting no time on useless checks. 

For details about these permissions, please read file OpenSimDefaults.ini

= osslDefaultEnable.ini =
This file contains the defaults for OSSL execution permissions set by OpenSimulator dev team. 
Instead of changing defaults defined in code, the OpenSimulator dev team may decide to just make changes in this file. 
This file was not present on older OpenSimulator versions. 
If you need to change permissions, copy the respective entry to osslEnable.ini and modify there. 

= osslEnable.ini =
This file contains the local overrides for OSSL permissions. 
It is read after osslDefaultEnable.ini, and any entry on it replaces the old one. 
This file is not provided on code packages, an osslEnable.ini.example is. 
At first time setup, you will need to copy the example file to osslEnable.ini and then edit it for your needs, using osslDefaults.ini as reference. 
This was the only file used on older OpenSimulator versions.

== Current OSSL Functions Implemented ==

=== Avatars ===
{{multicol}}

* [[osAgentSaveAppearance]]
* [[osAvatarName2Key]]
* [[osAvatarPlayAnimation]]
* [[osAvatarStopAnimation]]
* [[osAvatarType]]
* [[osCauseDamage]]
* [[osCauseHealing]]
* [[osDetectedCountry]]
* [[osDropAttachment]]
* [[osDropAttachmentAt]]
* [[osEjectFromGroup]]
* [[osForceAttachToAvatar]]
* [[osForceAttachToAvatarFromInventory]]
* [[osForceAttachToOtherAvatarFromInventory]]
* [[osForceDetachFromAvatar]]
* [[osForceDropAttachment]]
* [[osForceDropAttachmentAt]]
* [[osForceOtherSit]]
* [[osGetAgentIP]]
* [[osGetAgents]]
{{multicol-break}}
* [[osGetAgentCountry]]
* [[osGetAvatarHomeURI]]
* [[osGetAvatarList]]
* [[osGetGender]]
* [[osGetHealRate]]
* [[osGetHealth]]
* [[osGetNumberOfAttachments]]
* [[osGrantScriptPermissions]]
* [[osInviteToGroup]]
* [[osKickAvatar]]
* [[osOwnerSaveAppearance]]
* [[osRevokeScriptPermissions]]
* [[osSetHealRate]]
* [[osSetHealth]]
* [[osSetOwnerSpeed]]
* [[osSetSpeed]]
* [[osLocalTeleportAgent]]
* [[osTeleportAgent]]
* [[osTeleportOwner]]
* [[osReplaceAgentEnvironment]]
{{multicol-end}}

=== NPCs ===
{{multicol}}
* [[osIsNpc]]
* [[osNpcCreate]]
* [[osGetNpcList]]
* [[osNpcGetPos]]
* [[osNpcGetRot]]
* [[osNpcGetOwner]]
* [[osNpcLookAt]] {{E}}
* [[osNpcLoadAppearance]]
* [[osNpcMoveTo]]
* [[osNpcMoveToTarget]]
* [[osNpcPlayAnimation]]
* [[osNpcRemove]]
* [[osNpcSaveAppearance]]
{{multicol-break}}
* [[osNpcSay]]
* [[osNpcSayTo]]
* [[osNpcSetProfileAbout]]
* [[osNpcSetProfileImage]]
* [[osNpcSetRot]]
* [[osNpcShout]]
* [[osNpcSit]]
* [[osNpcStand]]
* [[osNpcStopMoveToTarget]]
* [[osNpcStopAnimation]]
* [[osNpcTouch]]
* [[osNpcWhisper]]
{{multicol-end}}

=== Prim ===
{{multicol}}
* [[osClearInertia]]
* [[osClearObjectAnimations]]
* [[osDie]]
* [[osForceBreakAllLinks]]
* [[osForceBreakLink]]
* [[osForceCreateLink]]
* [[osGetInertiaData]]
* [[osGetInventoryItemKey]]
* [[osGetInventoryName]]
* [[osGetInventoryNames]] {{new}}
* [[osGetInventoryKeys]] {{new}}
* [[osGetInventoryDesc]]
* [[osGetInventoryLastOwner]]
* [[osGetLinkInventoryName]] {{new}}
* [[osGetLinkInventoryNames]] {{new}}
* [[osGetLinkInventoryKey]] {{new}}
* [[osGetLinkInventoryKeys]] {{new}}
* [[osGetLinkInventoryDesc]] {{new}}
* [[osGiveLinkInventory]] {{new}}
* [[osGetLastChangedEventKey]]
* [[osGetLinkNumber]]
* [[osGetLinkPrimitiveParams]]
* [[osGetPrimitiveParams]]
{{multicol-break}}
* [[osGetRezzingObject]]
* [[osGetSitActiveRange]]
* [[osGetLinkSitActiveRange]]
* [[osGetStandTarget]]
* [[osGetLinkStandTarget]]
* [[osLinkParticleSystem]] {{new}}
* [[osMessageAttachments]]
* [[osMessageObject]]
* [[osParticleSystem]] {{new}}
* [[osSetInertia]]
* [[osSetInertiaAsBox]]
* [[osSetInertiaAsCylinder]]
* [[osSetInertiaAsSphere]]
* [[osSetPrimitiveParams]]
* [[osSetProjectionParams]]
* [[osSetSitActiveRange]]
* [[osSetLinkSitActiveRange]]
* [[osSetStandTarget]]
* [[osSetLinkStandTarget]]
* [[osTeleportObject]]
* [[osVolumeDetect]]
* [[osGetPrimCount]] {{new}}
* [[osGetSittingAvatarsCount]] {{new}}

{{multicol-end}}

=== Prim Drawing / Dynamic Texture ===
{{multicol}}
* [[osDrawEllipse]]
* [[osDrawFilledEllipse]]
* [[osDrawFilledPolygon]]
* [[osDrawFilledRectangle]]
* [[osDrawImage]]
* [[osDrawLine]]
* [[osDrawPolygon]]
* [[osDrawRectangle]]
* [[osDrawResetTransform]]
* [[osDrawRotationTransform]]
* [[osDrawScaleTransform]]
* [[osDrawText]]
* [[osDrawTranslationTransform]]
* [[osGetDrawStringSize]]
{{multicol-break}}
* [[osMovePen]]
* [[osSetFontName]]
* [[osSetFontSize]]
* [[osSetPenCap]]
* [[osSetPenColor]]
* [[osSetPenSize]]
* [[osSetDynamicTextureData]]
* [[osSetDynamicTextureDataFace]]
* [[osSetDynamicTextureDataBlend]]
* [[osSetDynamicTextureDataBlendFace]]
* [[osSetDynamicTextureURL]]
* [[osSetDynamicTextureURLBlend]]
* [[osSetDynamicTextureURLBlendFace]]
{{multicol-end}}

=== Notecard ===
* [[osGetNotecard]]
* [[osGetNotecardLine]]
* [[osGetNumberOfNotecardLines]]
* [[osMakeNotecard]]

=== Sound ===
{{multicol}}
* [[osAdjustSoundVolume]]
* [[osCollisionSound]]
* [[osLoopSound]]
* [[osLoopSoundMaster]]
* [[osLoopSoundSlave]]
* [[osPlaySound]]
{{multicol-break}}
* [[osPlaySoundSlave]]
* [[osPreloadSound]]
* [[osSetSoundRadius]]
* [[osStopSound]]
* [[osTriggerSound]]
* [[osTriggerSoundLimited]]
{{multicol-end}}

=== HTTP ===
* [[osRequestSecureURL]]
* [[osRequestURL]]
* [[osSetContentType]]

=== Parcel ===
{{multicol}}
* [[osParcelJoin]]
* [[osParcelSubdivide]]
* [[osGetParcelDwell]]
{{multicol-break}}
* [[osSetParcelDetails]]
* [[osGetParcelDetails]]
* [[osGetParcelIDs]]
* [[osGetParcelID]]
{{multicol-end}}

=== Terrain ===
* [[osGetTerrainHeight]]
* [[osSetTerrainHeight]]
* [[osSetTerrainTexture]]
* [[osSetTerrainTextureHeight]]
* [[osTerrainFlush]]

=== Region / Parcel Environment ===
{{multicol}}
* [[osGetCurrentSunHour]]
* [[osGetApparentTime]]
* [[osGetApparentTimeString]]
* [[osGetApparentRegionTime]]
* [[osGetApparentRegionTimeString]]
* [[osGetWindParam]]
{{multicol-break}}
* [[osSetRegionWaterHeight]]
* [[osSetWindParam]]
* [[osWindActiveModelPluginName]]
* [[osReplaceParcelEnvironment]]
* [[osReplaceRegionEnvironment]]
* [[osResetEnvironment]]
{{multicol-end}}

=== Grid / Region Information ===
{{multicol}}
* [[osCheckODE]]
* [[osGetGridCustom]]
* [[osGetGridGatekeeperURI]]
* [[osGetGridHomeURI]]
* [[osGetGridLoginURI]]
* [[osGetGridName]]
* [[osGetGridNick]]
* [[osGetMapTexture]]
* [[osGetPhysicsEngineName]]
* [[osGetPhysicsEngineType]]
{{multicol-break}}
* [[osGetRegionMapTexture]]
* [[osGetRegionSize]]
* [[osGetRegionStats]]
* [[osGetScriptEngineName]]
* [[osGetSimulatorMemory]]
* [[osGetSimulatorMemoryKB]]
* [[osGetSimulatorVersion]]
* [[osLoadedCreationDate]]
* [[osLoadedCreationID]]
* [[osLoadedCreationTime]]
{{multicol-end}}

=== Administration ===
* [[osConsoleCommand]]
* [[osRegionNotice]]
* [[osRegionRestart]]
* [[osSetParcelMediaURL]]
* [[osSetParcelMusicURL]]
* [[osSetParcelSIPAddress]]

=== Script ===
*[[osResetAllScripts]]

=== String Manipulation ===
{{multicol}}
* [[osFormatString]]
* [[osListenRegex]]
* [[osMatchString]]
* [[osRegexIsMatch]]
* [[osReplaceString]]
* [[osStringSubString]]
{{multicol-break}}
* [[osStringStartsWith]]
* [[osStringEndsWith]]
* [[osStringIndexOf]]
* [[osStringLastIndexOf]]
* [[osStringRemove]]
* [[osStringReplace]]
{{multicol-end}}

=== Misc ===
{{multicol}}
* [[osAESEncrypt]] {{new}}
* [[osAESDecrypt]] {{new}}
* [[osAESEncryptTo]] {{new}}
* [[osAESDecryptFrom]] {{new}}
* [[osAngleBetween]]
* [[osApproxEquals]]
* [[osGetPSTWallclock]]
* [[osListSortInPlace]]
* [[osListSortInPlaceStrided]] {{new}}
* [[osIsUUID]]
{{multicol-break}}
* [[osIsNotValidNumber]]
* [[osKey2Name]]
* [[osMax]]
* [[osMin]]
* [[osRound]]
* [[osSHA256]]
* [[osSlerp]]
* [[osUnixTimeToTimestamp]]
* [[osVecDistSquare]]
* [[osVecMagSquare]]
{{multicol-end}}

=== Deprecated ===
* [[osParcelSetDetails|<strike>osParcelSetDetails</strike>]] - Use [[osSetParcelDetails]]
* [[osSetPenColour|<strike>osSetPenColour</strike>]] - Use [[osSetPenColor]]
* [[osSunGetParam|<strike>osSunGetParam</strike>]] - Use [[osGetSunParam]]
* [[osSunSetParam|<strike>osSunSetParam</strike>]] - Use [[osSetSunParam]]
* [[osTerrainGetHeight|<strike>osTerrainGetHeight</strike>]] - Use [[osGetTerrainHeight]]
* [[osTerrainSetHeight|<strike>osTerrainSetHeight</strike>]] - Use [[osSetTerrainHeight]]
*<strike>osWindParamGet</strike> - Use [[osGetWindParam]]
*<strike>osWindParamSet</strike> - Use [[osSetWindParam]]
* [[osList2Double|<strike>osList2Double</strike>]] - Use llList2Float
* [[osGetSunParam]]
* [[osSetEstateSunSettings]]
* [[osSetRegionSunSettings]]
* [[osSetSunParam]]
* [[osSetPrimFloatOnWater]]

== See Also ==

* [[OSSL_vs_LSL|LSL&OSSL : Neighbour functions, similarities and differences]]
* [[Accessing_Prim_Properties|LSL&OSSL : Guide to prims addressing (by linknum, by uuid)]]
* [[LSL Status|LSL/OSSL Status Page]]
*OSSL
** [[OSSL_Implemented|OSSL Implemented Functions]]
** [[OSSL Constants|OSSL Constants]]
** [[OSSL Status/Types|OSSL Types Status Page]]
** [[OSSL Status/Events|OSSL Events Status Page]]

** [[Dynamic_textures|OSSL osDynamicTextures Functions Index Page]]
** [[OSSL TextureDrawing|OSSL TextureDrawing Extended Information]]
** [[OSSLNPC|OSSL functions for working with NPCs]]

** [[OSSL Proposals|OSSL Proposed Functions]]
** [[OSSL Enabling Functions]]
** [[OSSL Standards|OSSL Standards]]

* LS
** [[LightShare#LightShare Scripting|LightShare Functions]]

* MOD
** [[OSSL Script Library/ModSendCommand|modSendCommand()]]
** [[OSSL Script Library/ModInvoke|Custom functions using modInvoke()]]

* NPC
** [[Appearance_Formats|Appearance Notecard Format]]

[[Category:OSSL]]
[[Category:Scripts]]

OsGiveLinkInventory

2024-02-22T07:16:23Z

JeffKelley:

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=3|function_syntax=osGiveLinkInventory(integer linkNumber, key destination, string inventory) 
|ossl_example=<source lang="lsl">
</source>
|description=
Give an item located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0
}}

OsGetLinkInventoryName

2024-02-22T07:13:11Z

JeffKelley: Created page with "{{osslfunc |threat_level=ignored |permissions=true |delay=0|function_syntax=osGetLinkInventoryName(integer linkNumber, key itemId) |ossl_example=<source lang="lsl"> </sour..."

{{osslfunc
|threat_level=ignored
|permissions=true
|delay=0|function_syntax=osGetLinkInventoryName(integer linkNumber, key itemId) 
|ossl_example=<source lang="lsl">
</source>
|description=
Return the name of an item located in a child prim inventory.
|additional_info=This function was added in 0.9.3.0
}}