Second Life Wiki - User contributions [en]

Category talk:LSL User-Defined Functions

2024-08-14T16:29:53Z

Rhet0rica Resident:

== Optional (and/or Default) Parameters ==

Hi, just wondering if LSL has the ability to support optional parameters for UDF's?

As example, I'm wanting to create a function that passes commands between attachments. I want this function to always take a "command" variable, and optionally may also take relevant "parameter" variable(s). Something vaguely like this, for a weapon and HUD...

<syntaxhighlight lang="lsl2">
integer ACCESSORY_COMMAND_CHANNEL = 10;
key OWNER_KEY;

accessoryCommand(string cmd, string param = "")
{
llRegionSayTo(OWNER_KEY, ACCESSORY_COMMAND_CHANNEL, cmd + ":" + param);
}

default
{
state_entry() {
OWNER_KEY = llGetOwner();
}

touch_start(integer num) {
accessoryCommand("primary_attached");
accessoryCommand("ammo", "30");
}
}
</syntaxhighlight>
Appreciate any help or direction!
[[User:Takura Thielt|Takura Thielt]] ([[User talk:Takura Thielt|talk]]) 13:46, 26 July 2024 (PDT)

:Edit: I know I could have, and arguably should have just attempted this ISL myself, but I was hoping there might just be some special syntax that I wasn't thinking of. After some discussion elsewhere, I've learned this isn't available in LSL (as perhaps should have been evidenced by the fact that we sometimes need to pass empty/blank variables to built-in functions.)

:So, for my example above, I'll just have to do the same - that is, passing the second variable as an empty string, or else, as was suggested, try utilizing [https://wiki.secondlife.com/wiki/Json_usage_in_LSL JSON] functions. (Also, please forgive me as I'm learning Wiki formatting, lol. I suspect I may not be doing this properly.) [[User:Takura Thielt|Takura Thielt]] ([[User talk:Takura Thielt|talk]]) 13:46, 26 July 2024 (PDT)

::No such luck—parameter lists must be finalized at compile time. For some very hairy projects I've occasionally used lists, but for a single optional parameter you'll just have to bite the bullet and write it out every single function call. LSL is little better than structured assembly; the programmer has to write for the machine, rather than expecting the compiler to provide creature comforts. Fortunately, server-side [[Lua_FAQ|Lua]] is on the horizon! [[User:Rhet0rica Resident|rhet0rica]] ([[User talk:Rhet0rica Resident|talk]]) 09:29, 14 August 2024 (PDT)

User:Rhet0rica Resident/RLVa Protocol

2024-08-14T15:28:20Z

Rhet0rica Resident: added highlighting for RLVa-only behaviors

There are two implementations of the RLV protocol: Marine Kelley's RLV codebase and Kitty Barnett's RLVa codebase. As of this writing, RLV is used by RestrainedLove, Cool VL Viewer, and Kokua; RLVa is used by Catznip, Alchemy, Black Dragon, Firestorm, Genesis, and Singularity.

Naturally, whenever there are two or more implementations of anything, there are differences between the two. The main [[LSL_Protocol/RestrainedLoveAPI|RLV documentation]] on this wiki has been around for a long time and is primarily maintained by [[User:Marine Kelley|Marine Kelley]], the creator of the RLV ecosystem. While an invaluable resource for scripters targeting Marine's viewer and its progeny, it makes little mention of RLVa-specific features. This is ''mostly'' a good thing, as it encourages scripters to focus only on what has universal support, but at the same time there has been a dearth of information around RLVa, and what has been available [https://wiki.catznip.com/index.php?title=Category:RLVa|at the Catznip Wiki] is somewhat incomplete.

The purpose of this page is to document the RLV protocol from an RLVa-centric perspective, both for my own reference and that of others. Behavior names in '''bold''' are absent from the RLV documentation and are almost certainly unique to RLVa.

<div class="messagebox">This page describes '''RLVa 2.4.2.74783'''.</div>

{| class="wikitable" style="margin: auto"
|-
! style="position: sticky;"| Behavior
! style="position: sticky;"| Modifiers
! style="position: sticky;"| y/n
! style="position: sticky;"| add/rem
! style="position: sticky;"| _sec
! style="position: sticky;"| exception (y/n)
! style="position: sticky;"| info
! style="position: sticky;"| ReplyProcessor
! style="position: sticky;"| force
! style="position: sticky;"| experimental
! style="position: sticky;"| extended
|-
| acceptpermission || || ✔ || || || || || || || ||
|-
| accepttp || || ✔ || || ✔ || ✔ || || || || ||
|-
| accepttprequest || || ✔ || || ✔ || ✔ || || || || || ✔
|-
| addattach || || || || || || || || || ||
|-
| addoutfit || || || ✔ || || || ✔ || || || ||
|-
| addoutfit || || || || || || || || ✔ || ||
|-
| addoutfitall || || || || || || || || ✔ || ||
|-
| addoutfitallover || || || || || || || || ✔ || ||
|-
| addoutfitallthis || || || || || || || || ✔ || ||
|-
| addoutfitallthisover || || || || || || || || ✔ || ||
|-
| addoutfitover || || || || || || || || ✔ || ||
|-
| addoutfitthis || || || || || || || || ✔ || ||
|-
| addoutfitthisover || || || || || || || || ✔ || ||
|-
| adjustheight || || || || || || || || ✔ || ||
|-
| allowidle || || ✔ || || || || || || || ✔ ||
|-
| alwaysrun || || ✔ || || || || || || || ||
|-
| attach || || || || || || ✔ || || || ||
|-
| attachall || || || || || || ✔ || || || ||
|-
| attachallover || || || || || || ✔ || || || ||
|-
| attachalloverorreplace || || || || || || || || ✔ || ||
|-
| attachallthis || || || ✔ || || || ✔ || || || ||
|-
| attachallthis || || || || || || ✔ || || ✔ || ||
|-
| attachallthis_except || || || ✔ || || || ✔ || || || ||
|-
| attachallthisover || || || || || || ✔ || || ✔ || ||
|-
| attachallthisoverorreplace || || || || || || || || ✔ || ||
|-
| attachover || || || || || || ✔ || || ✔ || ||
|-
| attachoverorreplace || || || || || || || || ✔ || ||
|-
| attachthis || || || ✔ || || || ✔ || || || ||
|-
| attachthis || || || || || || ✔ || || ✔ || ||
|-
| attachthis_except || || || ✔ || || || ✔ || || || ||
|-
| attachthisover || || || || || || ✔ || || || ||
|-
| attachthisoverorreplace || || || || || || || || ✔ || ||
|-
| '''buy''' || || ✔ || || || || || || || ||
|-
| camavdist || || || || || || || || || ||
|-
| camdistmax || || || || || || || || || ||
|-
| camdistmin || || || || || || || || || ||
|-
| camtextures || || ✔ || || || || || || || ||
|-
| camunlock || || ✔ || || || || || || || ||
|-
| camzoommax || || || || || || || || || ||
|-
| camzoommin || || || || || || || || || ||
|-
| chatnormal || || ✔ || || || || || || || ||
|-
| chatshout || || ✔ || || || || || || || ||
|-
| chatwhisper || || ✔ || || || || || || || ||
|-
| detach || || ✔ || || || || || || || ||
|-
| detach || || || || || || || || ✔ || ||
|-
| detachall || || || || || || ✔ || || || ||
|-
| detachallthis || || || ✔ || || || ✔ || || || ||
|-
| detachallthis || || || || || || ✔ || || || ||
|-
| detachallthis_except || || || ✔ || || || ✔ || || || ||
|-
| detachme || || || || || || || || ✔ || ||
|-
| detachthis || || || ✔ || || || ✔ || || || ||
|-
| detachthis || || || || || || ✔ || || || ||
|-
| detachthis_except || || || ✔ || || || ✔ || || || ||
|-
| edit || || ✔ || || || ✔ || || || || ||
|-
| editattach || || ✔ || || || || || || || ||
|-
| editobj || || || || || ✔ || || || || ||
|-
| editworld || || ✔ || || || || || || || ||
|-
| emote || || ✔ || || || || || || || ||
|-
| fartouch || Fartouch Distance || ✔ || || || || || || || ||
|-
| findfolder || || || || || || ✔ || || || ||
|-
| findfolders || || || || || || ✔ || || || || ✔
|-
| fly || || ✔ || || || || || || || ||
|-
| fly || || || || || || || || ✔ || ||
|-
| '''getaddattachnames''' || || || || || || ✔ || || || ✔ ||
|-
| '''getaddoutfitnames''' || || || || || || ✔ || || || ✔ ||
|-
| getattach || || || || || || ✔ || || || ||
|-
| '''getattachnames''' || || || || || || ✔ || || || ✔ ||
|-
| getcam_avdist || || || || || || || ✔ || || ✔ ||
|-
| getcam_avdistmax || || || || || || || ✔ || || ✔ ||
|-
| getcam_avdistmin || || || || || || || ✔ || || ✔ ||
|-
| getcam_fov || || || || || || || ✔ || || ✔ ||
|-
| getcam_fovmax || || || || || || || ✔ || || ✔ ||
|-
| getcam_fovmin || || || || || || || ✔ || || ✔ ||
|-
| getcam_textures || || || || || || || ✔ || || ✔ ||
|-
| '''getcommand''' || || || || || || || ✔ || || || ✔
|-
| getgroup || || || || || || ✔ || || || ||
|-
| '''getheightoffset''' || || || || || || || ✔ || || || ✔
|-
| getinv || || || || || || ✔ || || || ||
|-
| getinvworn || || || || || || ✔ || || || ||
|-
| getoutfit || || || || || || ✔ || || || ||
|-
| '''getoutfitnames''' || || || || || || ✔ || || || ✔ ||
|-
| getpath || || || || || || ✔ || || || ||
|-
| getpathnew || || || || || || ✔ || || || ||
|-
| '''getremattachnames''' || || || || || || ✔ || || || ✔ ||
|-
| '''getremoutfitnames''' || || || || || || ✔ || || || ✔ ||
|-
| getsitid || || || || || || ✔ || || || ||
|-
| getstatus || || || || || || ✔ || || || ||
|-
| getstatusall || || || || || || ✔ || || || ||
|-
| interact || || ✔ || || || || || || || || ✔
|-
| '''jump''' || || ✔ || || || || || || || ||
|-
| notify || || || ✔ || || || ✔ || || || ||
|-
| '''pay''' || || ✔ || || || || || || || ||
|-
| permissive || || ✔ || || || || || || || ||
|-
| recvchat || || ✔ || || ✔ || ✔ || || || || ||
|-
| recvchatfrom || || || || ✔ || ✔ || || || || ||
|-
| recvemote || || ✔ || || ✔ || ✔ || || || || ||
|-
| recvemotefrom || || || || ✔ || ✔ || || || || ||
|-
| recvim || '''RecvIM Distance (Min), RecvIM Distance (Max)''' || || || ✔ || || || || || ||
|-
| recvimfrom || || || || ✔ || ✔ || || || || ||
|-
| redirchat || || || ✔ || || || ✔ || || || ||
|-
| rediremote || || || ✔ || || || ✔ || || || ||
|-
| remattach || || ✔ || || || || || || || ||
|-
| remattach || || || || || || || || ✔ || ||
|-
| remoutfit || || || ✔ || || || ✔ || || || ||
|-
| remoutfit || || || || || || || || ✔ || ||
|-
| rez || || ✔ || || || || || || || ||
|-
| sendchannel || || || || ✔ || || || || || ||
|-
| sendchannel_except || || || || ✔ || || || || || ✔ ||
|-
| sendchat || || ✔ || || || || || || || ||
|-
| sendgesture || || ✔ || || || || || || || ✔ ||
|-
| sendim || '''SendIM Distance (Min), SendIM Distance (Max)''' || || || ✔ || || || || || ||
|-
| sendimto || || || || ✔ || ✔ || || || || ||
|-
| setcam || || ✔ || || || || || || || ||
|-
| setcam_avdist || Camera - Silhouette Distance || || || || || || || || ||
|-
| setcam_avdistmax || Camera - Avatar Distance (Max) || || || || || || || || ✔ ||
|-
| setcam_avdistmin || Camera - Avatar Distance (Min) || || || || || || || || ✔ ||
|-
| '''setcam_eyeoffset''' || Camera - Eye Offset || ✔ || || || || || || || ||
|-
| '''setcam_eyeoffset''' || || || || || || || || ✔ || ||
|-
| '''setcam_eyeoffsetscale''' || Camera - Eye Offset Scale || || || || || || || || ||
|-
| '''setcam_eyeoffsetscale''' || || ✔ || || || || || || ✔ || ||
|-
| '''setcam_focus''' || || ✔ || || || || || || ✔ || ✔ ||
|-
| '''setcam_focusoffset''' || Camera - Focus Offset || || || || || || || || ||
|-
| '''setcam_focusoffset''' || || ✔ || || || || || || ✔ || ||
|-
| setcam_fov || || ✔ || || || || || || ✔ || ✔ ||
|-
| setcam_fovmax || Camera - FOV (Max) || ✔ || || || || || || || ||
|-
| setcam_fovmin || Camera - FOV (Min) || ✔ || || || || || || || ||
|-
| '''setcam_mode''' || || ✔ || || || || || || ✔ || ✔ ||
|-
| '''setcam_mouselook''' || || ✔ || || || || || || || ||
|-
| '''setcam_origindistmax''' || Camera - Focus Distance (Max) || || || || || || || || ✔ ||
|-
| '''setcam_origindistmin''' || Camera - Focus Distance (Min) || || || || || || || || ✔ ||
|-
| setcam_textures || Camera - Forced Texture || ✔ || || || || || || || ||
|-
| setcam_unlock || || ✔ || || || || || || || ||
|-
| setdebug || || ✔ || || || || || || || ||
|-
| setenv || || ✔ || || || || || || || ||
|-
| setgroup || || ✔ || || || || || || || ||
|-
| setgroup || || || || || || || || ✔ || ||
|-
| '''setoverlay''' || || || ✔ || || || || || || ||
|-
| '''setoverlay_alpha''' || || || || || || || || ✔ || ||
|-
| '''setoverlay_texture''' || || || || || || || || ✔ || ||
|-
| '''setoverlay_tint''' || || || || || || || || ✔ || ||
|-
| '''setoverlay_touch''' || || || || || || || || ✔ || ||
|-
| '''setoverlay_tween''' || || ✔ || || || || || || ✔ || ||
|-
| '''setsphere''' || || || ✔ || || || || || || ||
|-
| '''setsphere_color''' || || || || || || || || ✔ || ||
|-
| '''setsphere_distextend''' || || || || || || || || ✔ || ||
|-
| '''setsphere_distmax''' || || || || || || || || ✔ || ||
|-
| '''setsphere_distmin''' || || || || || || || || ✔ || ||
|-
| '''setsphere_mode''' || || || || || || || || ✔ || ||
|-
| '''setsphere_origin''' || || || || || || || || ✔ || ||
|-
| '''setsphere_param''' || || || || || || || || ✔ || ||
|-
| '''setsphere_tween''' || || || || || || || || ✔ || ||
|-
| '''setsphere_valuemax''' || || || || || || || || ✔ || ||
|-
| '''setsphere_valuemin''' || || || || || || || || ✔ || ||
|-
| share || || ✔ || || ✔ || ✔ || || || || ||
|-
| sharedunwear || || || ✔ || || || ✔ || || || || ✔
|-
| sharedwear || || || ✔ || || || ✔ || || || || ✔
|-
| showhovertext || || || || || || || || || ||
|-
| showhovertextall || || ✔ || || || || || || || ||
|-
| showhovertexthud || || ✔ || || || || || || || ||
|-
| showhovertextworld || || ✔ || || || || || || || ||
|-
| showinv || || ✔ || || || || || || || ||
|-
| showloc || || ✔ || || || || || || || ||
|-
| showminimap || || ✔ || || || || || || || ||
|-
| shownames || || || || ✔ || || || || || ||
|-
| shownametags || Name Tags - Visible Distance || || || ✔ || || || || || ||
|-
| shownearby || || ✔ || || || || || || || ✔ ||
|-
| showself || || ✔ || || || || || || || ✔ ||
|-
| showselfhead || || ✔ || || || || || || || ✔ ||
|-
| showworldmap || || ✔ || || || || || || || ||
|-
| sit || || ✔ || || || || || || || ||
|-
| sit || || ✔ || || || || || || ✔ || ||
|-
| sitground || || ✔ || || || || || || ✔ || ||
|-
| sittp || SitTp Distance || ✔ || || || || || || || ||
|-
| standtp || || ✔ || || || || || || || ||
|-
| startim || StartIM Distance (Min), StartIM Distance (Max) || || || ✔ || || || || || ||
|-
| startimto || || || || ✔ || ✔ || || || || ||
|-
| temprun || || ✔ || || || || || || || ||
|-
| touchall || || ✔ || || || || || || || ||
|-
| touchattach || || ✔ || || || ✔ || || || || ||
|-
| touchattachother || || ✔ || || || ✔ || || || || ||
|-
| touchattachself || || ✔ || || || || || || || ||
|-
| touchfar || || ✔ || || || || || || || ||
|-
| touchhud || || ✔ || || || ✔ || || || || || ✔
|-
| touchme || || ✔ || || || || || || || ||
|-
| touchthis || || || || || ✔ || || || || ||
|-
| touchworld || || ✔ || || || ✔ || || || || ||
|-
| tplm || || ✔ || || || || || || || ||
|-
| tploc || || ✔ || || || || || || || ||
|-
| tplocal || Local Teleport Distance || ✔ || || || || || || || ✔ ||
|-
| tplure || || ✔ || || ✔ || ✔ || || || || ||
|-
| tprequest || || ✔ || || ✔ || ✔ || || || || || ✔
|-
| tpto || || ✔ || || || || || || ✔ || ||
|-
| unsharedunwear || || || ✔ || || || ✔ || || || ||
|-
| unsharedwear || || || ✔ || || || ✔ || || || ||
|-
| unsit || || ✔ || || || || || || || ||
|-
| unsit || || ✔ || || || || || || ✔ || ||
|-
| version || || || || || || ✔ || || || ||
|-
| versionnew || || || || || || ✔ || || || ||
|-
| versionnum || || || || || || ✔ || || || ||
|-
| viewnote || || ✔ || || || || || || || ||
|-
| viewscript || || ✔ || || || || || || || ||
|-
| viewtexture || || ✔ || || || || || || || ||
|-
| '''viewtransparent''' || || ✔ || || || || || || || ✔ ||
|-
| '''viewwireframe''' || || ✔ || || || || || || || ✔ ||
|-
|}

