LSL Dev

https://lsl.dev
Admin
LSL Dev is a modernized documentation portal for LSL scripters, offering step-by-step guides,...
Tokens:177,093
Snippets:1,254
Trust Score:4.4
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Rez String in LSL

Source: https://lsl.dev/functions/llGetStartString

Retrieves the string passed to llRezObjectWithParams with REZ_PARAM_STRING. Returns an empty string if the object was rezzed by an agent.

```lsl
string start_string = llGetStartString();
```

--------------------------------

### Rez Object with Default Parameters

Source: https://lsl.dev/functions/llRezObjectWithParams

This example demonstrates how to rez an object using the llRezObjectWithParams function with an empty parameter list, effectively placing it at the rezzer's location.

```lsl
default
{
	touch_start(integer total_number)
	{
		llRezObjectWithParams("Object", []);
	}
}
```

--------------------------------

### llCastRay Function

Source: https://lsl.dev/functions/llCastRay

Casts a ray into the physics world from a start vector to an end vector, returning collision data based on provided options.

```APIDOC
## llCastRay Function

### Description
Casts a ray into the physics world from ‘start’ to ‘end’ and returns data according to details in Options. Reports collision data for intersections with objects.

### Function Syntax
```
list llCastRay(
  vector Start,
  vector End,
  list Options
);
```

### Parameters
#### Path Parameters
* **Start** (vector) - Required - The starting point of the ray.
* **End** (vector) - Required - The ending point of the ray.
* **Options** (list) - Required - A list of options to configure the ray cast. Refer to LSL documentation for specific option details.

### Return Value
Returns a list containing collision data for each intersection, followed by a status code. The format is:
`[UUID_1, {link_number_1}, hit_position_1, {hit_normal_1}, UUID_2, {link_number_2}, hit_position_2, {hit_normal_2}, … , status_code]`

- **UUID_n** (key) - The UUID of the object hit.
- **link_number_n** (integer) - Optional - The link number of the prim hit.
- **hit_position_n** (vector) - The position where the ray hit the object.
- **hit_normal_n** (vector) - Optional - The normal vector at the hit position.
- **status_code** (integer) - The status code of the ray cast operation.
```

--------------------------------

### llSubStringIndex Function

Source: https://lsl.dev/functions/llSubStringIndex

Finds the first occurrence of a substring within a given string. Returns the starting index or -1 if not found.

```APIDOC
## llSubStringIndex

### Description
Returns an integer that is the index in `Text` where string pattern `Sequence` first appears. Returns -1 if not found.

### Function Syntax
integer llSubStringIndex(
  1. string Text,
  2. string Sequence
);

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* None

### Request Example
```
// Example usage:
integer index = llSubStringIndex("Hello, world!", "world"); // index will be 7
```

### Response
#### Success Response (Integer)
* **Return Value** (integer) - The starting index of the `Sequence` within `Text`, or -1 if not found.

#### Response Example
```
7
```

#### Error Response
* None (function returns -1 if not found)
```

--------------------------------

### Define Particle Start Scale (LSL)

Source: https://lsl.dev/constants/PSYS_PART_START_SCALE

Sets the initial scale for particle billboards using the PSYS_PART_START_SCALE parameter. This parameter takes an integer value representing the size in meters. The z-component of the vector is ignored.

```lsl
integer PSYS_PART_START_SCALE = 5;
```

--------------------------------

### Get Script Rez Parameter - LSL

Source: https://lsl.dev/functions/llGetStartParameter

The llGetStartParameter function returns an integer that is the script rez parameter. If the object was rezzed by an agent, this function returns 0.

```lsl
integer llGetStartParameter(

);

```

--------------------------------

### llRezAtRoot Function

Source: https://lsl.dev/functions/llRezAtRoot

This function instantiates an inventory item at a specified position, rotation, and velocity, with an optional start parameter. It's commonly used for creating objects dynamically within the Second Life environment.

```APIDOC
## llRezAtRoot Function

### Description
Instantiates an owner's inventory item at a specified position with velocity, rotation, and start parameter. The location of the last selected root object is updated to the provided position.

### Method
LSL Function (not an HTTP method)

### Endpoint
N/A (This is an LSL function, not a web API endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Function Syntax
`void llRezAtRoot(string InventoryItem, vector Position, vector Velocity, rotation Rotation, integer StartParameter);`

### Parameters Detailed
- **InventoryItem** (string) - Required - The name of the inventory item to rez.
- **Position** (vector) - Required - The local coordinates (x, y, z) where the object should be created.
- **Velocity** (vector) - Required - The initial velocity (x, y, z) of the object upon creation.
- **Rotation** (rotation) - Required - The initial rotation of the object.
- **StartParameter** (integer) - Optional - A parameter passed to the object's default state's `state_entry` event.

### Request Example
```lsl
// Example of how to use llRezAtRoot
string itemToRez = "My Awesome Cube";
vector rezPosition = <10.0, 20.0, 30.0>;
vector initialVelocity = <0.0, 0.0, 5.0>;
rotation objectRotation = ZERO_ROTATION;
integer startParam = 0;

