llGetNotecardLine
Jump to navigation
Jump to search
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Summary
Function: key llGetNotecardLine( string name, integer line );| 0.1 | Forced Delay |
| 10.0 | Energy |
Requests the line line of the notecard name from the dataserver.
Returns the handle (a key) for a dataserver event response.
| • string | name | – | a notecard in the inventory of the prim this script is in or a UUID of a notecard | |
| • integer | line | – | Line number in a notecard (the index starts at zero). |
line does not support negative indexes. If line is past the end of the notecard EOF is returned by the dataserver.
Caveats
- This function causes the script to sleep for 0.1 seconds.
- If line is out of bounds the script continues to execute without an error message.
- If name is missing from the prim's inventory and it is not a UUID or it is not a notecard then an error is shouted on DEBUG_CHANNEL.
- If name is a UUID then there are no new asset permissions consequences for the object.
- The resulting object develops no new usage restrictions that might have occurred if the asset had been placed in the prims inventory.
- If name is a new empty notecard (never saved) then an error "Couldn't find notecard ~NAME~" (~NAME~ being the value of name) will be shouted on the DEBUG_CHANNEL. This is because until a notecard is saved for the first time, it does not exist as an asset only as an inventory placeholder.
- If the notecard is full-perms you can check for this with llGetInventoryKey which will return NULL_KEY in this case. However if notecard is not full-perms, there is no way to avoid the error message.
- 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 dataserver will return the first 1024 bytes of the line.
- The byte return for this function was increased from 255 bytes to 1024 bytes with server version 2021-10-25.565008
Examples
key notecardQueryId; //Identifier for the dataserver event
string notecardName = "MyNotecard"; //Name of a notecard in the object's inventory. Needs to be Full Perm for key checking for changed contents to work
integer notecardLine; //Initialize the counter value at 0
key notecardKey; //Store the notecard's key, so we don't read it again by accident.
list notecardData; //List to store data read from the notecard.
ReadNotecard()
{
if (llGetInventoryKey(notecardName) == NULL_KEY)
{ //Check if the notecard exists in inventory, and is has been saved since it's creation (newly created notecards that are yet to be saved are assigned NULL_KEY).
llOwnerSay( "Notecard '" + notecardName + "' is missing, unwritten, or not full permission."); //Notify user.
return; //Don't do anything else.
}
else if (llGetInventoryKey(notecardName) == notecardKey) return;
//This notecard has already been read - call to read was made in error, so don't do anything. (Notecards are assigned a new key each time they are saved.)
llOwnerSay("Began reading notecard: " + notecardName); //Notify user that read has started.
notecardData = []; //Clear the memory of the previous notecard.
notecardKey = llGetInventoryKey(notecardName); //Remember the key of this iteration of the notecard, so we don't read it again by accident.
notecardQueryId = llGetNotecardLine(notecardName, notecardLine);
}
default
{
state_entry()
{
ReadNotecard(); //Pass off to the read function.
}
changed(integer change)
{
if(change & CHANGED_INVENTORY)
{ //The object's inventory just changed - the notecard could have been modified!
ReadNotecard();
}
}
dataserver(key query_id, string data)
{
if (query_id == notecardQueryId)
{
if (data == EOF) //Reached end of notecard (End Of File).
{
llOwnerSay("Done reading notecard, read " + (string) notecardLine + " notecard lines."); //Notify user.
llSay(DEBUG_CHANNEL,"=== READ FROM NOTECARD: " + notecardName + " ===\n" + llDumpList2String(notecardData,"\n"));
//Dump the contents of the notecard (for testing purposes).
}
else
{
notecardData += data; //Add the line being read to a new entry on the list.
++notecardLine; //Increment line number (read next line).
notecardQueryId = llGetNotecardLine(notecardName, notecardLine); //Query the dataserver for the next notecard line.
}
}
}
}
Useful Snippets
/////
// Generic Multi Notecard reader by Brangus Weir
// Given freely and published on wiki.secondlife.com
//
// This script will read three note cards and store the results into three lists.
// It can be modified and extended to as many (or few) cards as you'd like to read.
//
list gOneCard; // All the lines from from the first card
list gTwoCard; // All the lines from from the second card
list gThreeCard; // All the lines from from the third card
string gsCardOneName = "One"; //Set these to the name of the invetory item.
string gsCardTwoName = "Two";
string gsCardThreeName = "Three";
//Temporary variables for processing
string g_sNoteCardName; // Name of the card to be read.
list g_lTempLines; // The resulting data pushed into a list
integer g_iLine; // The line count for the card reader
key g_kQuery; // The key of the card being read
initialize(string _action) {
// Due to the execution order when using dataserver, this function sets the first card to
// be read, and the excetuion finishes when called again with the _action set to "finish".
if (_action == "") {
loadNoteCard(gsCardOneName);
} else if (_action == "finish") {
// All cards have been read into the lists... now you can do any kind of string
// manipulations to get the data you need to set your script.
// But here we will prove that the cards have been read with a loop
g_lTempLines = []; // lets not forget to delete this global, or it will be dead weight.
integer len = llGetListLength(gOneCard); //Always evaluate this once, don't do it
//INSIDE the for loop like noob programers will.
//Reduce lag, THINK ABOUT MACHINE CYCLES!
integer i = 0;
for (; i< len; ++i)
llSay(0, llList2String(gOneCard,i));
len = llGetListLength(gTwoCard);
for (i = 0; i< len; ++i)
llSay(0, llList2String(gTwoCard,i));
len = llGetListLength(gThreeCard);
for (i = 0; i< len; ++i)
llSay(0, llList2String(gThreeCard,i));
}
}
loadNoteCard( string _notecard ) {
g_lTempLines = []; //clear the temp lines
g_sNoteCardName = _notecard;
g_iLine = 0;
g_kQuery = llGetNotecardLine(g_sNoteCardName, g_iLine);
}
notecardFinished(string _notecard){
// Called at the end of each notecard as it is read. The temp results are stored
// and the next card is commanded to be read.
if (_notecard == gsCardOneName) {
gOneCard = g_lTempLines;
loadNoteCard(gsCardTwoName);
} else if (_notecard == gsCardTwoName) {
gTwoCard = g_lTempLines;
loadNoteCard(gsCardThreeName);
} else if (_notecard == gsCardThreeName) {
gThreeCard = g_lTempLines;
initialize("finish"); // Finally pass execution to finish the initialization.
}
}
default
{
state_entry()
{
}
touch_start(integer _num_det){
initialize("");
}
dataserver(key _query_id, string _data)
{
if (_query_id == g_kQuery) {
// this is a line of our notecard
if (_data != EOF) {
g_lTempLines += _data;
//request a next line
++g_iLine; // increment line count
g_kQuery = llGetNotecardLine(g_sNoteCardName, g_iLine);
} else {
//The notecard has been read
//notify end of read
notecardFinished(g_sNoteCardName);
}
}
}
}
/////
// Generic Multi Notecard reader by Randur Source
// Given freely and published on wiki.secondlife.com
//
// This script will read all note cards in sequence and dump the results into chat as an example.
// It can be modified and extended to do other things to the data.
//
integer inventorycnt;
integer notecardlinecnt;
integer notecardlinenumber;
string notecardname;
key linenumberid;
key lineid;
getnextnotecardlinenumber()
{
// first get the number of lines from the notecard
inventorycnt++;
if (inventorycnt < llGetInventoryNumber(INVENTORY_NOTECARD))
{
notecardname = llGetInventoryName(INVENTORY_NOTECARD,inventorycnt);
linenumberid = llGetNumberOfNotecardLines(notecardname);
}
else
llOwnerSay("Done.");
}
getnextnotecardline()
{
// get the next line from the notecard or skip to the next notecard
notecardlinecnt++;
if (notecardlinecnt < notecardlinenumber)
lineid = llGetNotecardLine(notecardname,notecardlinecnt);
else
getnextnotecardlinenumber();
}
default
{
touch_start(integer total_number)
{
if (llDetectedKey(0) != llGetOwner()) return; // allow owner only
inventorycnt = -1;
getnextnotecardlinenumber();
}
dataserver(key queryid,string data)
{
if (queryid == linenumberid) // this was a line number lookup
{
linenumberid = NULL_KEY;
notecardlinenumber = (integer)data;
if (notecardlinenumber == 0)
getnextnotecardlinenumber();
else
{
notecardlinecnt = -1;
getnextnotecardline();
}
}
else if (queryid == lineid) // this was a data line lookup
{
lineid = NULL_KEY;
// Example of what to do with the data:
// Test for valid avatar names, possibly multiple names on each line, separated by ,
// and say them in chat to the owner
list names = llParseString2List(data,[","],[]); // split lines on ,
integer len = llGetListLength(names); // I wouldn't dare to put this inside the for loop
integer cnt;
for (cnt = 0; cnt < len; cnt++)
{
string name = llDumpList2String(llParseString2List(llList2String(names,cnt),[" "],[])," "); // remove extra spaces
if (llGetListLength(llParseString2List(name,[" "],[])) == 2) // check for first + lastname
llOwnerSay(notecardname + ": " + name);
}
getnextnotecardline();
}
}
}
See Also
Deep Notes
History
- llGetNotecardLine Added in SL 0.6.0[1]
Footnotes
- ^ Early release notes were not very accurate or thorough, they sometimes included information about features added in previous releases or failed to include information about features added in that release.
Signature |
|---|
function key llGetNotecardLine( string name, integer line ); |