User:Rhet0rica Resident/RLVa Protocol

2024-07-25T10:21:46Z

Rhet0rica Resident: formatting

There are two implementations of the RLV protocol: Marine Kelley's RLV codebase and Kitty Barnett's RLVa codebase. As of this writing, RLV is used by RestrainedLove, Cool VL Viewer, and Kokua; RLVa is used by Catznip, Alchemy, Black Dragon, Firestorm, Genesis, and Singularity.

Naturally, whenever there are two or more implementations of anything, there are differences between the two. The main [[LSL_Protocol/RestrainedLoveAPI|RLV documentation]] on this wiki has been around for a long time and is primarily maintained by [[User:Marine Kelley|Marine Kelley]], the creator of the RLV ecosystem. While an invaluable resource for scripters targeting Marine's viewer and its progeny, it makes little mention of RLVa-specific features. This is ''mostly'' a good thing, as it encourages scripters to focus only on what has universal support, but at the same time there has been a dearth of information around RLVa, and what has been available [https://wiki.catznip.com/index.php?title=Category:RLVa|at the Catznip Wiki] is somewhat incomplete.

The purpose of this page is to document the RLV protocol from an RLVa-centric perspective, both for my own reference and that of others.

<div class="messagebox">This page describes '''RLVa 2.4.2.74783'''.</div>

