OsGetNotecard

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''osGetNotecard'''(string name)  
+
{{osslfunc
 +
|threat_level=VeryHigh
 +
|permissions=${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
 +
|delay=0
 +
|function_syntax=string osGetNotecard(string name)
 +
|ossl_example=<source lang="lsl">
 +
// ----------------------------------------------------------------
 +
// Example / Sample Script to show function use.
 +
//
 +
// Script Title:    osGetNotecard.lsl
 +
// Script Author:
 +
// Threat Level:    VeryHigh
 +
// Script Source:  http://opensimulator.org/wiki/osGetNotecard
 +
//
 +
// Notes: See Script Source reference for more detailed information
 +
// This sample is full opensource and available to use as you see fit and desire.
 +
// Threat Levels only apply to OSSL & AA Functions
 +
// See http://opensimulator.org/wiki/Threat_level
 +
// ================================================================
 +
// Inworld Script Line:    string osGetNotecard(string name);
 +
//
 +
// Example of osGetNotecard(name)
 +
//
 +
default
 +
{
 +
    state_entry()
 +
    {
 +
        llSay(0,"Touch to see osGetNotecard read in a notecard and display the text retrieved");
 +
    }
 +
    touch_end(integer num)
 +
    {
 +
        // get the first notecard in inventory (default max is 255 lines and would not show in std chat)
 +
        // each Line Return is reflected in output
 +
        string name = llGetInventoryName(INVENTORY_NOTECARD,0);
 +
        if(name == "")
 +
        {
 +
            llSay(0,"There is no notecard in prim inventory.  Please place a notecard with some text in the prim to display it's contents");
 +
            return;
 +
        }
 +
        else
 +
        {
 +
            string text = osGetNotecard(name);
 +
            llOwnerSay("NoteCard Name is: "+name);
 +
            llSay(0,text);
 +
        }
  
This function directly reads the entire contents of a notecard if it exists within the task inventory, and dumps it into a string. It skips the dataserver event, thereby reducing code complexity. This function has a threat level of Very High:
+
    }
 +
}
  
<br> ''From OSSL_Api.cs:''
+
</source>
<blockquote>"due to the synchronous method this function uses to fetch assets, its use may be dangerous and unreliable while running in grid mode."</blockquote>
+
|description=This function directly reads the entire contents of a notecard if it exists within the task inventory, and dumps it into a string. It skips the dataserver event, thereby reducing code complexity.  
 
+
|
--[[User:ZauberExonar|ZauberExonar]] 08:20, 5 February 2010 (UTC)
+
}}
 
+
 
+
[[Category:OSSL]]
+
[[Category:OSSL functions without example]]
+

Latest revision as of 23:28, 10 October 2019

string osGetNotecard(string name)
This function directly reads the entire contents of a notecard if it exists within the task inventory, and dumps it into a string. It skips the dataserver event, thereby reducing code complexity.
Threat Level VeryHigh
Permissions ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Extra Delay 0 seconds
Example(s)
// ----------------------------------------------------------------
// Example / Sample Script to show function use.
//
// Script Title:    osGetNotecard.lsl
// Script Author:
// Threat Level:    VeryHigh
// Script Source:   http://opensimulator.org/wiki/osGetNotecard
//
// Notes: See Script Source reference for more detailed information
// This sample is full opensource and available to use as you see fit and desire.
// Threat Levels only apply to OSSL & AA Functions
// See http://opensimulator.org/wiki/Threat_level
// ================================================================
// Inworld Script Line:    string osGetNotecard(string name);
//
// Example of osGetNotecard(name) 
// 
default
{
    state_entry()
    {
         llSay(0,"Touch to see osGetNotecard read in a notecard and display the text retrieved"); 
    }
    touch_end(integer num)
    {
        // get the first notecard in inventory (default max is 255 lines and would not show in std chat)
        // each Line Return is reflected in output
        string name = llGetInventoryName(INVENTORY_NOTECARD,0);
        if(name == "") 
        {
            llSay(0,"There is no notecard in prim inventory.  Please place a notecard with some text in the prim to display it's contents"); 
            return;
        }
        else
        {
            string text = osGetNotecard(name);
            llOwnerSay("NoteCard Name is: "+name);
            llSay(0,text);
        }
 
    }
}
Personal tools
General
About This Wiki