Difference between revisions of "LlGetSubString"
Void Singer (talk | contribs) m (formatted example) |
|||
| Line 4: | Line 4: | ||
|func_footnote | |func_footnote | ||
|func_desc | |func_desc | ||
|return_text=that is the substring of '''src''' from '''start''' to '''end'''. | |return_text=that is the substring of '''src''' from '''start''' to '''end''', leaving the original string intact. | ||
|spec | |spec=Note that the counting of the characters starts at 0. | ||
Using 0,0 as start and end positions would return the first character only. | |||
Using negative numbers causes backwards counting. | |||
-1 is shortform for the last character in a string. | |||
Ergo, using 0, -1 as start and end positions would return the entire string. | |||
To ascertain how long a string is, use [[llStringLength]]. | |||
|caveats | |caveats | ||
|constants | |constants | ||
Revision as of 19:50, 7 July 2008
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Summary
Function: string llGetSubString( string src, integer start, integer end );| 0.0 | Forced Delay |
| 10.0 | Energy |
Returns a string that is the substring of src from start to end, leaving the original string intact.
| • string | src | |||
| • integer | start | – | start index | |
| • integer | end | – | end index |
start & end support negative indexes.
Specification
| Index | Positive | Negative |
|---|---|---|
| First | 0
|
-length
|
| Last | length - 1
|
-1
|
Indexes
- Positive indexes count from the beginning, the first item being indexed as
0, the last as(length - 1).
- Negative indexes count from the far end, the first item being indexed as
-length, the last as-1.
Note that the counting of the characters starts at 0.
Using 0,0 as start and end positions would return the first character only.
Using negative numbers causes backwards counting.
-1 is shortform for the last character in a string.
Ergo, using 0, -1 as start and end positions would return the entire string.
To ascertain how long a string is, use llStringLength.
Caveats
- If either start or end are out of bounds the script continues to execute without an error message.
- start & end will form an exclusion range when start is past end (Approximately: start > end).
Examples
<lsl> default {
state_entry()
{
string word = "Hello!";
llOwnerSay(llGetSubString(word, 0, 0));
// Object: H
llOwnerSay(llGetSubString(word, -1, -1));
// Object: !
llOwnerSay(llGetSubString(word, 2, 3));
// Object: ll
}
}
</lsl>Notes
Ranges & Indexes
The easiest way to explain how ranges work is to make all indexes positive. Negative indexes are just a way of counting from the tail end instead of the beginning, all negative indexes have a corresponding equivalent positive index (assuming they are in range). Positive indexes past length (after the last index), or negative indexes past the beginning (before the first index) are valid and the effects are predictable and reliable: the entries are treated as if they were there but were removed just before output.
- If start <= end then the range operated on starts at start and ends at end. [start, end]
- Exclusion range: If start > end then the range operated on starts at 0 and goes to end and then starts again at start and goes to -1. [0, end] + [start, -1]
- If end is a negative index past the beginning, then the operating range would be [start, -1].
- If end is a positive index past the end, then the operating range would be [0, end].
- If both start and end are out of bounds then the function would have no operating range (effectively inverting what the function is supposed to do).
See negative indexes for more information.
See Also
Functions
| • | llDeleteSubString | |||
| • | llInsertString |
Articles
| • | Negative Index | |||
| • | CombinedLibrary: str_replace |
Deep Notes
Signature |
|---|
function string llGetSubString( string src, integer start, integer end ); |