{| class="wikitable" style="margin: auto"
|-
! style="position: sticky;"| Behavior
! style="position: sticky;"| Modifiers
! style="position: sticky;"| y/n
! style="position: sticky;"| add/rem
! style="position: sticky;"| _sec
! style="position: sticky;"| exception (y/n)
! style="position: sticky;"| info
! style="position: sticky;"| ReplyProcessor
! style="position: sticky;"| force
! style="position: sticky;"| experimental
! style="position: sticky;"| extended
|-
| acceptpermission || || ✔ || || || || || || || ||
|-
| accepttp || || ✔ || || ✔ || ✔ || || || || ||
|-
| accepttprequest || || ✔ || || ✔ || ✔ || || || || || ✔
|-
| addattach || || || || || || || || || ||
|-
| addoutfit || || || ✔ || || || ✔ || || || ||
|-
| addoutfit || || || || || || || || ✔ || ||
|-
| addoutfitall || || || || || || || || ✔ || ||
|-
| addoutfitallover || || || || || || || || ✔ || ||
|-
| addoutfitallthis || || || || || || || || ✔ || ||
|-
| addoutfitallthisover || || || || || || || || ✔ || ||
|-
| addoutfitover || || || || || || || || ✔ || ||
|-
| addoutfitthis || || || || || || || || ✔ || ||
|-
| addoutfitthisover || || || || || || || || ✔ || ||
|-
| adjustheight || || || || || || || || ✔ || ||
|-
| allowidle || || ✔ || || || || || || || ✔ ||
|-
| alwaysrun || || ✔ || || || || || || || ||
|-
| attach || || || || || || ✔ || || || ||
|-
| attachall || || || || || || ✔ || || || ||
|-
| attachallover || || || || || || ✔ || || || ||
|-
| attachalloverorreplace || || || || || || || || ✔ || ||
|-
| attachallthis || || || ✔ || || || ✔ || || || ||
|-
| attachallthis || || || || || || ✔ || || ✔ || ||
|-
| attachallthis_except || || || ✔ || || || ✔ || || || ||
|-
| attachallthisover || || || || || || ✔ || || ✔ || ||
|-
| attachallthisoverorreplace || || || || || || || || ✔ || ||
|-
| attachover || || || || || || ✔ || || ✔ || ||
|-
| attachoverorreplace || || || || || || || || ✔ || ||
|-
| attachthis || || || ✔ || || || ✔ || || || ||
|-
| attachthis || || || || || || ✔ || || ✔ || ||
|-
| attachthis_except || || || ✔ || || || ✔ || || || ||
|-
| attachthisover || || || || || || ✔ || || || ||
|-
| attachthisoverorreplace || || || || || || || || ✔ || ||
|-
| buy || || ✔ || || || || || || || ||
|-
| camavdist || || || || || || || || || ||
|-
| camdistmax || || || || || || || || || ||
|-
| camdistmin || || || || || || || || || ||
|-
| camtextures || || ✔ || || || || || || || ||
|-
| camunlock || || ✔ || || || || || || || ||
|-
| camzoommax || || || || || || || || || ||
|-
| camzoommin || || || || || || || || || ||
|-
| chatnormal || || ✔ || || || || || || || ||
|-
| chatshout || || ✔ || || || || || || || ||
|-
| chatwhisper || || ✔ || || || || || || || ||
|-
| detach || || ✔ || || || || || || || ||
|-
| detach || || || || || || || || ✔ || ||
|-
| detachall || || || || || || ✔ || || || ||
|-
| detachallthis || || || ✔ || || || ✔ || || || ||
|-
| detachallthis || || || || || || ✔ || || || ||
|-
| detachallthis_except || || || ✔ || || || ✔ || || || ||
|-
| detachme || || || || || || || || ✔ || ||
|-
| detachthis || || || ✔ || || || ✔ || || || ||
|-
| detachthis || || || || || || ✔ || || || ||
|-
| detachthis_except || || || ✔ || || || ✔ || || || ||
|-
| edit || || ✔ || || || ✔ || || || || ||
|-
| editattach || || ✔ || || || || || || || ||
|-
| editobj || || || || || ✔ || || || || ||
|-
| editworld || || ✔ || || || || || || || ||
|-
| emote || || ✔ || || || || || || || ||
|-
| fartouch || Fartouch Distance || ✔ || || || || || || || ||
|-
| findfolder || || || || || || ✔ || || || ||
|-
| findfolders || || || || || || ✔ || || || || ✔
|-
| fly || || ✔ || || || || || || || ||
|-
| fly || || || || || || || || ✔ || ||
|-
| getaddattachnames || || || || || || ✔ || || || ✔ ||
|-
| getaddoutfitnames || || || || || || ✔ || || || ✔ ||
|-
| getattach || || || || || || ✔ || || || ||
|-
| getattachnames || || || || || || ✔ || || || ✔ ||
|-
| getcam_avdist || || || || || || || ✔ || || ✔ ||
|-
| getcam_avdistmax || || || || || || || ✔ || || ✔ ||
|-
| getcam_avdistmin || || || || || || || ✔ || || ✔ ||
|-
| getcam_fov || || || || || || || ✔ || || ✔ ||
|-
| getcam_fovmax || || || || || || || ✔ || || ✔ ||
|-
| getcam_fovmin || || || || || || || ✔ || || ✔ ||
|-
| getcam_textures || || || || || || || ✔ || || ✔ ||
|-
| getcommand || || || || || || || ✔ || || || ✔
|-
| getgroup || || || || || || ✔ || || || ||
|-
| getheightoffset || || || || || || || ✔ || || || ✔
|-
| getinv || || || || || || ✔ || || || ||
|-
| getinvworn || || || || || || ✔ || || || ||
|-
| getoutfit || || || || || || ✔ || || || ||
|-
| getoutfitnames || || || || || || ✔ || || || ✔ ||
|-
| getpath || || || || || || ✔ || || || ||
|-
| getpathnew || || || || || || ✔ || || || ||
|-
| getremattachnames || || || || || || ✔ || || || ✔ ||
|-
| getremoutfitnames || || || || || || ✔ || || || ✔ ||
|-
| getsitid || || || || || || ✔ || || || ||
|-
| getstatus || || || || || || ✔ || || || ||
|-
| getstatusall || || || || || || ✔ || || || ||
|-
| interact || || ✔ || || || || || || || || ✔
|-
| jump || || ✔ || || || || || || || ||
|-
| notify || || || ✔ || || || ✔ || || || ||
|-
| pay || || ✔ || || || || || || || ||
|-
| permissive || || ✔ || || || || || || || ||
|-
| recvchat || || ✔ || || ✔ || ✔ || || || || ||
|-
| recvchatfrom || || || || ✔ || ✔ || || || || ||
|-
| recvemote || || ✔ || || ✔ || ✔ || || || || ||
|-
| recvemotefrom || || || || ✔ || ✔ || || || || ||
|-
| recvim || RecvIM Distance (Min), RecvIM Distance (Max) || || || ✔ || || || || || ||
|-
| recvimfrom || || || || ✔ || ✔ || || || || ||
|-
| redirchat || || || ✔ || || || ✔ || || || ||
|-
| rediremote || || || ✔ || || || ✔ || || || ||
|-
| remattach || || ✔ || || || || || || || ||
|-
| remattach || || || || || || || || ✔ || ||
|-
| remoutfit || || || ✔ || || || ✔ || || || ||
|-
| remoutfit || || || || || || || || ✔ || ||
|-
| rez || || ✔ || || || || || || || ||
|-
| sendchannel || || || || ✔ || || || || || ||
|-
| sendchannel_except || || || || ✔ || || || || || ✔ ||
|-
| sendchat || || ✔ || || || || || || || ||
|-
| sendgesture || || ✔ || || || || || || || ✔ ||
|-
| sendim || SendIM Distance (Min), SendIM Distance (Max) || || || ✔ || || || || || ||
|-
| sendimto || || || || ✔ || ✔ || || || || ||
|-
| setcam || || ✔ || || || || || || || ||
|-
| setcam_avdist || Camera - Silhouette Distance || || || || || || || || ||
|-
| setcam_avdistmax || Camera - Avatar Distance (Max) || || || || || || || || ✔ ||
|-
| setcam_avdistmin || Camera - Avatar Distance (Min) || || || || || || || || ✔ ||
|-
| setcam_eyeoffset || Camera - Eye Offset || ✔ || || || || || || || ||
|-
| setcam_eyeoffset || || || || || || || || ✔ || ||
|-
| setcam_eyeoffsetscale || Camera - Eye Offset Scale || || || || || || || || ||
|-
| setcam_eyeoffsetscale || || ✔ || || || || || || ✔ || ||
|-
| setcam_focus || || ✔ || || || || || || ✔ || ✔ ||
|-
| setcam_focusoffset || Camera - Focus Offset || || || || || || || || ||
|-
| setcam_focusoffset || || ✔ || || || || || || ✔ || ||
|-
| setcam_fov || || ✔ || || || || || || ✔ || ✔ ||
|-
| setcam_fovmax || Camera - FOV (Max) || ✔ || || || || || || || ||
|-
| setcam_fovmin || Camera - FOV (Min) || ✔ || || || || || || || ||
|-
| setcam_mode || || ✔ || || || || || || ✔ || ✔ ||
|-
| setcam_mouselook || || ✔ || || || || || || || ||
|-
| setcam_origindistmax || Camera - Focus Distance (Max) || || || || || || || || ✔ ||
|-
| setcam_origindistmin || Camera - Focus Distance (Min) || || || || || || || || ✔ ||
|-
| setcam_textures || Camera - Forced Texture || ✔ || || || || || || || ||
|-
| setcam_unlock || || ✔ || || || || || || || ||
|-
| setdebug || || ✔ || || || || || || || ||
|-
| setenv || || ✔ || || || || || || || ||
|-
| setgroup || || ✔ || || || || || || || ||
|-
| setgroup || || || || || || || || ✔ || ||
|-
| setoverlay || || || ✔ || || || || || || ||
|-
| setoverlay_alpha || || || || || || || || ✔ || ||
|-
| setoverlay_texture || || || || || || || || ✔ || ||
|-
| setoverlay_tint || || || || || || || || ✔ || ||
|-
| setoverlay_touch || || || || || || || || ✔ || ||
|-
| setoverlay_tween || || ✔ || || || || || || ✔ || ||
|-
| setsphere || || || ✔ || || || || || || ||
|-
| setsphere_color || || || || || || || || ✔ || ||
|-
| setsphere_distextend || || || || || || || || ✔ || ||
|-
| setsphere_distmax || || || || || || || || ✔ || ||
|-
| setsphere_distmin || || || || || || || || ✔ || ||
|-
| setsphere_mode || || || || || || || || ✔ || ||
|-
| setsphere_origin || || || || || || || || ✔ || ||
|-
| setsphere_param || || || || || || || || ✔ || ||
|-
| setsphere_tween || || || || || || || || ✔ || ||
|-
| setsphere_valuemax || || || || || || || || ✔ || ||
|-
| setsphere_valuemin || || || || || || || || ✔ || ||
|-
| share || || ✔ || || ✔ || ✔ || || || || ||
|-
| sharedunwear || || || ✔ || || || ✔ || || || || ✔
|-
| sharedwear || || || ✔ || || || ✔ || || || || ✔
|-
| showhovertext || || || || || || || || || ||
|-
| showhovertextall || || ✔ || || || || || || || ||
|-
| showhovertexthud || || ✔ || || || || || || || ||
|-
| showhovertextworld || || ✔ || || || || || || || ||
|-
| showinv || || ✔ || || || || || || || ||
|-
| showloc || || ✔ || || || || || || || ||
|-
| showminimap || || ✔ || || || || || || || ||
|-
| shownames || || || || ✔ || || || || || ||
|-
| shownametags || Name Tags - Visible Distance || || || ✔ || || || || || ||
|-
| shownearby || || ✔ || || || || || || || ✔ ||
|-
| showself || || ✔ || || || || || || || ✔ ||
|-
| showselfhead || || ✔ || || || || || || || ✔ ||
|-
| showworldmap || || ✔ || || || || || || || ||
|-
| sit || || ✔ || || || || || || || ||
|-
| sit || || ✔ || || || || || || ✔ || ||
|-
| sitground || || ✔ || || || || || || ✔ || ||
|-
| sittp || SitTp Distance || ✔ || || || || || || || ||
|-
| standtp || || ✔ || || || || || || || ||
|-
| startim || StartIM Distance (Min), StartIM Distance (Max) || || || ✔ || || || || || ||
|-
| startimto || || || || ✔ || ✔ || || || || ||
|-
| temprun || || ✔ || || || || || || || ||
|-
| touchall || || ✔ || || || || || || || ||
|-
| touchattach || || ✔ || || || ✔ || || || || ||
|-
| touchattachother || || ✔ || || || ✔ || || || || ||
|-
| touchattachself || || ✔ || || || || || || || ||
|-
| touchfar || || ✔ || || || || || || || ||
|-
| touchhud || || ✔ || || || ✔ || || || || || ✔
|-
| touchme || || ✔ || || || || || || || ||
|-
| touchthis || || || || || ✔ || || || || ||
|-
| touchworld || || ✔ || || || ✔ || || || || ||
|-
| tplm || || ✔ || || || || || || || ||
|-
| tploc || || ✔ || || || || || || || ||
|-
| tplocal || Local Teleport Distance || ✔ || || || || || || || ✔ ||
|-
| tplure || || ✔ || || ✔ || ✔ || || || || ||
|-
| tprequest || || ✔ || || ✔ || ✔ || || || || || ✔
|-
| tpto || || ✔ || || || || || || ✔ || ||
|-
| unsharedunwear || || || ✔ || || || ✔ || || || ||
|-
| unsharedwear || || || ✔ || || || ✔ || || || ||
|-
| unsit || || ✔ || || || || || || || ||
|-
| unsit || || ✔ || || || || || || ✔ || ||
|-
| version || || || || || || ✔ || || || ||
|-
| versionnew || || || || || || ✔ || || || ||
|-
| versionnum || || || || || || ✔ || || || ||
|-
| viewnote || || ✔ || || || || || || || ||
|-
| viewscript || || ✔ || || || || || || || ||
|-
| viewtexture || || ✔ || || || || || || || ||
|-
| viewtransparent || || ✔ || || || || || || || ✔ ||
|-
| viewwireframe || || ✔ || || || || || || || ✔ ||
|-
|}

User:Rhet0rica Resident/RLVa Protocol

2024-07-25T07:21:09Z

