Difference between revisions of "LlKeysKeyValue"
Jump to navigation
Jump to search
Quartz Mole (talk | contribs) m (fixed broken lsl formatting) |
m |
||
| Line 4: | Line 4: | ||
|dl_desc=A list of keys ([[String|strings]]) used in the key-value store | |dl_desc=A list of keys ([[String|strings]]) used in the key-value store | ||
|dl_hover=A list of keys (strings) used in the key-value store}} | |dl_hover=A list of keys (strings) used in the key-value store}} | ||
{{LSL_Function/Experience|true}} | |||
|func=llKeysKeyValue | |func=llKeysKeyValue | ||
|func_desc=Start an asynchronous transaction to request a number of keys. | |func_desc=Start an asynchronous transaction to request a number of keys from the script's {{LSLGC|Experience}}. | ||
|func_footnote= | |func_footnote= | ||
This function will attempt to retrieve the number of keys requested but may return less if there are not enough to fulfill the full amount requested or if the list is too large. The order keys are returned is not guaranteed but is stable between subsequent calls as long as no keys are added or removed.<br/> | This function will attempt to retrieve the number of keys requested but may return less if there are not enough to fulfill the full amount requested or if the list is too large. The order keys are returned is not guaranteed but is stable between subsequent calls as long as no keys are added or removed.<br/> | ||
| Line 53: | Line 54: | ||
} | } | ||
} | } | ||
}</source>}} | }</source> | ||
|cat1=Experience | |||
|cat2=Dataserver | |||
|cat3=Experience/Data | |||
}} | |||
Revision as of 11:21, 5 May 2015
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Summary
Function: key llKeysKeyValue( integer first, integer count );
Start an asynchronous transaction to request a number of keys from the script's Experience.
Returns a handle (a key) that can be used to identify the corresponding dataserver event to determine if this command succeeded or failed.
| • integer | first | – | Zero-based index of the first key to retrieve | |
| • integer | count | – | Number of keys to retriever |
This function will attempt to retrieve the number of keys requested but may return less if there are not enough to fulfill the full amount requested or if the list is too large. The order keys are returned is not guaranteed but is stable between subsequent calls as long as no keys are added or removed.
The error XP_ERROR_KEY_NOT_FOUND is returned if there index given is greater than or equal to the number of keys.
Specification
Dataserver
The dataserver callback parameters are:
- A key containing the handle returned from llKeysKeyValue
- A string containing a comma-delimited list (cdl).
llDumpList2String([ integer success ] + components);- components vary depending upon success or failure of request.
- Failure:
cdl = llDumpList2String([ 0, integer error],",") - Success:
cdl = llDumpList2String([ 1 ] + keys),",")
String Components
| • integer | success | – | A boolean specifying if the transaction succeeded (1) or not (0). | |
| • integer | error | – | An XP_ERROR_* flag that describes why the operation failed. | |
| • list | keys | – | A list of keys (strings) used in the key-value store |
Caveats
- If you recompile a script that was previously associated with an Experience but do so with a client that lacks the ability to compile scripts into an experience the script will lose the associated Experience.
Examples
key trans;
default
{
state_entry()
{
// retrieve the first 10 keys
trans = llKeysKeyValue(0, 10);
}
dataserver(key t, string value)
{
if (t == trans)
{
// our llKeysKeyValue transaction is done
list result = llCSV2List(value);
if (llList2Integer(result, 0) == 1)
{
llSay(0, "Keys retrieved: "+(string)llGetSubString(value, 2, -1));
}
else if (llList2Integer(result, 1) == XP_ERROR_KEY_NOT_FOUND)
{
// no more keys
llSay(0, "No more keys" );
}
else
{
// keys request failed
llSay(0, "Key-value failed to request keys: " + llGetExperienceErrorMessage(llList2Integer(result, 1)) );
}
}
}
}
Notes
Compiling
For a script to be associated with an Experience...
- It must be compiled with a client that is Experience aware,
- The "Use Experience" checkbox must be checked,
- And one of the users Experience keys selected.
 |
Important: Not all TPVs have this functionality. |
See Also
Deep Notes
Signature |
|---|
function key llKeysKeyValue( integer first, integer count ); |