llRezAtRoot(itemToRez, rezPosition, initialVelocity, objectRotation, startParam);
```

### Response
#### Success Response
This function returns `void`, meaning it does not return a value upon successful execution.

#### Response Example
N/A (void function)
```

--------------------------------

### Get Substring with llGetSubString (LSL)

Source: https://lsl.dev/functions/llGetSubString

The llGetSubString function in LSL extracts a portion of a given string. It takes the string, a start index, and an end index as input. Negative indices count backwards from the end of the string, and if the start index is greater than the end index, the result is an empty string.

```LSL
string llGetSubString(
  1. string String, 
  2. integer Start, 
  3. integer End
);
```

--------------------------------

### Get Linkset Datastore Keys (LSL)

Source: https://lsl.dev/functions/llLinksetDataListKeys

Retrieves a list of keys from the linkset datastore. The function accepts 'start' and 'count' integers to define the range of keys to return. A 'count' less than 1 returns all keys.

```LSL
list llLinksetDataListKeys(
  integer start, // First entry to return. 0 for start of list.
  integer count // Number of entries to return. Less than 1 for all keys.

);

```

--------------------------------

### Rez Object with Custom Parameters (Spinning, Cleanup)

Source: https://lsl.dev/functions/llRezObjectWithParams

This example shows how to rez an object with custom parameters, including its position, rotation speed, and temporary nature with automatic cleanup. It utilizes REZ_POS, REZ_OMEGA, and REZ_FLAGS.

```lsl
default
{
	touch_start(integer total_number)
	{
		llRezObjectWithParams("Object", [
			REZ_POS, <0,0,1>, TRUE, TRUE,
			REZ_OMEGA, <0,0,1>, TRUE, 0.5, PI,
			REZ_FLAGS, REZ_FLAG_TEMP
		]);
	}
}
```

--------------------------------

### Get Line from Notecard (LSL)

Source: https://lsl.dev/functions/llGetNotecardLineSync

Retrieves a specific line from a notecard by its name and line number. Returns 'EOF' if the line number is out of bounds or 'NAK' if the notecard is not cached. Line indexing starts at 0 in LSL.

```lsl
string llGetNotecardLineSync(
  1. string NotecardName,
  2. integer LineNumber
);
```

--------------------------------

### PRIM_PROJECTOR Settings

Source: https://lsl.dev/constants/PRIM_PROJECTOR

This section details the PRIM_PROJECTOR settings, including its integer ID and the parameters for its definition.

```APIDOC
## PRIM_PROJECTOR Settings

### Description
Provides details about the PRIM_PROJECTOR integer ID and its associated parameters for defining projector properties.

### Method
N/A (Configuration)

### Endpoint
N/A (Configuration)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "PRIM_PROJECTOR": 42
}
```

### Response
#### Success Response (200)
- **PRIM_PROJECTOR** (integer) - The unique identifier for the projector.
- **texture** (string) - The texture applied to the projector.
- **fov** (float) - The field of view of the projector.
- **focus** (float) - The focus setting of the projector.
- **ambiance** (float) - The ambiance setting of the projector.

#### Response Example
```json
{
  "PRIM_PROJECTOR": 42,
  "texture": "path/to/texture.png",
  "fov": 90.0,
  "focus": 1.0,
  "ambiance": 0.5
}
```
```

--------------------------------

### llGetSubString Function

Source: https://lsl.dev/functions/llGetSubString

Extracts a portion of a string based on start and end indices. Supports positive and negative indexing, and handles cases where the start index is greater than the end index.

```APIDOC
## llGetSubString Function

### Description
Returns a sub-string from a given string, within a specified range defined by start and end indices (inclusive). Negative indices count backwards from the end of the string. If the start index is greater than the end index, the result is an empty string.

### Function Signature
`string llGetSubString(string String, integer Start, integer End);`

### Parameters
#### Path Parameters
- **String** (string) - Required - The input string from which to extract the substring.
- **Start** (integer) - Required - The starting index of the substring (inclusive). Negative values count from the end of the string.
- **End** (integer) - Required - The ending index of the substring (inclusive). Negative values count from the end of the string.

### Request Example
```
// Example: Get characters from index 2 to 5 (inclusive)
string myString = "HelloWorld";
string sub = llGetSubString(myString, 2, 5);
// sub will be "lloW"

// Example: Get characters from index 0 to the second to last character
string sub2 = llGetSubString(myString, 0, -2);
// sub2 will be "HelloWorl"

// Example: Start index greater than end index
string sub3 = llGetSubString(myString, 5, 2);
// sub3 will be ""
```

### Response
#### Success Response (string)
- **Returns** (string) - The extracted substring.
```

--------------------------------

### Get Experience Details - LSL

Source: https://lsl.dev/functions/llGetExperienceDetails

Retrieves details for a given experience ID. If NULL_KEY is provided, it fetches details for the script's current experience. Returns a list containing the Experience Name, Owner ID, Group ID, Experience ID, State, and State Message.

```lsl
list experienceDetails = llGetExperienceDetails(key ExperienceID);
// or for the script's own experience:
list myExperienceDetails = llGetExperienceDetails(NULL_KEY);
```

--------------------------------

### PRIM_MEDIA_AUTO_LOOP

Source: https://lsl.dev/constants/PRIM_MEDIA_AUTO_LOOP

Gets or sets whether auto-looping is enabled for media. This is a boolean represented by an integer.

```APIDOC
## PRIM_MEDIA_AUTO_LOOP