Rhet0rica Resident: initial draft of RLVa behavio(u)r data table

There are two implementations of the RLV protocol: Marine Kelley's RLV codebase and Kitty Barnett's RLVa codebase. As of this writing, RLV is used by RestrainedLove, Cool VL Viewer, and Kokua; RLVa is used by Catznip, Alchemy, Black Dragon, Firestorm, Genesis, and Singularity.

Naturally, whenever there are two or more implementations of anything, there are differences between the two. The main [[LSL_Protocol/RestrainedLoveAPI|RLV documentation]] on this wiki has been around for a long time and is primarily maintained by [[User:Marine Kelley|Marine Kelley]], the creator of the RLV ecosystem. While an invaluable resource for scripters targeting Marine's viewer and its progeny, it makes little mention of RLVa-specific features. This is ''mostly'' a good thing, as it encourages scripters to focus only on what has universal support, but at the same time there has been a dearth of information around RLVa, and what has been available [https://wiki.catznip.com/index.php?title=Category:RLVa|at the Catznip Wiki] is somewhat incomplete.

The purpose of this page is to document the RLV protocol from an RLVa-centric perspective, both for my own reference and that of others.

<div class="messagebox">This page describes '''RLVa 2.4.2.74783'''.</div>

{| class="wikitable" style="margin: auto"
|-
! Behavior !! Modifiers !! y/n !! add/rem !! _sec !! exception y/n !! info !! ReplyProcessor !! force !! experimental !! extended
|-
| acceptpermission || || ✔ || || || || || || || ||
|-
| accepttp || || ✔ || || ✔ || ✔ || || || || ||
|-
| accepttprequest || || ✔ || || ✔ || ✔ || || || || || ✔
|-
| addattach || || || || || || || || || ||
|-
| addoutfit || || || ✔ || || || ✔ || || || ||
|-
| addoutfit || || || || || || || || ✔ || ||
|-
| addoutfitall || || || || || || || || ✔ || ||
|-
| addoutfitallover || || || || || || || || ✔ || ||
|-
| addoutfitallthis || || || || || || || || ✔ || ||
|-
| addoutfitallthisover || || || || || || || || ✔ || ||
|-
| addoutfitover || || || || || || || || ✔ || ||
|-
| addoutfitthis || || || || || || || || ✔ || ||
|-
| addoutfitthisover || || || || || || || || ✔ || ||
|-
| adjustheight || || || || || || || || ✔ || ||
|-
| allowidle || || ✔ || || || || || || || ✔ ||
|-
| alwaysrun || || ✔ || || || || || || || ||
|-
| attach || || || || || || ✔ || || || ||
|-
| attachall || || || || || || ✔ || || || ||
|-
| attachallover || || || || || || ✔ || || || ||
|-
| attachalloverorreplace || || || || || || || || ✔ || ||
|-
| attachallthis || || || ✔ || || || ✔ || || || ||
|-
| attachallthis || || || || || || ✔ || || ✔ || ||
|-
| attachallthis_except || || || ✔ || || || ✔ || || || ||
|-
| attachallthisover || || || || || || ✔ || || ✔ || ||
|-
| attachallthisoverorreplace || || || || || || || || ✔ || ||
|-
| attachover || || || || || || ✔ || || ✔ || ||
|-
| attachoverorreplace || || || || || || || || ✔ || ||
|-
| attachthis || || || ✔ || || || ✔ || || || ||
|-
| attachthis || || || || || || ✔ || || ✔ || ||
|-
| attachthis_except || || || ✔ || || || ✔ || || || ||
|-
| attachthisover || || || || || || ✔ || || || ||
|-
| attachthisoverorreplace || || || || || || || || ✔ || ||
|-
| buy || || ✔ || || || || || || || ||
|-
| camavdist || || || || || || || || || ||
|-
| camdistmax || || || || || || || || || ||
|-
| camdistmin || || || || || || || || || ||
|-
| camtextures || || ✔ || || || || || || || ||
|-
| camunlock || || ✔ || || || || || || || ||
|-
| camzoommax || || || || || || || || || ||
|-
| camzoommin || || || || || || || || || ||
|-
| chatnormal || || ✔ || || || || || || || ||
|-
| chatshout || || ✔ || || || || || || || ||
|-
| chatwhisper || || ✔ || || || || || || || ||
|-
| detach || || ✔ || || || || || || || ||
|-
| detach || || || || || || || || ✔ || ||
|-
| detachall || || || || || || ✔ || || || ||
|-
| detachallthis || || || ✔ || || || ✔ || || || ||
|-
| detachallthis || || || || || || ✔ || || || ||
|-
| detachallthis_except || || || ✔ || || || ✔ || || || ||
|-
| detachme || || || || || || || || ✔ || ||
|-
| detachthis || || || ✔ || || || ✔ || || || ||
|-
| detachthis || || || || || || ✔ || || || ||
|-
| detachthis_except || || || ✔ || || || ✔ || || || ||
|-
| edit || || ✔ || || || ✔ || || || || ||
|-
| editattach || || ✔ || || || || || || || ||
|-
| editobj || || || || || ✔ || || || || ||
|-
| editworld || || ✔ || || || || || || || ||
|-
| emote || || ✔ || || || || || || || ||
|-
| fartouch || Fartouch Distance || ✔ || || || || || || || ||
|-
| findfolder || || || || || || ✔ || || || ||
|-
| findfolders || || || || || || ✔ || || || || ✔
|-
| fly || || ✔ || || || || || || || ||
|-
| fly || || || || || || || || ✔ || ||
|-
| getaddattachnames || || || || || || ✔ || || || ✔ ||
|-
| getaddoutfitnames || || || || || || ✔ || || || ✔ ||
|-
| getattach || || || || || || ✔ || || || ||
|-
| getattachnames || || || || || || ✔ || || || ✔ ||
|-
| getcam_avdist || || || || || || || ✔ || || ✔ ||
|-
| getcam_avdistmax || || || || || || || ✔ || || ✔ ||
|-
| getcam_avdistmin || || || || || || || ✔ || || ✔ ||
|-
| getcam_fov || || || || || || || ✔ || || ✔ ||
|-
| getcam_fovmax || || || || || || || ✔ || || ✔ ||
|-
| getcam_fovmin || || || || || || || ✔ || || ✔ ||
|-
| getcam_textures || || || || || || || ✔ || || ✔ ||
|-
| getcommand || || || || || || || ✔ || || || ✔
|-
| getgroup || || || || || || ✔ || || || ||
|-
| getheightoffset || || || || || || || ✔ || || || ✔
|-
| getinv || || || || || || ✔ || || || ||
|-
| getinvworn || || || || || || ✔ || || || ||
|-
| getoutfit || || || || || || ✔ || || || ||
|-
| getoutfitnames || || || || || || ✔ || || || ✔ ||
|-
| getpath || || || || || || ✔ || || || ||
|-
| getpathnew || || || || || || ✔ || || || ||
|-
| getremattachnames || || || || || || ✔ || || || ✔ ||
|-
| getremoutfitnames || || || || || || ✔ || || || ✔ ||
|-
| getsitid || || || || || || ✔ || || || ||
|-
| getstatus || || || || || || ✔ || || || ||
|-
| getstatusall || || || || || || ✔ || || || ||
|-
| interact || || ✔ || || || || || || || || ✔
|-
| jump || || ✔ || || || || || || || ||
|-
| notify || || || ✔ || || || ✔ || || || ||
|-
| pay || || ✔ || || || || || || || ||
|-
| permissive || || ✔ || || || || || || || ||
|-
| recvchat || || ✔ || || ✔ || ✔ || || || || ||
|-
| recvchatfrom || || || || ✔ || ✔ || || || || ||
|-
| recvemote || || ✔ || || ✔ || ✔ || || || || ||
|-
| recvemotefrom || || || || ✔ || ✔ || || || || ||
|-
| recvim || RecvIM Distance (Min), RecvIM Distance (Max) || || || ✔ || || || || || ||
|-
| recvimfrom || || || || ✔ || ✔ || || || || ||
|-
| redirchat || || || ✔ || || || ✔ || || || ||
|-
| rediremote || || || ✔ || || || ✔ || || || ||
|-
| remattach || || ✔ || || || || || || || ||
|-
| remattach || || || || || || || || ✔ || ||
|-
| remoutfit || || || ✔ || || || ✔ || || || ||
|-
| remoutfit || || || || || || || || ✔ || ||
|-
| rez || || ✔ || || || || || || || ||
|-
| sendchannel || || || || ✔ || || || || || ||
|-
| sendchannel_except || || || || ✔ || || || || || ✔ ||
|-
| sendchat || || ✔ || || || || || || || ||
|-
| sendgesture || || ✔ || || || || || || || ✔ ||
|-
| sendim || SendIM Distance (Min), SendIM Distance (Max) || || || ✔ || || || || || ||
|-
| sendimto || || || || ✔ || ✔ || || || || ||
|-
| setcam || || ✔ || || || || || || || ||
|-
| setcam_avdist || Camera - Silhouette Distance || || || || || || || || ||
|-
| setcam_avdistmax || Camera - Avatar Distance (Max) || || || || || || || || ✔ ||
|-
| setcam_avdistmin || Camera - Avatar Distance (Min) || || || || || || || || ✔ ||
|-
| setcam_eyeoffset || Camera - Eye Offset || ✔ || || || || || || || ||
|-
| setcam_eyeoffset || || || || || || || || ✔ || ||
|-
| setcam_eyeoffsetscale || Camera - Eye Offset Scale || || || || || || || || ||
|-
| setcam_eyeoffsetscale || || ✔ || || || || || || ✔ || ||
|-
| setcam_focus || || ✔ || || || || || || ✔ || ✔ ||
|-
| setcam_focusoffset || Camera - Focus Offset || || || || || || || || ||
|-
| setcam_focusoffset || || ✔ || || || || || || ✔ || ||
|-
| setcam_fov || || ✔ || || || || || || ✔ || ✔ ||
|-
| setcam_fovmax || Camera - FOV (Max) || ✔ || || || || || || || ||
|-
| setcam_fovmin || Camera - FOV (Min) || ✔ || || || || || || || ||
|-
| setcam_mode || || ✔ || || || || || || ✔ || ✔ ||
|-
| setcam_mouselook || || ✔ || || || || || || || ||
|-
| setcam_origindistmax || Camera - Focus Distance (Max) || || || || || || || || ✔ ||
|-
| setcam_origindistmin || Camera - Focus Distance (Min) || || || || || || || || ✔ ||
|-
| setcam_textures || Camera - Forced Texture || ✔ || || || || || || || ||
|-
| setcam_unlock || || ✔ || || || || || || || ||
|-
| setdebug || || ✔ || || || || || || || ||
|-
| setenv || || ✔ || || || || || || || ||
|-
| setgroup || || ✔ || || || || || || || ||
|-
| setgroup || || || || || || || || ✔ || ||
|-
| setoverlay || || || ✔ || || || || || || ||
|-
| setoverlay_alpha || || || || || || || || ✔ || ||
|-
| setoverlay_texture || || || || || || || || ✔ || ||
|-
| setoverlay_tint || || || || || || || || ✔ || ||
|-
| setoverlay_touch || || || || || || || || ✔ || ||
|-
| setoverlay_tween || || ✔ || || || || || || ✔ || ||
|-
| setsphere || || || ✔ || || || || || || ||
|-
| setsphere_color || || || || || || || || ✔ || ||
|-
| setsphere_distextend || || || || || || || || ✔ || ||
|-
| setsphere_distmax || || || || || || || || ✔ || ||
|-
| setsphere_distmin || || || || || || || || ✔ || ||
|-
| setsphere_mode || || || || || || || || ✔ || ||
|-
| setsphere_origin || || || || || || || || ✔ || ||
|-
| setsphere_param || || || || || || || || ✔ || ||
|-
| setsphere_tween || || || || || || || || ✔ || ||
|-
| setsphere_valuemax || || || || || || || || ✔ || ||
|-
| setsphere_valuemin || || || || || || || || ✔ || ||
|-
| share || || ✔ || || ✔ || ✔ || || || || ||
|-
| sharedunwear || || || ✔ || || || ✔ || || || || ✔
|-
| sharedwear || || || ✔ || || || ✔ || || || || ✔
|-
| showhovertext || || || || || || || || || ||
|-
| showhovertextall || || ✔ || || || || || || || ||
|-
| showhovertexthud || || ✔ || || || || || || || ||
|-
| showhovertextworld || || ✔ || || || || || || || ||
|-
| showinv || || ✔ || || || || || || || ||
|-
| showloc || || ✔ || || || || || || || ||
|-
| showminimap || || ✔ || || || || || || || ||
|-
| shownames || || || || ✔ || || || || || ||
|-
| shownametags || Name Tags - Visible Distance || || || ✔ || || || || || ||
|-
| shownearby || || ✔ || || || || || || || ✔ ||
|-
| showself || || ✔ || || || || || || || ✔ ||
|-
| showselfhead || || ✔ || || || || || || || ✔ ||
|-
| showworldmap || || ✔ || || || || || || || ||
|-
| sit || || ✔ || || || || || || || ||
|-
| sit || || ✔ || || || || || || ✔ || ||
|-
| sitground || || ✔ || || || || || || ✔ || ||
|-
| sittp || SitTp Distance || ✔ || || || || || || || ||
|-
| standtp || || ✔ || || || || || || || ||
|-
| startim || StartIM Distance (Min), StartIM Distance (Max) || || || ✔ || || || || || ||
|-
| startimto || || || || ✔ || ✔ || || || || ||
|-
| temprun || || ✔ || || || || || || || ||
|-
| touchall || || ✔ || || || || || || || ||
|-
| touchattach || || ✔ || || || ✔ || || || || ||
|-
| touchattachother || || ✔ || || || ✔ || || || || ||
|-
| touchattachself || || ✔ || || || || || || || ||
|-
| touchfar || || ✔ || || || || || || || ||
|-
| touchhud || || ✔ || || || ✔ || || || || || ✔
|-
| touchme || || ✔ || || || || || || || ||
|-
| touchthis || || || || || ✔ || || || || ||
|-
| touchworld || || ✔ || || || ✔ || || || || ||
|-
| tplm || || ✔ || || || || || || || ||
|-
| tploc || || ✔ || || || || || || || ||
|-
| tplocal || Local Teleport Distance || ✔ || || || || || || || ✔ ||
|-
| tplure || || ✔ || || ✔ || ✔ || || || || ||
|-
| tprequest || || ✔ || || ✔ || ✔ || || || || || ✔
|-
| tpto || || ✔ || || || || || || ✔ || ||
|-
| unsharedunwear || || || ✔ || || || ✔ || || || ||
|-
| unsharedwear || || || ✔ || || || ✔ || || || ||
|-
| unsit || || ✔ || || || || || || || ||
|-
| unsit || || ✔ || || || || || || ✔ || ||
|-
| version || || || || || || ✔ || || || ||
|-
| versionnew || || || || || || ✔ || || || ||
|-
| versionnum || || || || || || ✔ || || || ||
|-
| viewnote || || ✔ || || || || || || || ||
|-
| viewscript || || ✔ || || || || || || || ||
|-
| viewtexture || || ✔ || || || || || || || ||
|-
| viewtransparent || || ✔ || || || || || || || ✔ ||
|-
| viewwireframe || || ✔ || || || || || || || ✔ ||
|-
|}

