Difference between revisions of "LlGetSubString"

From Second Life Wiki
Jump to navigation Jump to search
(Replaced <source> with <syntaxhighlight> and added a crazy haiku :))
 
(23 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{LSL_Function
{{LSL Function
|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
|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
|caveats
|caveats
|constants
|constants
|examples
|examples=
<syntaxhighlight lang="lsl2">
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
    }
}
</syntaxhighlight>
<syntaxhighlight lang="lsl2">
// 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);
    }
}
</syntaxhighlight>
|helpers
|helpers
|also_functions
|also_functions=
{{LSL DefineRow||[[llReplaceSubString]]|}}
{{LSL DefineRow||[[llDeleteSubString]]}}
{{LSL DefineRow||[[llInsertString]]}}
|also_events
|also_events
|also_tests
|also_tests
|also_articles
|also_articles={{LSL DefineRow||[[Library_Combined_Library#str_replace|CombinedLibrary: str_replace]]}}
|notes
|notes=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.
|permission
 
|negative_index=true
To ascertain how long a string is, use [[llStringLength]].
|haiku={{Haiku|Half a bee buzzing|Flying through the air so free|With half of its wings}}
<hr>Generated by [https://toolbaz.com/writer/haiku-generator the AI Haiku Generator] inspired by the Monty Python song [https://genius.com/Monty-python-eric-the-half-a-bee-lyrics ''Eric the Half a Bee''], which starts with:
{{poem|Half a bee, philosophically
Must, ''ipso facto'', half not be
But half the bee has got to be
A ''vis-a-vis'' its entity, you see?
 
But can a bee be said to be
Or not to be an entire bee
When half the bee is not a bee
Due to some ancient injury?}}
If it's not obvious, my twisted mind tried to explain, using analogies, that part of a string extracted from a string is, indeed, a string too; half a string is also a string. Unless you make a serious mistake, that is.
— [[User:Gwyneth Llewelyn|Gwyneth Llewelyn]] ([[User talk:Gwyneth Llewelyn|talk]]) 07:55, 15 October 2023 (PDT)
|sort=GetSubString
|sort=GetSubString
|cat1=String
|cat1=String

Latest revision as of 06:55, 15 October 2023

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.

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

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

Signature

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

Haiku

Half a bee buzzing
Flying through the air so free
With half of its wings


Generated by the AI Haiku Generator inspired by the Monty Python song Eric the Half a Bee, which starts with:

Half a bee, philosophically Must, ipso facto, half not be But half the bee has got to be A vis-a-vis its entity, you see?

But can a bee be said to be Or not to be an entire bee When half the bee is not a bee Due to some ancient injury?

If it's not obvious, my twisted mind tried to explain, using analogies, that part of a string extracted from a string is, indeed, a string too; half a string is also a string. Unless you make a serious mistake, that is. — Gwyneth Llewelyn (talk) 07:55, 15 October 2023 (PDT)