### Description
Gets/Sets whether auto-looping is enabled. This is a boolean value represented as an integer.

### Method
GET/POST

### Endpoint
/websites/lsl_dev/PRIM_MEDIA_AUTO_LOOP

### Parameters
#### Query Parameters
- **PRIM_MEDIA_AUTO_LOOP** (integer) - Optional - The value to set for auto-looping (0 for false, 1 for true).

### Request Example
```json
{
  "PRIM_MEDIA_AUTO_LOOP": 1
}
```

### Response
#### Success Response (200)
- **PRIM_MEDIA_AUTO_LOOP** (integer) - Indicates whether auto-looping is enabled (0 for false, 1 for true).

#### Response Example
```json
{
  "PRIM_MEDIA_AUTO_LOOP": 1
}
```
```

--------------------------------

### llMakeFountain Function Documentation

Source: https://lsl.dev/functions/llMakeFountain

Details on how to use the llMakeFountain function, including its parameters and deprecated status.

```APIDOC
## llMakeFountain Function

### Description
Creates a fountain of particles. This function is deprecated and `llParticleSystem` should be used instead.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **Particles** (integer) - The number of particles to generate.
* **Scale** (float) - The scale of the particles.
* **Velocity** (float) - The initial velocity of the particles.
* **Lifetime** (float) - The lifetime of each particle in seconds.
* **Arc** (float) - The arc of the fountain.
* **Bounce** (integer) - The number of times particles will bounce.
* **Texture** (string) - The UUID of the texture to use for the particles. This texture must be in the object's inventory.
* **Offset** (vector) - The offset from the object's origin where the fountain will be created.
* **Bounce_Offset** (float) - The offset from the object's origin where particles will bounce.

### Request Example
```lsl
// Example usage (deprecated)
llMakeFountain(100, 0.1, 5.0, 2.0, 0.5, 3, "texture_uuid", <0,0,1>, 0.0);
```

### Response
#### Success Response (void)
This function does not return a value.

#### Response Example
N/A
```

--------------------------------

### llSetText Function

Source: https://lsl.dev/functions/llSetText

Sets text to float above a prim with a specified color and opacity.

```APIDOC
## llSetText Function

### Description
Causes Text to float above the prim, using the specified Color and Opacity.

### Method
void