Talk:LlGetNotecardLineSync

2024-07-23T07:10:26Z

Rhet0rica Resident:

== Some explanations are in order, I think... ==

I understand that there is (now?) some sort of caching mechanism being employed locally at the region's simulator, which ought to speed up reading notecards (and re-reading them!) quite considerably.

As far as I can understand, the purpose of this function is merely to read the ''whole'' notecard in a tight loop inside a single [[dataserver]] event, as opposed to continually polling the database server for each line at the time?...

If so, that should be made a bit more explicit, because, from the perspective of someone not intrinsically familiar with how the SL Grid operates, the difference between both approaches is not instantly obvious (I had to re-read this article several times until it finally ''clicked'').

It is a further step towards the full implementation of [http://opensimulator.org/wiki/OsGetNotecard the OpenSimulator equivalent that reads the entire notecard in a single call], bypassing database server events entirely. The option to have ''one'' dataserver event (as opposed to ''none'', as in OpenSimulator) is probably just to allow the actual notecard reading to be run in parallel (a different thread?) without blocking, thus allowing the object to continue to be responding interactively while it's simultaneously loading a ''huge'' notecard. That approach might make more sense if it cannot be predicted if a notecard is already on the simulator's cache or not (and, if not, it requires loading it first from the central asset servers).

But I'm just speculating. I did ''not'' read anything about the origin and/or proposal of this new function (because I'm lazy and didn't bothered to search for it); my point here is just that I believe that ''some'' additional explanations about this function are required, and how it relates to the older [[LlGetNotecardLine]], and publishing some sort of comparative analysis regarding the difference between the two mechanisms, both in raw speed and impact on the simulator...

— [[User:Gwyneth Llewelyn|Gwyneth Llewelyn]] ([[User talk:Gwyneth Llewelyn|talk]]) 02:27, 17 January 2024 (PST)

:This is "dataserver-less" reading of notecards. The dataserver is still part of it, but you don't need to asynchronously loop through it anymore. Like with the old function, you can random-access a single line. Like with the old function, you can loop through the lines until you reach EOF. IF the notecard is known to the simulator, you get the single line right away. If the dataserver does NOT know the notecard, you get "NAK".

:So best practive would be to request the LAST line of a notecard via the old dataserver method, thus ensuring the notecard is cached in its entirety, and then enjoy datserver-less reading of any line you want to have.

:Best best pratice would be to check for NAK and have a fallback for every query you make: First the fast methid, and if it returns NAK, the dataserver method. The beauty with this new function is that we don't need the async approach anymore, and can random access a (cached) notecard.

:Reality these days is that modern scripts parse configuration data only once and store it to LSD - but this would go way faster even.

:[[User:Peter Stindberg|Peter Stindberg]] ([[User talk:Peter Stindberg|talk]]) 08:52, 17 January 2024 (PST)

::Reading any line of a notecard will cache the entire notecard into the buffer. In my testing, a single [[llGetNotecardLine]] call to the first line will consistently load the whole notecard, and any remaining lines can be read using [[llGetNotecardLineSync]] - although your suggested best practice is how I end up doing it (call [[llGetNotecardLineSync]], and if it returns [[NAK]], call [[llGetNotecardLine]]; repeat until [[EOF]]).

::edit: Also, considering this function can blow through your whole 64k of memory in a fraction of a second, I added a note about garbage collection and how to avoid a stack-heap collision; I don't expect a llGetTheWholeNotecardAtOnce function for obvious reasons, either.

::— [[User:Nelson Jenkins|Nelson Jenkins]] ([[User talk:Nelson Jenkins|talk]]) 17:56, 3 July 2024 (PDT)

Nelson, in my apps that use llGetNotecardLineSync(), I have yet to experience memory leaks anywhere near the level that you have eluded to.

Can you please file a bug report with a bare bones repro script at https://feedback.secondlife.com/scripting-bugs ? Thanks. Lucia Nightfire

I don't use the Talk portion of this wiki so I don't know how to reply to comments. Bear with me.

:I believe Nelson was referring to the thoughtless caching of llGetNotecardLineSync() return values in a string or list, not a memory leak. The salient observation is that its misuse can lead to memory exhaustion ''quickly,'' rather than through some new or unusual route.

:— [[User:Rhet0rica Resident|rhet0rica]] ([[User talk:Rhet0rica Resident|talk]]) 00:10, 23 July 2024 (PDT)

User:Rhet0rica Resident/glob match

2024-07-04T00:32:35Z

Rhet0rica Resident:

{{LSLC|User-Defined Functions}}
{{LSL_Function
|func=glob_match
|func_desc=Ported by [[User:Rhet0rica Resident|rhet0rica]] from [https://github.com/torvalds/linux/blob/master/lib/glob.c the Linux kernel], this function takes a pattern string and a query string as input and returns [[TRUE]] or [[FALSE]] depending on whether the query satisfies the pattern. This is the same method used by POSIX systems to match wildcards in filenames. License: Dual MIT and GPL 2.0. <syntaxhighlight lang="lsl">

/**
* glob_match - Shell-style pattern matching, like !fnmatch(pat, str, 0)
* @pat: Shell-style pattern to match, e.g. "*.[ch]".
* @str: String to match. The pattern must match the entire string.
*
* Perform shell-style glob matching, returning true (1) if the match
* succeeds, or false (0) if it fails. Equivalent to !fnmatch(@pat, @str, 0).
*
* Pattern metacharacters are ?, *, [ and \.
* (And, inside character classes, !, - and ].)
*
* This is small and simple implementation intended for device blacklists
* where a string is matched against a number of patterns. Thus, it
* does not preprocess the patterns. It is non-recursive, and run-time
* is at most quadratic: strlen(@str)*strlen(@pat).
*
* An example of the worst case is glob_match("*aaaaa", "aaaaaaaaaa");
* it takes 6 passes over the pattern before matching the string.
*
* Like !fnmatch(@pat, @str, 0) and unlike the shell, this does NOT
* treat / or leading . specially; it isn't actually used for pathnames.
*
* Note that according to glob(7) (and unlike bash), character classes
* are complemented by a leading !; this does not support the regex-style
* [^a-z] syntax.
*
* An opening bracket without a matching close is matched literally.
*/

integer glob_match(string pat, string str)
{
/*
* Backtrack to previous * on mismatch and retry starting one
* character later in the string. Because * matches all characters
* (no exception for /), it can be easily proved that there's
* never a need to backtrack multiple levels.
*/

integer back_pat = NOWHERE;
integer back_str;

/*
* Loop over each token (character or class) in pat, matching
* it against the remaining unmatched tail of str. Return false
* on mismatch, or true after matching the trailing nul bytes.
*/

integer str_i;
integer pat_i;

while (TRUE) {
integer c = llOrd(str, str_i++);
integer d = llOrd(pat, pat_i++);

/* Wildcard: anything but nul */
if (d == 0x3f) { // '?'
if (c == 0x00) // EOL
return FALSE;
jump skip_default;
/* Any-length wildcard */
} else if (d == 0x2a) { // '*'
/* Optimize trailing * case */
if (llOrd(pat, pat_i) == 0x00)
return TRUE;
back_pat = pat_i;
/* Allow zero-length match */
back_str = --str_i;
jump skip_default;
/* Character class */
} else if (d == 0x5b) { // '['
integer match = FALSE;
integer inverted = (llOrd(pat, pat_i) == 0x21); // '!'
integer class_i = pat_i + inverted;
integer a = llOrd(pat, class_i++);

/*
* Iterate over each span in the character class.
* A span is either a single character a, or a
* range a-b. The first span may begin with ']'.
*/
do {
integer b = a;

/* Malformed */
if (a == 0x00)
jump literal; // FIXME

if (llOrd(pat, class_i + 0) == 0x2d && llOrd(pat, class_i + 1) != 0x5d) {
b = llOrd(pat, class_i + 1);

if(b == 0x00)
jump literal;

class_i += 2;
/* Any special action if a > b? */
}
match = match | (a <= c && c <= b);
} while ((a = llOrd(pat, class_i++)) != 0x5d);

if (match == inverted)
jump backtrack;
pat_i = class_i;
jump skip_default;
} else if (d == 0x5c) { // '\\'
d = llOrd(pat, pat_i++);
}
/* Literal character */
@literal;
if (c == d) {
if (d == 0x00)
return TRUE;
jump skip_default;
}
@backtrack;
if (c == 0x00 || !~back_pat)
/* No point continuing */
return FALSE;
/* Try again from last *, one character later in str. */
pat_i = back_pat;
str_i = ++back_str;
jump skip_default;
@skip_default;
}
return FALSE; // unreachable, but the LSL compiler complains
}</syntaxhighlight>
|func_footnote
|return_type=integer
|return_text=[[TRUE]] or [[FALSE]].
|p1_type=string
|p1_name=pat
|p1_desc=The string to use as a template. <code>*</code> matches zero or more characters, <code>?</code> matches exactly one character, <code>[abc]</code> matches a, b, or c, and <code>[!abc]</code> matches any character but a, b, or c. Other characters are interpreted as literals.
|p1_hover=Pattern string.
|p2_type=string
|p2_name=str
|p2_desc=The query string to evaluate.
|p2_hover=Query string.
|constants
|spec
|caveats=* An unmatched <code>[</code> in {{LSLP|pat}} will be interpreted as a literal left square bracket.
* This is not a full regular expression implementation. Hyphens in character classes (square brackets) are not supported.
|examples=<syntaxhighlight lang="lsl">glob_match("a*c", "ac"); // TRUE - * can match zero characters
glob_match("a*can*", "alpha centauri cantina"); // TRUE - glob_match() supports full backtracking
glob_match("a?c", "ac"); // FALSE - ? always matches exactly 1 character
glob_match("*a*c?", "space"); // TRUE - mixture of the above
glob_match("gr[ae]y", "grey"); // TRUE - [ae] allows exactly one of "a" or "e"
glob_match("gr[ae]y", "gray"); // TRUE - [ae] allows exactly one of "a" or "e"
glob_match("gr[!ae]y", "grXy"); // TRUE - [!ae] expects exactly one character but forbids "a" or "e"
glob_match("gr[!ae]y", "gry"); // FALSE - character classes must match exactly once</syntaxhighlight>
|helpers
|also_header
|also_functions
|also_tests
|also_events
|also_articles
|also_footer
|notes=* For case-insensitive match, use [[llToLower]] on {{LSLP|str}} first.
|mode
|deprecated
|location
|cat1
|cat2
|cat3
|cat4
|cat5
|cat6
|haiku={{Haiku|Characters align;|patterns match in hidden files;|[[LSL Portal Poetry Project|haiku makes me cringe]].}}
}}

User:Rhet0rica Resident/glob match

2024-07-04T00:30:56Z

Rhet0rica Resident:

{{LSLC|User-Defined Functions}}
{{LSL_Function
|func=glob_match
|func_desc=Ported by [[User:Rhet0rica Resident|rhet0rica]] from [https://github.com/torvalds/linux/blob/master/lib/glob.c the Linux kernel], this function takes a pattern string and a query string as input and returns [[TRUE]] or [[FALSE]] depending on whether the query satisfies the pattern. This is the same method used by POSIX systems to match wildcards in filenames. License: Dual MIT and GPL 2.0. <syntaxhighlight lang="lsl">

/**
* glob_match - Shell-style pattern matching, like !fnmatch(pat, str, 0)
* @pat: Shell-style pattern to match, e.g. "*.[ch]".
* @str: String to match. The pattern must match the entire string.
*
* Perform shell-style glob matching, returning true (1) if the match
* succeeds, or false (0) if it fails. Equivalent to !fnmatch(@pat, @str, 0).
*
* Pattern metacharacters are ?, *, [ and \.
* (And, inside character classes, !, - and ].)
*
* This is small and simple implementation intended for device blacklists
* where a string is matched against a number of patterns. Thus, it
* does not preprocess the patterns. It is non-recursive, and run-time
* is at most quadratic: strlen(@str)*strlen(@pat).
*
* An example of the worst case is glob_match("*aaaaa", "aaaaaaaaaa");
* it takes 6 passes over the pattern before matching the string.
*
* Like !fnmatch(@pat, @str, 0) and unlike the shell, this does NOT
* treat / or leading . specially; it isn't actually used for pathnames.
*
* Note that according to glob(7) (and unlike bash), character classes
* are complemented by a leading !; this does not support the regex-style
* [^a-z] syntax.
*
* An opening bracket without a matching close is matched literally.
*/

integer glob_match(string pat, string str)
{
/*
* Backtrack to previous * on mismatch and retry starting one
* character later in the string. Because * matches all characters
* (no exception for /), it can be easily proved that there's
* never a need to backtrack multiple levels.
*/

integer back_pat = NOWHERE;
integer back_str;

/*
* Loop over each token (character or class) in pat, matching
* it against the remaining unmatched tail of str. Return false
* on mismatch, or true after matching the trailing nul bytes.
*/

integer str_i;
integer pat_i;

while (TRUE) {
integer c = llOrd(str, str_i++);
integer d = llOrd(pat, pat_i++);

/* Wildcard: anything but nul */
if (d == 0x3f) { // '?'
if (c == 0x00) // EOL
return FALSE;
jump skip_default;
/* Any-length wildcard */
} else if (d == 0x2a) { // '*'
/* Optimize trailing * case */
if (llOrd(pat, pat_i) == 0x00)
return TRUE;
back_pat = pat_i;
/* Allow zero-length match */
back_str = --str_i;
jump skip_default;
/* Character class */
} else if (d == 0x5b) { // '['
integer match = FALSE;
integer inverted = (llOrd(pat, pat_i) == 0x21); // '!'
integer class_i = pat_i + inverted;
integer a = llOrd(pat, class_i++);

/*
* Iterate over each span in the character class.
* A span is either a single character a, or a
* range a-b. The first span may begin with ']'.
*/
do {
integer b = a;

/* Malformed */
if (a == 0x00)
jump literal; // FIXME

if (llOrd(pat, class_i + 0) == 0x2d && llOrd(pat, class_i + 1) != 0x5d) {
b = llOrd(pat, class_i + 1);

if(b == 0x00)
jump literal;

class_i += 2;
/* Any special action if a > b? */
}
match = match | (a <= c && c <= b);
} while ((a = llOrd(pat, class_i++)) != 0x5d);

if (match == inverted)
jump backtrack;
pat_i = class_i;
jump skip_default;
} else if (d == 0x5c) { // '\\'
d = llOrd(pat, pat_i++);
}
/* Literal character */
@literal;
if (c == d) {
if (d == 0x00)
return TRUE;
jump skip_default;
}
@backtrack;
if (c == 0x00 || !~back_pat)
/* No point continuing */
return FALSE;
/* Try again from last *, one character later in str. */
pat_i = back_pat;
str_i = ++back_str;
jump skip_default;
@skip_default;
}
return FALSE; // unreachable, but the LSL compiler complains
}</syntaxhighlight>
|func_footnote
|return_type=integer
|return_text=[[TRUE]] or [[FALSE]].
|p1_type=string
|p1_name=pat
|p1_desc=The string to use as a template. <code>*</code> matches zero or more characters, <code>?</code> matches exactly one character, <code>[abc]</code> matches a, b, or c, and <code>[!abc]</code> matches any character but a, b, or c. Other characters are interpreted as literals.
|p1_hover=Pattern string.
|p2_type=string
|p2_name=str
|p2_desc=The query string to evaluate.
|p2_hover=Query string.
|constants
|spec
|caveats=* An unmatched <code>[</code> in {{LSLP|pat}} will be interpreted as a literal left square bracket.
* This is not a full regular expression implementation. Hyphens in character classes (square brackets) are not supported.
|examples=<syntaxhighlight lang="lsl">glob_match("a*c", "ac"); // TRUE - * can match zero characters
glob_match("a*can*", "alpha centauri cantina"); // TRUE - glob_match() supports full backtracking
glob_match("a?c", "ac"); // FALSE - ? always matches exactly 1 character
glob_match("*a*c?", "space"); // TRUE - mixture of the above
glob_match("gr[ae]y", "grey"); // TRUE - [ae] allows exactly one of "a" or "e"
glob_match("gr[ae]y", "gray"); // TRUE - [ae] allows exactly one of "a" or "e"
glob_match("gr[!ae]y", "grXy"); // TRUE - [!ae] expects exactly one character but forbids "a" or "e"
glob_match("gr[!ae]y", "gry"); // FALSE - character classes must match exactly once</syntaxhighlight>
|helpers
|also_header
|also_functions
|also_tests
|also_events
|also_articles
|also_footer
|notes=* For case-insensitive match, use [[llToLower]] on {{LSLP|str}} first.
|mode
|deprecated
|location
|cat1
|cat2
|cat3
|cat4
|cat5
|cat6
|haiku={{Haiku|Wildcards align;|patterns match in hidden files;|[[LSL Portal Poetry Project|haiku makes me cringe]].}}
}}

User:Rhet0rica Resident/glob match

2024-07-04T00:25:48Z

Rhet0rica Resident:

User:Rhet0rica Resident/glob

2024-07-04T00:14:56Z

Rhet0rica Resident: Rhet0rica Resident moved page User:Rhet0rica Resident/glob to User:Rhet0rica Resident/glob match: Changed name from original filename to match function name

#REDIRECT [[User:Rhet0rica Resident/glob match]]

User:Rhet0rica Resident/glob match

2024-07-04T00:14:55Z

Rhet0rica Resident: Rhet0rica Resident moved page User:Rhet0rica Resident/glob to User:Rhet0rica Resident/glob match: Changed name from original filename to match function name

{{LSLC|User-Defined Functions}}
{{LSL_Function
|func=glob_match
|func_desc=Ported by [[User:Rhet0rica Resident|rhet0rica]] from [https://github.com/torvalds/linux/blob/master/lib/glob.c the Linux kernel], this function takes a pattern string and a query string as input and returns [[TRUE]] or [[FALSE]] depending on whether the query satisfies the pattern. This is the same method used by POSIX systems to match wildcards in filenames. License: Dual MIT/GPL. <syntaxhighlight lang="lsl">

/**
* glob_match - Shell-style pattern matching, like !fnmatch(pat, str, 0)
* @pat: Shell-style pattern to match, e.g. "*.[ch]".
* @str: String to match. The pattern must match the entire string.
*
* Perform shell-style glob matching, returning true (1) if the match
* succeeds, or false (0) if it fails. Equivalent to !fnmatch(@pat, @str, 0).
*
* Pattern metacharacters are ?, *, [ and \.
* (And, inside character classes, !, - and ].)
*
* This is small and simple implementation intended for device blacklists
* where a string is matched against a number of patterns. Thus, it
* does not preprocess the patterns. It is non-recursive, and run-time
* is at most quadratic: strlen(@str)*strlen(@pat).
*
* An example of the worst case is glob_match("*aaaaa", "aaaaaaaaaa");
* it takes 6 passes over the pattern before matching the string.
*
* Like !fnmatch(@pat, @str, 0) and unlike the shell, this does NOT
* treat / or leading . specially; it isn't actually used for pathnames.
*
* Note that according to glob(7) (and unlike bash), character classes
* are complemented by a leading !; this does not support the regex-style
* [^a-z] syntax.
*
* An opening bracket without a matching close is matched literally.
*/

integer glob_match(string pat, string str)
{
/*
* Backtrack to previous * on mismatch and retry starting one
* character later in the string. Because * matches all characters
* (no exception for /), it can be easily proved that there's
* never a need to backtrack multiple levels.
*/

integer back_pat = NOWHERE;
integer back_str;

/*
* Loop over each token (character or class) in pat, matching
* it against the remaining unmatched tail of str. Return false
* on mismatch, or true after matching the trailing nul bytes.
*/

integer str_i;
integer pat_i;

while (TRUE) {
integer c = llOrd(str, str_i++);
integer d = llOrd(pat, pat_i++);

/* Wildcard: anything but nul */
if(d == 0x3f) { // '?'
if (c == 0x00) // EOL
return FALSE;
jump skip_default;
/* Any-length wildcard */
} else if(d == 0x2a) { // '*'
/* Optimize trailing * case */
if(llOrd(pat, pat_i) == 0x00)
return TRUE;
back_pat = pat_i;
/* Allow zero-length match */
back_str = --str_i;
jump skip_default;
/* Character class */
} else if(d == 0x5b) { // '['
integer match = FALSE;
integer inverted = (llOrd(pat, pat_i) == 0x21); // '!'
integer class_i = pat_i + inverted;
integer a = llOrd(pat, class_i++);

/*
* Iterate over each span in the character class.
* A span is either a single character a, or a
* range a-b. The first span may begin with ']'.
*/
do {
integer b = a;

/* Malformed */
if(a == 0x00)
jump literal; // FIXME

if(llOrd(pat, class_i + 0) == 0x2d && llOrd(pat, class_i + 1) != 0x5d) {
b = llOrd(pat, class_i + 1);

if(b == 0x00)
jump literal;

class_i += 2;
/* Any special action if a > b? */
}
match = match | (a <= c && c <= b);
} while((a = llOrd(pat, class_i++)) != 0x5d);

if (match == inverted)
jump backtrack;
pat_i = class_i;
jump skip_default;
} else if(d == 0x5c) { // '\\'
d = llOrd(pat, pat_i++);
}
//default: /* Literal character */
@literal;
if (c == d) {
if(d == 0x00)
return TRUE;
jump skip_default;
}
@backtrack;
if(c == 0x00 || !~back_pat)
/* No point continuing */
return FALSE;
/* Try again from last *, one character later in str. */
pat_i = back_pat;
str_i = ++back_str;
jump skip_default;
@skip_default;
#ifdef DEBUG_GLOB
last_d = d;
last_c = c;
last_str_i = str_i;
last_pat_i = pat_i;
#endif
}
return FALSE; // unreachable
}</syntaxhighlight>
|func_footnote
|return_type=integer
|return_text=[[TRUE]] or [[FALSE]].
|p1_type=string
|p1_name=pat
|p1_desc=The string to use as a template. <samp>*</samp> matches zero or more characters, <samp>?</samp> matches exactly one character, <samp>[abc]</samp> matches a, b, or c, and <samp>[!abc]</samp> matches any character but a, b, or c. Other characters are interpreted as literals.
|p1_hover=Pattern string.
|p2_type=string
|p2_name=str
|p2_desc=The query string to evaluate.
|p2_hover=Query string.
|constants
|spec
|caveats=* An unmatched <samp>[</samp> in the pattern string will be interpreted as a literal left square bracket.
* This is not a full regular expression implementation. Hyphens in character classes (square brackets) are not supported.
|examples=<syntaxhighlight lang="lsl">glob_match("a*c", "ac"); // TRUE
glob_match("a*c*", "alpha centauri"); // TRUE
glob_match("a?c", "ac"); // FALSE
glob_match("*a*c?", "space"); // TRUE
glob_match("gr[ae]y", "grey"); // TRUE
glob_match("gr[ae]y", "gray"); // TRUE
glob_match("gr[!ae]y", "grXy"); // TRUE
glob_match("gr[!ae]y", "gry"); // FALSE</syntaxhighlight>
|helpers
|also_header
|also_functions
|also_tests
|also_events
|also_articles
|also_footer
|notes=* For case-insensitive match, use [[llToLower]] first.
|mode
|deprecated
|location
|cat1
|cat2
|cat3
|cat4
|cat5
|cat6
}}

User:Rhet0rica Resident/glob match

2024-07-04T00:14:25Z

Rhet0rica Resident:

{{LSLC|User-Defined Functions}}
{{LSL_Function
|func=glob_match
|func_desc=Ported by [[User:Rhet0rica Resident|rhet0rica]] from [https://github.com/torvalds/linux/blob/master/lib/glob.c the Linux kernel], this function takes a pattern string and a query string as input and returns [[TRUE]] or [[FALSE]] depending on whether the query satisfies the pattern. This is the same method used by POSIX systems to match wildcards in filenames. License: Dual MIT/GPL. <syntaxhighlight lang="lsl">

/**
* glob_match - Shell-style pattern matching, like !fnmatch(pat, str, 0)
* @pat: Shell-style pattern to match, e.g. "*.[ch]".
* @str: String to match. The pattern must match the entire string.
*
* Perform shell-style glob matching, returning true (1) if the match
* succeeds, or false (0) if it fails. Equivalent to !fnmatch(@pat, @str, 0).
*
* Pattern metacharacters are ?, *, [ and \.
* (And, inside character classes, !, - and ].)
*
* This is small and simple implementation intended for device blacklists
* where a string is matched against a number of patterns. Thus, it
* does not preprocess the patterns. It is non-recursive, and run-time
* is at most quadratic: strlen(@str)*strlen(@pat).
*
* An example of the worst case is glob_match("*aaaaa", "aaaaaaaaaa");
* it takes 6 passes over the pattern before matching the string.
*
* Like !fnmatch(@pat, @str, 0) and unlike the shell, this does NOT
* treat / or leading . specially; it isn't actually used for pathnames.
*
* Note that according to glob(7) (and unlike bash), character classes
* are complemented by a leading !; this does not support the regex-style
* [^a-z] syntax.
*
* An opening bracket without a matching close is matched literally.
*/

integer glob_match(string pat, string str)
{
/*
* Backtrack to previous * on mismatch and retry starting one
* character later in the string. Because * matches all characters
* (no exception for /), it can be easily proved that there's
* never a need to backtrack multiple levels.
*/

integer back_pat = NOWHERE;
integer back_str;

/*
* Loop over each token (character or class) in pat, matching
* it against the remaining unmatched tail of str. Return false
* on mismatch, or true after matching the trailing nul bytes.
*/

integer str_i;
integer pat_i;

while (TRUE) {
integer c = llOrd(str, str_i++);
integer d = llOrd(pat, pat_i++);

/* Wildcard: anything but nul */
if(d == 0x3f) { // '?'
if (c == 0x00) // EOL
return FALSE;
jump skip_default;
/* Any-length wildcard */
} else if(d == 0x2a) { // '*'
/* Optimize trailing * case */
if(llOrd(pat, pat_i) == 0x00)
return TRUE;
back_pat = pat_i;
/* Allow zero-length match */
back_str = --str_i;
jump skip_default;
/* Character class */
} else if(d == 0x5b) { // '['
integer match = FALSE;
integer inverted = (llOrd(pat, pat_i) == 0x21); // '!'
integer class_i = pat_i + inverted;
integer a = llOrd(pat, class_i++);

/*
* Iterate over each span in the character class.
* A span is either a single character a, or a
* range a-b. The first span may begin with ']'.
*/
do {
integer b = a;

/* Malformed */
if(a == 0x00)
jump literal; // FIXME

if(llOrd(pat, class_i + 0) == 0x2d && llOrd(pat, class_i + 1) != 0x5d) {
b = llOrd(pat, class_i + 1);

if(b == 0x00)
jump literal;

class_i += 2;
/* Any special action if a > b? */
}
match = match | (a <= c && c <= b);
} while((a = llOrd(pat, class_i++)) != 0x5d);

if (match == inverted)
jump backtrack;
pat_i = class_i;
jump skip_default;
} else if(d == 0x5c) { // '\\'
d = llOrd(pat, pat_i++);
}
//default: /* Literal character */
@literal;
if (c == d) {
if(d == 0x00)
return TRUE;
jump skip_default;
}
@backtrack;
if(c == 0x00 || !~back_pat)
/* No point continuing */
return FALSE;
/* Try again from last *, one character later in str. */
pat_i = back_pat;
str_i = ++back_str;
jump skip_default;
@skip_default;
#ifdef DEBUG_GLOB
last_d = d;
last_c = c;
last_str_i = str_i;
last_pat_i = pat_i;
#endif
}
return FALSE; // unreachable
}</syntaxhighlight>
|func_footnote
|return_type=integer
|return_text=[[TRUE]] or [[FALSE]].
|p1_type=string
|p1_name=pat
|p1_desc=The string to use as a template. <samp>*</samp> matches zero or more characters, <samp>?</samp> matches exactly one character, <samp>[abc]</samp> matches a, b, or c, and <samp>[!abc]</samp> matches any character but a, b, or c. Other characters are interpreted as literals.
|p1_hover=Pattern string.
|p2_type=string
|p2_name=str
|p2_desc=The query string to evaluate.
|p2_hover=Query string.
|constants
|spec
|caveats=* An unmatched <samp>[</samp> in the pattern string will be interpreted as a literal left square bracket.
* This is not a full regular expression implementation. Hyphens in character classes (square brackets) are not supported.
|examples=<syntaxhighlight lang="lsl">glob_match("a*c", "ac"); // TRUE
glob_match("a*c*", "alpha centauri"); // TRUE
glob_match("a?c", "ac"); // FALSE
glob_match("*a*c?", "space"); // TRUE
glob_match("gr[ae]y", "grey"); // TRUE
glob_match("gr[ae]y", "gray"); // TRUE
glob_match("gr[!ae]y", "grXy"); // TRUE
glob_match("gr[!ae]y", "gry"); // FALSE</syntaxhighlight>
|helpers
|also_header
|also_functions
|also_tests
|also_events
|also_articles
|also_footer
|notes=* For case-insensitive match, use [[llToLower]] first.
|mode
|deprecated
|location
|cat1
|cat2
|cat3
|cat4
|cat5
|cat6
}}

User:Rhet0rica Resident/glob match

2024-07-03T23:06:20Z

Rhet0rica Resident: Created page with "{{LSLC|User-Defined Functions}} {{LSL_Function |func=glob |func_desc=Ported by rhet0rica from [https://github.com/torvalds/linux/blob/master/lib/gl..."

{{LSLC|User-Defined Functions}}
{{LSL_Function
|func=glob
|func_desc=Ported by [[User:Rhet0rica Resident|rhet0rica]] from [https://github.com/torvalds/linux/blob/master/lib/glob.c the Linux kernel], this function takes a pattern string and a query string as input and returns [[TRUE]] or [[FALSE]] depending on whether the query satisfies the pattern. This is the same method used by POSIX systems to match wildcards in filenames. License: Dual MIT/GPL. <syntaxhighlight lang="lsl">integer glob_match(string pat, string str)
{
/*
* Backtrack to previous * on mismatch and retry starting one
* character later in the string. Because * matches all characters
* (no exception for /), it can be easily proved that there's
* never a need to backtrack multiple levels.
*/

integer back_pat = NOWHERE;
integer back_str;

/*
* Loop over each token (character or class) in pat, matching
* it against the remaining unmatched tail of str. Return false
* on mismatch, or true after matching the trailing nul bytes.
*/

integer str_i;
integer pat_i;

while (TRUE) {
integer c = llOrd(str, str_i++);
integer d = llOrd(pat, pat_i++);

/* Wildcard: anything but nul */
if(d == 0x3f) { // '?'
if (c == 0x00) // EOL
// return false;
return FALSE;
//break;
jump skip_default;
/* Any-length wildcard */
} else if(d == 0x2a) { // '*'
/* Optimize trailing * case */
if(llOrd(pat, pat_i) == 0x00)
return TRUE;
back_pat = pat_i;
/* Allow zero-length match */
back_str = --str_i;
jump skip_default;
/* Character class */
} else if(d == 0x5b) { // '['
integer match = FALSE;
integer inverted = (llOrd(pat, pat_i) == 0x21); // '!'
integer class_i = pat_i + inverted;
integer a = llOrd(pat, class_i++);

/*
* Iterate over each span in the character class.
* A span is either a single character a, or a
* range a-b. The first span may begin with ']'.
*/
do {
integer b = a;

/* Malformed */
if(a == 0x00)
// goto literal;
jump literal; // FIXME

if(llOrd(pat, class_i + 0) == 0x2d && llOrd(pat, class_i + 1) != 0x5d) {
b = llOrd(pat, class_i + 1);

if(b == 0x00)
jump literal;

class_i += 2;
/* Any special action if a > b? */
}
match = match | (a <= c && c <= b);
} while((a = llOrd(pat, class_i++)) != 0x5d);

if (match == inverted)
jump backtrack;
pat_i = class_i;
jump skip_default;
} else if(d == 0x5c) { // '\\'
// d = *pat++;
d = llOrd(pat, pat_i++);
// fallthrough;
}
//default: /* Literal character */
@literal;
if (c == d) {
//if (d == '\0')
if(d == 0x00)
return TRUE;
jump skip_default;
}
@backtrack;
if(c == 0x00 || !~back_pat)
/* No point continuing */
return FALSE;
/* Try again from last *, one character later in str. */
pat_i = back_pat;
str_i = ++back_str;
jump skip_default;
@skip_default;
#ifdef DEBUG_GLOB
last_d = d;
last_c = c;
last_str_i = str_i;
last_pat_i = pat_i;
#endif
}
return FALSE; // unreachable
}</syntaxhighlight>
|func_footnote
|return_type=integer
|return_text=[[TRUE]] or [[FALSE]].
|p1_type=string
|p1_name=pat
|p1_desc=The string to use as a template. <samp>*</samp> matches zero or more characters, <samp>?</samp> matches exactly one character, <samp>[abc]</samp> matches a, b, or c, and <samp>[!abc]</samp> matches any character but a, b, or c. Other characters are interpreted as literals.
|p1_hover=Pattern string.
|p2_type=string
|p2_name=str
|p2_desc=The query string to evaluate.
|p2_hover=Query string.
|constants
|spec
|caveats=* An unmatched <samp>[</samp> in the pattern string will be interpreted as a literal left square bracket.
* This is not a full regular expression implementation. Hyphens in character classes (square brackets) are not supported.
|examples
|helpers
|also_header
|also_functions
|also_tests
|also_events
|also_articles
|also_footer
|notes
|mode
|deprecated
|location
|cat1
|cat2
|cat3
|cat4
|cat5
|cat6
}}

User:Rhet0rica Resident

2024-07-03T21:27:37Z

Rhet0rica Resident:

Hi. I'm [https://my.secondlife.com/rhet0rica rhet0rica], lead developer for [http://nanite-systems.com/ Nanite Systems] with my business partner and RL spouse, [http://my.secondlife.com/tammypeluso133 Tamara]. I occasionally stick my nose in here with the intention of improving LSL-related pages. I am also a profligate protocol architect, and a heavy user of [[LSL_Protocol/RestrainedLoveAPI]].

Apologies in advance if I sometimes seem rude or arrogant—what little social grace I have is hard-earned.

User:Rhet0rica Resident

2024-07-03T21:27:01Z

Rhet0rica Resident: Created page with "Hi. I'm [https://my.secondlife.com/rhet0rica rhet0rica], lead developer for [http://nanite-systems.com/ Nanite Systems] with my business partner and RL spouse, [http://my.seco..."

Hi. I'm [https://my.secondlife.com/rhet0rica rhet0rica], lead developer for [http://nanite-systems.com/ Nanite Systems] with my business partner and RL spouse, [http://my.secondlife.com/tammypeluso133 Tamara]. I occasionally stick my nose in here with the intention of improving LSL-related pages. I am also a profligate protocol architect, and a heavy user of [LSL_Protocol/RestrainedLoveAPI the RLV protocol].

Apologies in advance if I sometimes seem rude or arrogant—what little social grace I have is hard-earned.

LlFindNotecardTextSync

2024-07-03T21:20:01Z

Rhet0rica Resident: removed obsolete warning about large return data (that was fast!)

Talk:LlFindNotecardTextSync

2024-07-03T20:29:10Z

Rhet0rica Resident: /* Return type of NAK */ new section

Oh, fancy. We're getting slowly to the point where we can sensibly use notecards as ROM.

-- [[User:Peter Stindberg|Peter Stindberg]] ([[User talk:Peter Stindberg|talk]]) 13:32, 1 July 2024 (PDT)

== Return type of NAK ==

The article lists [[NAK]] as the return value, which seems implausible since it's a string and this function returns a list. Maybe [ [[NAK]] ] was intended? [[User:Rhet0rica Resident|rhet0rica]] ([[User talk:Rhet0rica Resident|talk]]) 13:29, 3 July 2024 (PDT)

LlFindNotecardTextSync

2024-07-03T20:27:44Z

Rhet0rica Resident: Added caveat about large return data

LlGetNotecardLineSync

2024-06-07T23:38:15Z

Rhet0rica Resident: Added an optimal (self-recovering) implementation.

{{LSL_Function
|inject-2={{LSL_Function/negative_index|false|line}}{{LSL_Function/notecard|name|uuid=true}}
|func_id=|func_sleep=0.0|func_energy=10.0
|sort=GetNotecardLineSync
|func=llGetNotecardLineSync
|return_type=string
|p1_type=string|p1_name=name
|p2_type=integer|p2_name=line|p2_desc=Line number in a notecard (the index starts at zero).
|func_desc=Gets the {{LSLP|line}} of the notecard {{LSLP|name}} from the region's notecard cache immediately without raising a dataserver event.
|Return_text=containing the text of the requested line from the notecard.
|func_footnote=Returns [[EOF]] if {{LSLP|line}} is past the end of the notecard.
|spec=
This function returns a string containing the requested line from a notecard in prim inventory, without the need for an asynchronous dataserver event, if the notecard is cached/known in its entirety by the simulator. This speeds up acessing notecard lines tremendously, and allows for near instantaneous random access.

If the notecard does not exist it returns the constant [[NAK]] and will shout a message to the debug channel. If the notecard has not been previously cached on the simulator it will return the [[NAK]] constant.

Notecards are cached into a fixed-size buffer, with the oldest (least-recently read) notecard getting removed first. It is not safe to assume a notecard has been previously cached. Data for a previously cached notecard may be dropped from the cache at any time, especially on a busy server.

|caveats=* If notecard contains embedded inventory items (such as textures and landmarks), [[EOF]] will be returned, regardless of the line requested.
*If the requested line is longer than 1024 bytes the returned string will be truncated to the first 1024 bytes of the line.
*A dataserver event does '''not''' get raised. Therefore, other scripts in the linkset are unaware of the processed notecard lines.
|constants
|examples=
<syntaxhighlight lang="lsl2">
string NOTECARD_NAME = "notecard";
key READ_KEY = NULL_KEY;

default
{

touch_start(integer total_number)
{
READ_KEY = llGetNumberOfNotecardLines(NOTECARD_NAME);
}

dataserver(key request, string data)
{
if (request == READ_KEY)
{
integer count = (integer)data;
integer index;

for (index = 0; index < (count+1); ++index)
{
string line = llGetNotecardLineSync(NOTECARD_NAME, index);
if (line == NAK)
{
llOwnerSay("---NAK---");
}
else if (line == EOF)
{
llOwnerSay("---EOF---");
}
else
{
llOwnerSay(line);
}
}
}
}
}
</syntaxhighlight>
Following example to call a normal [[dataserver]] notecard read using [[llGetNotecardLine]] if llGetNotecardlineSync fails with a NAK. Keep in mind to clear any lists you are reading data into when using the following example to keep from corrupting the integrity of the list data.
<syntaxhighlight lang="lsl2">

// llGetNotecardLineSync example with fall back to the old dataserver read
// if llGetNotecardLineSync fails with a NAK.

string NOTECARD_NAME = "notecard";
key READ_KEY = NULL_KEY;

key noteCard_qry;
integer noteCard_line;

default
{

state_entry()
{
// read the notecards number of lines to the
// simulators cache memory
READ_KEY = llGetNumberOfNotecardLines(NOTECARD_NAME);
}

dataserver(key request, string data)
{
// read notecards using the new llGetNotecardLineSync function
// from simulator cache.
if (request == READ_KEY)
{
integer count = (integer)data;
integer index;

for (index = 0; index < (count+1); ++index)
{
string line = llGetNotecardLineSync(NOTECARD_NAME, index);
if (line == NAK)
{
// Got a notecard NAK meaning llGetNotecardLineSync had and error.
// falling back to the old dataserver event to read notecards.
llOwnerSay("---NAK---");
noteCard_qry = llGetNotecardLine(NOTECARD_NAME, noteCard_line);
return; // return is needed to break the for/next loop once the NAK is encountered.
}
else if (line == EOF)
{
// End of notecard.
llOwnerSay("---EOF---");
}
else
{
// do work here.
llOwnerSay(line);
}
}
}

// old system takes over if a NAK is encountered.
if(request == noteCard_qry)
{
if(data == EOF)
{
// End of notecard encountered.
llOwnerSay("EOF encountered");
}
else
{
// process normal notecard line, then read the next line
// of the notecard.
llOwnerSay(data);
noteCard_qry = llGetNotecardLine(NOTECARD_NAME, ++noteCard_line);
}
}
}
}
</syntaxhighlight>

Here is a more compact implementation that returns to using llGetNotecardLineSync whenever possible:
<syntaxhighlight lang="lsl2">
string file_name;
integer file_line_number;
key file_request;

default {
state_entry() {
file_name = llGetInventoryName(INVENTORY_NOTECARD, 0); // get the name of the first notecard in the object's inventory
}

touch_start(integer n) {
// start reading text when the object is touched (you'll probably want to move these lines to another place depending on your needs):
file_line_number = 0;
file_request = llGetNotecardLine(file_name, file_line_number);
}

dataserver(key id, string message) {
if (id == file_request) {
while (message != EOF && message != NAK) {
llOwnerSay(message); // do useful things with the text here
message = llGetNotecardLineSync(file_name, ++file_line_number);
}
if (message == NAK)
file_request = llGetNotecardLine(file_name, file_line_number);
if (message == EOF)
llOwnerSay("End of file.");
}
}
}
</syntaxhighlight>
|also_functions={{LSL DefineRow||[[llGetNumberOfNotecardLines]]|}}
{{LSL DefineRow||[[llGetNotecardLine]]|}}
|also_events
|also_articles
|also_tests
|permission
|cat1=Notecard
|cat2=
|cat3=
|cat4=
|history=
}}