Difference between revisions of "LlGetNumberOfNotecardLines"

From Second Life Wiki
Jump to navigation Jump to search
m (gRequestID -> gLineRequestID so that the user isn't tempted to reuse gRequestID for other dataserver functions.)
(Replaced 2nd example (tho' it's really too application-oriented for this page))
Line 40: Line 40:
</lsl>
</lsl>
<lsl>
<lsl>
string NOTECARD_NAME = "config"; // name of the card we are going to read
// Check for a valid existant notecard, and read it into a list
integer notecard_line = 0;
// On touch, say the total number of lines, number of lines containing data, and say each line
integer num_notecard_lines = 0;
// Omei Qunhua  7-Jan-2013
key notecard_request = NULL_KEY;
list card_data; // the data in the card


integer
string gNotecard = "Config";      // Name of notecard to be examined
check_card(string name) // check that that the named inventory item is a notecard
key    gLineRequestID;            // Identity of expected line count dataserver event
{
key     gReadRequestID;            // Identity of expected data read dataserver event
     integer i = llGetInventoryType(name);
integer gLineTotal;                // The number of lines in the NC, as determined by this script
    return i == INVENTORY_NOTECARD;
integer gLineIndex;                 // Index for data read requests
}
list    gDataLines;                 // List containing all data lines from notecard, excluding blank and comment lines
string  gStatus;                    // Will contain EOF when notecard reading has finished


default
default
Line 57: Line 56:
     state_entry()
     state_entry()
     {
     {
         state init;
         if (llGetInventoryKey(gNotecard) )        // Test if notecard exists and has been saved (returned key will be NULL_KEY otherwise)
    }
            gLineRequestID = llGetNumberOfNotecardLines(gNotecard);      // Kick off a request for the total number of lines that the notecard contains
}
         else
 
            llOwnerSay("Notecard '" + gNotecard + "' does not exist or has no saved data");
state ready
{
    touch_start(integer detected)
    {
        llOwnerSay("the notecard contained the following data:");
         llOwnerSay(llDumpList2String(card_data, "\n"));
     }
     }
     changed(integer change)
     changed(integer change)
     {
     {
         if (change & (CHANGED_INVENTORY)) // if someone edits the card, reset the script
         if (change & CHANGED_INVENTORY)
        {
             llResetScript();
             llResetScript();
        }
     }
     }
}
     dataserver(key requested, string data)
 
state init
{
     state_entry()
     {
     {
         if (!check_card(NOTECARD_NAME)) // check the card exists
         if (requested == gLineRequestID)
         {
         {
             state error;
             gLineTotal = (integer) data;          // Cast the data string to an integer to get the number of lines
            gReadRequestID = llGetNotecardLine(gNotecard, gLineIndex);      // Request a read of the first notecard line
            return;
         }
         }
         llSetText("initialising...", <1, 1, 1>, 0);
         if (requested != gReadRequestID)
        notecard_request = NULL_KEY;
            return;
         notecard_line = 0;
         if ( (gStatus = data) == EOF)              // Save and test the current data (so that other code can tell when we've finished too)
        num_notecard_lines = 0;
            return;
        notecard_request = llGetNumberOfNotecardLines(NOTECARD_NAME); // ask for the number of lines in the card
 
         llSetTimerEvent(5.0); // if we don't hear back in 5 secs, then the card might have been empty
        // A notecard line has been read. Kick off the process of fetching the next line, while we process this line
    }
         gReadRequestID = llGetNotecardLine(gNotecard, ++gLineIndex);
    timer() // if we time out, it meant something went wrong - the notecard was probably empty
 
    {
        data = llStringTrim(data, STRING_TRIM);    // chop off any leading or trailing blanks
         llSetTimerEvent(0.0);
         if (data == "" || llGetSubString(data, 0, 0) == "#")   
         state error;
            return;                               // ignore blank or comment lines
       
        // Do any further processing of the data here
         gDataLines += data;                       // Add this data line to our global list
     }
     }
     dataserver(key query_id, string data)
     touch_start(integer total_number)
     {
     {
         if (query_id == notecard_request) // make sure it's an answer to a question we asked - this should be an unnecessary check
         if (gStatus != EOF)
         {
         {
             llSetTimerEvent(0.0); // at least one line, so don't worry any more
             llOwnerSay("Please wait");            // Still reading the notecard
             if (data == EOF) // end of the notecard, change to ready state
             return;
            {
                state ready;
            }
            else if (num_notecard_lines == 0) // first request is for the number of lines
            {
                num_notecard_lines = (integer)data;
                notecard_request = llGetNotecardLine(NOTECARD_NAME, notecard_line); // now get the first line
            }
             else
            {
                if (data != "" && llGetSubString(data, 0, 0) != "#") // ignore empty lines, or lines beginning with "#"
                {
                    card_data = (card_data = []) + card_data + data;
                }
                ++notecard_line;
                notecard_request = llGetNotecardLine(NOTECARD_NAME, notecard_line); // ask for the next line
            }
         }
         }
         // update the hover-text with the progress
         integer count = (gDataLines != [] );      // Get list length (efficient shortcut)
         llSetText("read " + (string)(notecard_line) + " of " + (string)num_notecard_lines + " lines", <1, 1, 1>, 1);
         llOwnerSay(gNotecard + " had a total of  " + (string) gLineTotal + " lines, of which " + (string) count + " contained data." );
    }
 
    state_exit()
    {
        llSetText("", <0, 0, 0>, 0);
    }
}


state error
        integer x;
{
         for ( ; x < count; ++x)                    // Loop through the data list
    state_entry()
    {
         llOwnerSay("something went wrong; try checking that the notecard [ " + NOTECARD_NAME + " ] exists and contains data");
    }
    changed(integer change)
    {
        if (change & CHANGED_INVENTORY)
         {
         {
             llResetScript();
             llOwnerSay( llList2String(gDataLines, x) );
         }
         }
        llOwnerSay("---- end of data ----");
     }
     }
}</lsl>
}
</lsl>
|helpers
|helpers
|also_functions={{LSL DefineRow||[[llGetNotecardLine]]|}}
|also_functions={{LSL DefineRow||[[llGetNotecardLine]]|}}