### Endpoint
N/A (This is a function within the LSL scripting language, not a REST API endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
*   **Text** (string) - Required - The text to display.
*   **Color** (vector) - Required - The color of the text (e.g., \"<1.0, 1.0, 1.0>\").
*   **Opacity** (float) - Required - The opacity of the text (0.0 to 1.0).

### Request Example
```lsl
llSetText("Hello, World!", <1.0, 0.0, 0.0>, 1.0);
```

### Response
#### Success Response (void)
This function does not return a value.

#### Response Example
N/A
```

--------------------------------

### llDeleteSubList Function Syntax and Description

Source: https://lsl.dev/functions/llDeleteSubList

This snippet details the syntax of the llDeleteSubList function in LSL. It removes a slice from a list, defined by inclusive start and end indices, and returns the remaining list. Negative indices count from the end of the list, and specific handling is provided for start indices larger than end indices.

```lsl
list llDeleteSubList(
  1. list Source,
  2. integer Start,
  3. integer End
);

// Removes the slice from start to end and returns the remainder of the list.
// Remove a slice from the list and return the remainder, start and end are inclusive.
// Using negative numbers for start and/or end causes the index to count backwards from the length of the list, so 0, -1 would delete the entire list.
// If Start is larger than End the list deleted is the exclusion of the entries; so 6, 4 would delete the entire list except for the 5th. list entry.
```

--------------------------------

### llLinkParticleSystem

Source: https://lsl.dev/functions/llLinkParticleSystem

Creates a particle system in a specified linked prim based on a list of rules. An empty list removes the particle system. This function is similar to llParticleSystem but targets a specific linked prim.

```APIDOC
## llLinkParticleSystem

### Description
Creates a particle system in the prim specified by `LinkNumber` based on the provided `Rules` list. Passing an empty list for `Rules` will remove any existing particle system from that prim. This function is analogous to `llParticleSystem` but allows targeting a specific linked prim rather than just the prim containing the script.

### Method
void

### Parameters
#### Path Parameters
- **LinkNumber** (integer) - Required - The link number of the prim to apply the particle system to. Use 0 for unlinked, 1 for the root prim, or values greater than 1 for child prims. Can also accept LINK_* flags.
- **Rules** (list) - Required - A list defining the particle system rules. The format is `[ rule1, data1, rule2, data2, ..., ruleN, dataN ]`.

### Request Example
```lsl
integer linkNum = 1; // Target the root prim
list rules = [PSYS_PART_START_COLOR, <1.0, 0.0, 0.0>, PSYS_PART_MAX_AGE, 10.0, PSYS_PART_MAX_COUNT, 100];
llLinkParticleSystem(linkNum, rules);

// To remove the particle system:
llLinkParticleSystem(linkNum, []);
```

### Response
#### Success Response (void)
This function does not return a value upon successful execution.

#### Response Example
N/A
```

--------------------------------

### llListReplaceList

Source: https://lsl.dev/functions/llListReplaceList

Replaces a portion of a target list with another list. The start and end indices are inclusive.

```APIDOC
## llListReplaceList

### Description
Returns a list that is Target with Start through End removed and ListVariable inserted at Start. This function replaces the slice of the Target list from Start to End with the specified ListVariable. Start and End are inclusive.

### Method
N/A (This is a LSL function, not an HTTP API endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
- **list** (list) - The modified list.

#### Response Example
N/A
```

--------------------------------

### llListSortStrided Function Documentation

Source: https://lsl.dev/functions/llListSortStrided

Provides detailed information and usage examples for the llListSortStrided function.

```APIDOC
## llListSortStrided Function

### Description
Sorts a list by a specified element within strides in ascending or descending order. The sort only works if the first entry of each block is the same datatype.

### Function Syntax
```
list llListSortStrided(list ListVariable, integer Stride, integer Sortkey, integer Ascending);
```

### Parameters
#### Parameters
- **ListVariable** (list) - Required - The list to sort.
- **Stride** (integer) - Required - The stride length.
- **Sortkey** (integer) - Required - The zero-based element within the stride to use as the sort key.
- **Ascending** (integer) - Required - Boolean. TRUE for ascending order, FALSE for descending order.

### Returns
- **list** - The sorted list.

### Example
```
// Example usage:
list my_list = ["apple", 1, "banana", 2, "cherry", 3, "date", 4];
list sorted_list_asc = llListSortStrided(my_list, 2, 0, TRUE);
// sorted_list_asc will be ["apple", 1, "banana", 2, "cherry", 3, "date", 4]

list sorted_list_desc = llListSortStrided(my_list, 2, 0, FALSE);
// sorted_list_desc will be ["date", 4, "cherry", 3, "banana", 2, "apple", 1]
```
```

--------------------------------

### llGetExperienceDetails

Source: https://lsl.dev/functions/llGetExperienceDetails

Retrieves a list containing the name, owner ID, group ID, experience ID, state, and state message of an experience.

```APIDOC
## llGetExperienceDetails

### Description
Retrieves a list with the following Experience properties: [Experience Name, Owner ID, Group ID, Experience ID, State, State Message]. State is an integer corresponding to one of the constants XP_ERROR_… and State Message is the string returned by llGetExperienceErrorMessage for that integer.

### Method
N/A (This is a function call within LSL script, not an HTTP request)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```lsl
list experienceDetails = llGetExperienceDetails(NULL_KEY);
// Or specify an ExperienceID:
// list experienceDetails = llGetExperienceDetails("your_experience_id_key");
```

### Response
#### Success Response (List)
- **Experience Name** (string) - The name of the experience.
- **Owner ID** (key) - The UUID of the experience owner.
- **Group ID** (key) - The UUID of the group associated with the experience.
- **Experience ID** (key) - The UUID of the experience.
- **State** (integer) - An integer representing the current state of the experience (e.g., XP_ERROR_... constants).
- **State Message** (string) - A descriptive message for the current state.

#### Response Example
```lsl
// Assuming llGetExperienceDetails(NULL_KEY) returns:
// ["My Awesome Experience", "00000000-0000-0000-0000-000000000001", "00000000-0000-0000-0000-000000000002", "00000000-0000-0000-0000-000000000003", 0, "Success"]

string expName = llList2String(experienceDetails, 0);
key ownerId = llList2Key(experienceDetails, 1);
integer expState = llList2Integer(experienceDetails, 4);
string stateMsg = llList2String(experienceDetails, 5);

llSay(0, "Experience: " + expName + ", State: " + (string)expState + ", Message: " + stateMsg);
```
```

--------------------------------

### HTTP_USER_AGENT Configuration

Source: https://lsl.dev/constants/HTTP_USER_AGENT

Configure the HTTP User-Agent header value.

```APIDOC
## HTTP_USER_AGENT Configuration

### Description
Provide a string value to be included in the HTTP User-Agent header value. This is appended to the default value.

### Method
GET

### Endpoint
/websites/lsl_dev/HTTP_USER_AGENT

### Parameters
#### Query Parameters
- **HTTP_USER_AGENT** (integer) - Required - The integer value to be appended to the User-Agent header.

### Response
#### Success Response (200)
- **HTTP_USER_AGENT** (integer) - The configured integer value for the User-Agent header.

#### Response Example
{
  "HTTP_USER_AGENT": 7
}
```

--------------------------------

### LSL llGiveInventory Function Example

Source: https://lsl.dev/functions/llGiveInventory

This LSL code snippet demonstrates how to use the llGiveInventory function to give an inventory item to a specific target. The function takes the target's key and the inventory item's name as parameters. Ensure the necessary permissions are in place before execution.

```lsl
void llGiveInventory(
  key TargetID,
  string InventoryItem
);
```

--------------------------------

### llLinkAdjustSoundVolume

Source: https://lsl.dev/functions/llLinkAdjustSoundVolume

Adjusts the volume of the currently playing sound attached to a specified link. This function does not affect sounds started with llTriggerSound.

```APIDOC
## llLinkAdjustSoundVolume

### Description
Adjusts the volume (0.0 - 1.0) of the currently playing sound attached to the link. This function has no effect on sounds started with llTriggerSound.

### Method
N/A (This is a LSL function, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```lsl
// Example usage:
integer linkNum = 1; // Root prim
float volumeLevel = 0.5; // Set volume to 50%
llLinkAdjustSoundVolume(linkNum, volumeLevel);
```

### Response
#### Success Response (N/A)
This is an LSL function and does not return a value in the traditional sense.

#### Response Example
N/A
```

--------------------------------

### llReadKeyValue Function

Source: https://lsl.dev/functions/llReadKeyValue

Initiates an asynchronous request to get the value linked to a specified key. The result is delivered through the dataserver callback.

```APIDOC
## llReadKeyValue Function

### Description
Starts an asynchronous transaction to retrieve the value associated with the key given. Will fail with XP_ERROR_KEY_NOT_FOUND if the key does not exist. The dataserver callback will be executed with the key returned from this call and a string describing the result. The result is a two element comma-delimited list. The first item is an integer specifying if the transaction succeeded (1) or not (0). In the failure case, the second item will be an integer corresponding to one of the XP_ERROR_… constants. In the success case the second item will be the value associated with the key.

### Function Syntax
```c
key llReadKeyValue(
  1. string Key
);
```

### Parameters
#### Path Parameters
- **Key** (string) - Required - The key whose associated value needs to be retrieved.

### Response
#### Success Response (Dataserver Callback)
- **key** (key) - The key used in the llReadKeyValue call.
- **string** (string) - A comma-delimited list containing: 
  - The first element is an integer (1 for success, 0 for failure).
  - If successful, the second element is the value associated with the key.
  - If failed, the second element is an XP_ERROR_… constant indicating the error.

#### Response Example (Success)
```c
// In the dataserver callback:
// For a successful read of key "myKey" with value "someValue"
llListenCallback(key, "myKey,someValue");
```

#### Response Example (Failure)
```c
// In the dataserver callback:
// For a failed read of key "nonExistentKey" due to key not found
llListenCallback(key, "0,4"); // Assuming 4 is XP_ERROR_KEY_NOT_FOUND
```
```

--------------------------------

### llDataSizeKeyValue Function

Source: https://lsl.dev/functions/llDataSizeKeyValue

Initiates an asynchronous request to retrieve the used and total data allocated for the Experience. The dataserver callback receives the key and a comma-delimited string with the transaction status, used data, and total data.

```APIDOC
## llDataSizeKeyValue

### Description
Starts an asynchronous transaction to request the used and total amount of data allocated for the Experience. The dataserver callback will be executed with the key returned from this call and a string describing the result. The result is a comma-delimited list. The first item is an integer specifying if the transaction succeeded (1) or not (0). In the failure case, the second item will be an integer corresponding to one of the XP_ERROR_… constants. In the success case, the second item will be the amount in use and the third item will be the total available.

### Function Syntax
key llDataSizeKeyValue();

### Method
N/A (LSL Function)

### Endpoint
N/A (LSL Function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```lsl
// Example of calling llDataSizeKeyValue and handling the response
integer channel = 123;
llListen(channel, "", "", "");
key data_key = llDataSizeKeyValue();

default
{
    dataserver(key queryid, string data, integer id)
    {
        if (queryid == data_key)
        {
            list result = llCSV2List(data);
            integer success = (integer)llList2String(result, 0);
            
            if (success)
            {
                string used = llList2String(result, 1);
                string total = llList2String(result, 2);
                llOwnerSay("Data Allocation: Used = " + used + ", Total = " + total);
            }
            else
            {
                integer error_code = (integer)llList2String(result, 1);
                llOwnerSay("Failed to get data allocation. Error code: " + (string)error_code);
            }
        }
    }
}
```

### Response
#### Success Response (Dataserver callback)
- **result** (string) - A comma-delimited string. Format: "1,used_data,total_data"

#### Error Response (Dataserver callback)
- **result** (string) - A comma-delimited string. Format: "0,XP_ERROR_CODE"

#### Response Example
- **Success**: "1,10240,204800"
- **Failure**: "0,1001"
```

--------------------------------

### PRIM_OMEGA Constant and Rotation Parameters

Source: https://lsl.dev/constants/PRIM_OMEGA

This section describes the PRIM_OMEGA integer constant and the parameters used for object rotation.

```APIDOC
## PRIM_OMEGA Constant

### Description
The PRIM_OMEGA integer constant is defined as 32. It is used in conjunction with rotation parameters.

### Value
- **PRIM_OMEGA** (integer) - 32

## Rotation Parameters

### Description
These parameters define the rotation behavior of an object. PRIM_OMEGA is used to specify the rotation behavior.

### Method
Not Applicable (This describes parameters, not an endpoint)

### Endpoint
Not Applicable

### Parameters
#### Rotation Parameters
- **PRIM_OMEGA** (integer) - Used to indicate rotation behavior.
- **vector axis** (vector) - An arbitrary axis around which the object rotates.
- **float spinrate** (float) - The rate of rotation in radians per second. A value of zero may disable rotation.
- **float gain** (float) - Modulates the final spinrate and disables rotation behavior if zero.
```

--------------------------------

### Get Parcel Description (LSL)

Source: https://lsl.dev/constants/PARCEL_DETAILS_DESC

Retrieves the description of a parcel using the PARCEL_DETAILS_DESC constant. This is a read-only integer value.

```LSL
integer desc = llGetParcelDetails(PARCEL_DETAILS_DESC);
// desc now holds the parcel's description string.
```

--------------------------------

### PRIM_POINT_LIGHT Control

Source: https://lsl.dev/constants/PRIM_POINT_LIGHT

This section details the parameters for controlling a point light on an LSL primitive. It covers enabling/disabling the light, setting its color, intensity, radius, and falloff.

```APIDOC
## PRIM_POINT_LIGHT

### Description
Controls the properties of a point light attached to an LSL primitive.

### Method
llSetPrimitiveParams

### Endpoint
N/A (This is a function call within LSL script)

### Parameters
#### List Parameters
- **PRIM_POINT_LIGHT** (integer) - Required - The parameter to set the point light.

#### Arguments for PRIM_POINT_LIGHT
- **integer boolean** – Required - TRUE to enable the light, FALSE to disable.
- **vector linear_color** – Required - Linear color in RGB format (e.g., <1.0, 1.0, 1.0> for white). Ranges from <0.0, 0.0, 0.0> to <1.0, 1.0, 1.0>.
- **float intensity** – Required - The brightness of the light. Ranges from 0.0 to 1.0.
- **float radius** – Required - The radius of the light's influence. Ranges from 0.1 to 20.0.
- **float falloff** – Required - The rate at which the light intensity decreases with distance. Ranges from 0.01 to 2.0.

### Request Example
```lsl
// Example: Turn on a red point light with specific properties
llSetPrimitiveParams([PRIM_POINT_LIGHT, TRUE, <1.0, 0.0, 0.0>, 0.8, 5.0, 1.0]);

// Example: Turn off the point light
llSetPrimitiveParams([PRIM_POINT_LIGHT, FALSE]);
```

### Response
#### Success Response
N/A (This function call does not return a value directly, but modifies the primitive's state.)

#### Response Example
N/A
```

--------------------------------

### Get Object Damage Value (LSL)

Source: https://lsl.dev/constants/OBJECT_DAMAGE

Retrieves the damage value assigned to the current object. This is a built-in integer constant in LSL.

```lsl
integer damage = OBJECT_DAMAGE;
// Use the 'damage' variable to access the object's damage value.
```

--------------------------------

### llSetTextureAnim Function Documentation

Source: https://lsl.dev/functions/llSetTextureAnim

This section details the llSetTextureAnim function, its parameters, and usage for texture animation.

```APIDOC
## llSetTextureAnim Function

### Description
Animates a texture by setting the texture scale and offset. This function allows for frame-by-frame animation or continuous rotation/scaling of textures applied to an object's faces.

### Function Syntax
`void llSetTextureAnim(
  integer Mode, 
  integer Face, 
  integer SizeX, 
  integer SizeY, 
  float Start, 
  float Length, 
  float Rate
);`

### Parameters
#### Path Parameters
* **Mode** (integer) - Required - A bitmask of animation options (e.g., `ANIM_ON`, `LOOP`, `REVERSE`, `SMOOTH`, `ROTATE`, `SCALE`).
* **Face** (integer) - Required - The face number to animate, or `ALL_SIDES` to apply to all faces.
* **SizeX** (integer) - Required - The number of horizontal frames in the animation. Ignored for `ROTATE` and `SCALE` modes.
* **SizeY** (integer) - Required - The number of vertical frames in the animation. Ignored for `ROTATE` and `SCALE` modes.
* **Start** (float) - Required - The starting position or frame number for the animation. For `ROTATE` mode, this is in radians.
* **Length** (float) - Required - The duration of the animation in seconds, or the total angle in radians for `ROTATE` mode.
* **Rate** (float) - Required - The playback rate in frames per second. Must be greater than zero.

### Request Example
```c
// Example: Animate texture on face 0 with 4x4 frames, starting at frame 0, looping smoothly over 10 seconds at 15 FPS
llSetTextureAnim(ANIM_ON | LOOP | SMOOTH, 0, 4, 4, 0.0, 10.0, 15.0);

// Example: Rotate texture on all sides continuously at 0.5 radians per second
llSetTextureAnim(ROTATE, ALL_SIDES, 0, 0, 0.0, TWO_PI, 0.5);
```

### Response
This function does not return a value (void).
```

--------------------------------

### llSHA1String Function Documentation

Source: https://lsl.dev/functions/llSHA1String

This section details the llSHA1String function, its parameters, and return value.

```APIDOC
## llSHA1String Function

### Description
Returns a string of 40 hex characters that is the SHA1 security hash of the input text.

### Function Syntax
`string llSHA1String(string Text);`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
This function does not use a request body.

### Response
#### Success Response (200)
- **string** (string) - A 40-character hexadecimal string representing the SHA1 hash.

#### Response Example
```
"a94a8fe5ccb20590247aa2ff72e7f65d9349804d"
```
```

--------------------------------

### llGetNumberOfNotecardLines

Source: https://lsl.dev/functions/llGetNumberOfNotecardLines

Gets the number of lines in a notecard. The result is returned via the dataserver event. A key is returned which can be used to identify the dataserver reply.

```APIDOC
## llGetNumberOfNotecardLines

### Description
Returns the number of lines contained within a notecard via the dataserver event.
The key returned by this function is a query ID for identifying the dataserver reply.

### Method
Not Applicable (This is a LSL function, not an HTTP API endpoint)

### Endpoint
Not Applicable

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
// Example usage within LSL script
key queryID = llGetNumberOfNotecardLines("MyNotecard.txt");

// In the dataserver event handler:
// default
// {
//     dataserver(key query, string data)
//     {
//         if (query == queryID)
//         {
//             integer numLines = (integer)data;
//             llSay(0, "The notecard has " + (string)numLines + " lines.");
//         }
//     }
// }
```

### Response
#### Success Response (Dataserver Event)
- **data** (string) - A string representation of the number of lines in the notecard.

#### Response Example
```json
// Example data received in the dataserver event:
"150"
```
```

--------------------------------

### Get Inventory Creator Key (LSL)

Source: https://lsl.dev/functions/llGetInventoryCreator

Retrieves the UUID of the creator for a given inventory item. If the item does not exist in the inventory, a message is displayed.

```lsl
key llGetInventoryCreator(
  1. string InventoryItem
);

// Example Usage:
// default
// {
//     state_entry()
//     {
//         key creator = llGetInventoryCreator("My Item");
//         if (creator)
//         {
//             llSay(0, "Creator UUID: " + (string)creator);
//         }
//         else
//         {
//             llSay(0, "No item named 'My Item'.");
//         }
//     }
// }
```

--------------------------------

### llLoadURL Function Documentation

Source: https://lsl.dev/functions/llLoadURL

This section details the llLoadURL function, its parameters, and its behavior.

```APIDOC
## llLoadURL

### Description
Shows a dialog to the specified avatar (AvatarID) offering to load a web page at the given URL. If the user accepts, their default web browser will be launched to display the URL.

### Method
LSL Function

### Endpoint
N/A (This is an LSL function, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **AvatarID** (key) - The UUID of the avatar to whom the dialog will be shown.
- **Text** (string) - The text displayed in the dialog box to the user. This is the message prompting them to load the URL.
- **URL** (string) - The URL of the web page to be loaded.

### Request Example
```lsl
// Example usage within an LSL script
key targetAvatar = "00000000-0000-0000-0000-000000000000"; // Replace with actual Avatar ID
string message = "Would you like to visit our website?";
string websiteURL = "http://www.example.com";

llLoadURL(targetAvatar, message, websiteURL);
```

### Response
#### Success Response
This function does not return a value (void). Its effect is to display a dialog to the user.

#### Response Example
N/A (This function is void and does not return data.)
```

--------------------------------

### Setting Prim Text with PRIM_TEXT in LSL

Source: https://lsl.dev/constants/PRIM_TEXT

Demonstrates how to use the PRIM_TEXT constant with its corresponding function signature to set text on a prim. This function requires the prim's text, color, and alpha transparency.

```lsl
llSetPrimitiveParams([PRIM_TEXT, "Hello, World!", <1.0, 1.0, 0.0>, 1.0]);
```

--------------------------------

### TERRAIN_PBR_SCALE_1 Integer Constant in LSL

Source: https://lsl.dev/constants/TERRAIN_PBR_SCALE_1

TERRAIN_PBR_SCALE_1 is an integer constant used in LSL, with a default value of 8. No further description or usage examples are available.

```lsl
TERRAIN_PBR_SCALE_1 integer = 8
```

--------------------------------

### Get Prim Scale using llGetScale

Source: https://lsl.dev/functions/llGetScale

This function returns the scale of the prim. It takes no arguments and returns a vector representing the prim's dimensions.

```lsl
vector scale = llGetScale();
```

--------------------------------

### Set Payment Price and Quick Buttons in LSL

Source: https://lsl.dev/functions/llSetPayPrice

Sets the default payment price and up to four quick payment button values for an object. The Price parameter determines the default value in the payment input field, while QuickButtons defines the values for the payment dialog's buttons. The PAY_HIDE constant can be used to hide the input field and buttons, and PAY_DEFAULT resets them to their default states.

```LSL
void llSetPayPrice(
  integer Price, // The default price shown in the textu input field.
  list QuickButtons // Specifies the 4 payment values shown in the payment dialog's buttons (or PAY_HIDE).

);
```

--------------------------------

### LSL For Loop Syntax

Source: https://lsl.dev/controls/for

Demonstrates the basic syntax of a 'for' loop in LSL. This loop structure is used for repeating a block of code a specific number of times, controlled by an initializer, a condition, and a post-iteration statement.

```lsl
for (<initializer>; <condition>; <post-iteration-statement>)
{
  // Code to be executed in each iteration
}
```

--------------------------------

### Get Agent Count in Region (LSL)

Source: https://lsl.dev/constants/SIM_STAT_AGENT_COUNT

The SIM_STAT_AGENT_COUNT constant is an integer that returns the current number of agents in the region. This is a read-only value and does not require any parameters.

```lsl
integer agentCount = llRegionSay(0, (string)SIM_STAT_AGENT_COUNT);
// agentCount will now hold the number of agents in the region.
```

--------------------------------

### Create Particle System with llParticleSystem (LSL)

Source: https://lsl.dev/functions/llParticleSystem

The llParticleSystem function creates a particle system on the prim containing the script. It accepts a list of parameters that define the particle system's behavior. An empty list will remove any existing particle system.

```lsl
void llParticleSystem(
  list Parameters
);

// Example Usage:
// Creates a simple particle system
list myParticles = [
    PART_EMIT, TRUE, 
    PART_START_COLOR, <1.0, 0.0, 0.0>,
    PART_END_COLOR, <0.0, 0.0, 1.0>,
    PART_RADIUS_MIN, 0.1,
    PART_RADIUS_MAX, 0.5,
    PART_TARGET_LINEAR_VELOCITY, <0.0, 0.0, 1.0>,
    PART_MAX_AGE, 5.0,
    PART_TEXTURE, "b3d02153-437f-4221-944d-083368284746"
];
llParticleSystem(myParticles);

// To remove the particle system:
// llParticleSystem([]);
```

--------------------------------

### Get Object Position (LSL)

Source: https://lsl.dev/constants/OBJECT_POS

The OBJECT_POS constant returns the object's current position as a vector in region coordinates. This is a read-only integer value.

```lsl
integer pos = OBJECT_POS;
llSay(0, "My position is: " + (string)pos);
```

--------------------------------

### Define TERRAIN_PBR_ROTATION_2 Constant in LSL

Source: https://lsl.dev/constants/TERRAIN_PBR_ROTATION_2

This snippet shows the definition of the TERRAIN_PBR_ROTATION_2 constant in LSL. It is an integer with a value of 13. No further description or usage examples are available.

```lsl
TERRAIN_PBR_ROTATION_2 integer = 13
```

--------------------------------

### llLinksetDataFindKeys

Source: https://lsl.dev/functions/llLinksetDataFindKeys

Retrieves a list of keys from the linkset's data store that match a given regex search string. Allows for pagination by specifying start and count.

```APIDOC
## llLinksetDataFindKeys

### Description
Returns a list of keys from the linkset’s data store matching the search parameter. Allows for pagination.

### Method
N/A (This is a function call within LSL script, not an HTTP API endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```lsl
list keys = llLinksetDataFindKeys("^user_", 0, 10);
```

### Response
#### Success Response (N/A - Returns a list within the LSL script)
- **keys** (list) - A list of strings, where each string is a key found in the datastore matching the search criteria.

#### Response Example
```lsl
// Example return value if the search matches keys "user_123" and "user_456"
// [ "user_123", "user_456" ]
```
```

--------------------------------

### Setting Prim Color and Alpha in LSL

Source: https://lsl.dev/constants/PRIM_COLOR

This snippet demonstrates how to set the color and alpha of a specific face on a prim using the PRIM_COLOR constant in LSL. It takes the face index, a vector representing the RGB color, and a float for the alpha transparency as input.

```lsl
default
{
    state_entry()
    {
        // Set the color of face 0 to red with full alpha
        llSetPrimMediaParams(PRIM_COLOR, 0, <1.0, 0.0, 0.0>, 1.0);
        
        // Set the color of face 1 to blue with 50% alpha
        llSetPrimMediaParams(PRIM_COLOR, 1, <0.0, 0.0, 1.0>, 0.5);
    }
}
```

--------------------------------

### Create Key-Value Pair with llCreateKeyValue (LSL)

Source: https://lsl.dev/functions/llCreateKeyValue

Initiates an asynchronous transaction to create a key-value pair. It returns an XP_ERROR_STORAGE_EXCEPTION if the key already exists. A dataserver callback is triggered with the result of the transaction.

```LSL
key llCreateKeyValue(
  1. string Key,
  2. string Value
);
```

--------------------------------

### Give Agent Inventory with llGiveAgentInventory (LSL)

Source: https://lsl.dev/functions/llGiveAgentInventory

This LSL function allows you to give a list of inventory items to a specific agent. The items will be placed in a new folder with the specified name. Ensure the agent key is valid and that your script has the necessary permissions to perform this action. The 'Options' list can be used to control aspects of the inventory transfer.

```LSL
integer llGiveAgentInventory(
  key AgentID, // An agent in the region.
  string FolderName, // Folder name to give to the agent.
  list InventoryItems, // Inventory items to give to the agent.
  list Options // A list of option for inventory transfer.

);
```

--------------------------------

### PRIM_BUMP_CONCRETE Constant Definition (LSL)

Source: https://lsl.dev/constants/PRIM_BUMP_CONCRETE

Defines the PRIM_BUMP_CONCRETE integer constant, which is used in LSL scripting. Its value is 7. No further description or usage examples are available.

```lsl
integer PRIM_BUMP_CONCRETE = 7;
```
Tokens:
Raw