Difference between revisions of "LlGetSubString"

From Second Life Wiki
Jump to navigation Jump to search
m (added SL clock example to show how llGetSubString can make if-clauses unnecessary)
(add link to llReplaceSubString)
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{LSL Function
{{LSL Function
|inject-2={{LSL_Function/negative index|true|start|end}}{{Issues/SCR-6}}
|inject-2={{LSL_Function/negative index|true|start|end}}
|func_id=94|func_sleep=0.0|func_energy=10.0
|func_id=94|func_sleep=0.0|func_energy=10.0
|func=llGetSubString|return_type=string|p1_type=string|p1_name=src|p2_type=integer|p2_name=start|p3_type=integer|p3_name=end
|func=llGetSubString|return_type=string|p1_type=string|p1_name=src|p2_type=integer|p2_name=start|p3_type=integer|p3_name=end
Line 10: Line 10:
|constants
|constants
|examples=
|examples=
<lsl>
<source lang="lsl2">
default
default
{
{
Line 24: Line 24:
     }
     }
}
}
</lsl>
</source>
<lsl>
<source lang="lsl2">
// display SL time by using a script without a single if!
// display SL time using a script without an 'if'
default
default
{
{
     state_entry()
     state_entry()
     {
     {
        // synchronise our clock to a fraction of a second
        float fnow = llGetWallclock();
        while (fnow == llGetWallclock() )  ;  // await a change in seconds
         llSetTimerEvent(1.0);
         llSetTimerEvent(1.0);
     }
     }
Line 36: Line 40:
     timer()
     timer()
     {
     {
         integer seconds = llFloor(llGetWallclock());
         integer seconds = (integer) llGetWallclock();
         integer minutes = llFloor(seconds / 60);
         integer minutes = seconds / 60;
         seconds = seconds - (minutes * 60);
         seconds = seconds % 60;
         integer hours = llFloor(minutes / 60);
         integer hours = minutes / 60;
         minutes = minutes - (hours * 60);
         minutes = minutes % 60;


         string stringHours = llGetSubString("0" + (string)hours, -2, -1);
         string stringHours   = llGetSubString("0" + (string)hours,   -2, -1);
         string stringMinutes = llGetSubString("0" + (string)minutes, -2, -1);
         string stringMinutes = llGetSubString("0" + (string)minutes, -2, -1);
         string stringSeconds = llGetSubString("0" + (string)seconds, -2, -1);
         string stringSeconds = llGetSubString("0" + (string)seconds, -2, -1);
Line 48: Line 52:
         string time = stringHours + ":" + stringMinutes + ":" + stringSeconds;
         string time = stringHours + ":" + stringMinutes + ":" + stringSeconds;


         llSetText(time, <1.0, 1.0, 1.0>, (float)TRUE);
         llSetText(time, <1.0, 1.0, 1.0>, 1.0);
     }
     }
}
}
</lsl>
</source>
|helpers
|helpers
|also_functions=
|also_functions=
{{LSL DefineRow||[[llReplaceSubString]]|}}
{{LSL DefineRow||[[llDeleteSubString]]}}
{{LSL DefineRow||[[llDeleteSubString]]}}
{{LSL DefineRow||[[llInsertString]]}}
{{LSL DefineRow||[[llInsertString]]}}

Revision as of 13:30, 30 January 2023

Summary

Function: string llGetSubString( string src, integer start, integer end );

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.

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).
All Issues ~ Search JIRA for related Bugs

Examples

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
    }
}
// display SL time using a script without an 'if'
default
{
    state_entry()
    {
        // synchronise our clock to a fraction of a second
        float fnow = llGetWallclock();
        while (fnow == llGetWallclock() )   ;   // await a change in seconds

        llSetTimerEvent(1.0);
    }

    timer()
    {
        integer seconds = (integer) llGetWallclock();
        integer minutes = seconds / 60;
        seconds = seconds % 60;
        integer hours = minutes / 60;
        minutes = minutes % 60;

        string stringHours   = llGetSubString("0" + (string)hours,   -2, -1);
        string stringMinutes = llGetSubString("0" + (string)minutes, -2, -1);
        string stringSeconds = llGetSubString("0" + (string)seconds, -2, -1);

        string time = stringHours + ":" + stringMinutes + ":" + stringSeconds;

        llSetText(time, <1.0, 1.0, 1.0>, 1.0);
    }
}

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. 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, so -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.

See Also

Deep Notes

Search JIRA for related Issues

Signature

function string llGetSubString( string src, integer start, integer end );