Revision as of 04:53, 7 January 2013

Summary

Function: key llGetNumberOfNotecardLines( string name );

Requests the number of lines in notecard name via the dataserver event (cast dataserver value to integer)
Returns a key that is the handle 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

Caveats

  • This function causes the script to sleep for 0.1 seconds.
  • 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 notecard contains embedded inventory items (such as textures and landmarks), invalid data will be returned.
All Issues ~ Search JIRA for related Bugs

Examples

<lsl> // Ascertain the number of lines in a notecard in the prim's contents

string gNotecard = "Config"; // Name of notecard to be examined key gLineRequestID; // Identity of expected dataserver event integer gLineCounter; // The number of lines in the NC, as determined by this script

default { 

   state_entry()
   {
       // Ask how many lines are in the notecard.
       // The answer will arrive via a dataserver event
       gLineRequestID = llGetNumberOfNotecardLines(gNotecard);
   }
   
   dataserver(key requested, string data)
   {
       if (requested == gLineRequestID)
       {
           llOwnerSay( "The notecard '" + gNotecard + "' contains " + data + " lines" );
           // cast the data string to an integer if you need to access the counter later
           gLineCounter = (integer) data;
       }        
   }

} </lsl> <lsl> // Check for a valid existant notecard, and read it into a list // On touch, say the total number of lines, number of lines containing data, and say each line // Omei Qunhua 7-Jan-2013

string gNotecard = "Config"; // Name of notecard to be examined key gLineRequestID; // Identity of expected line count dataserver event key gReadRequestID; // Identity of expected data read dataserver event integer gLineTotal; // The number of lines in the NC, as determined by this script integer gLineIndex; // Index for data read requests list gDataLines; // List containing all data lines from notecard, excluding blank and comment lines string gStatus; // Will contain EOF when notecard reading has finished

default { 

   state_entry()
   {
       if (llGetInventoryKey(gNotecard) )         // Test if notecard exists and has been saved (returned key will be NULL_KEY otherwise)
           gLineRequestID = llGetNumberOfNotecardLines(gNotecard);       // Kick off a request for the total number of lines that the notecard contains
       else
           llOwnerSay("Notecard '" + gNotecard + "' does not exist or has no saved data");
   }
   changed(integer change)
   {
       if (change & CHANGED_INVENTORY)
           llResetScript();
   }
   dataserver(key requested, string data)
   {
       if (requested == gLineRequestID)
       {
           gLineTotal = (integer) data;           // Cast the data string to an integer to get the number of lines
           gReadRequestID = llGetNotecardLine(gNotecard, gLineIndex);      // Request a read of the first notecard line
           return;
       }
       if (requested != gReadRequestID)
           return;
       if ( (gStatus = data) == EOF)              // Save and test the current data (so that other code can tell when we've finished too)
           return;

       // A notecard line has been read. Kick off the process of fetching the next line, while we process this line
       gReadRequestID = llGetNotecardLine(gNotecard, ++gLineIndex);

       data = llStringTrim(data, STRING_TRIM);    // chop off any leading or trailing blanks
if (data == ""

See Also

Events

•  dataserver

Functions

•  llGetNotecardLine

Deep Notes

Search JIRA for related Issues

Signature

function key llGetNumberOfNotecardLines( string name );
Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlGetNumberOfNotecardLines&oldid=1175913"