From 7fd5ce2aa37e1dd7f5eb893d9fc05952118d4d57 Mon Sep 17 00:00:00 2001 From: tapple Date: Sat, 4 Jul 2026 10:47:56 -0700 Subject: [PATCH 1/9] Review the wiki scrape for math_trig category and update the slua math table to the same style --- lsl_definitions.yaml | 27 ++++++++++++++------------- slua_definitions.yaml | 35 ++++++++++++++++++----------------- 2 files changed, 32 insertions(+), 30 deletions(-) diff --git a/lsl_definitions.yaml b/lsl_definitions.yaml index e01d1098..c539b8e8 100644 --- a/lsl_definitions.yaml +++ b/lsl_definitions.yaml @@ -7395,7 +7395,7 @@ functions: llAcos: arguments: - val: - tooltip: A floating-point value falling in the range [-1.0, 1.0]. + tooltip: A number in the range [-1.0, 1.0]. type: float slua-deprecated: use: math.acos @@ -7407,7 +7407,7 @@ functions: must-use: true # not pure because it might trigger a math error return: float sleep: 0.0 - tooltip: Returns a float representing the arc-cosine of val in radians. + tooltip: Returns the arccosine of val in radians. categories: - math - math_trig @@ -7579,7 +7579,7 @@ functions: llAsin: arguments: - val: - tooltip: A floating-point value falling in the range [-1.0, 1.0]. + tooltip: A number in the range [-1.0, 1.0]. type: float slua-deprecated: use: math.asin @@ -7591,17 +7591,17 @@ functions: must-use: true # not pure because it might trigger a math error return: float sleep: 0.0 - tooltip: Returns a float representing the arc-sine of val in radians. + tooltip: Returns the arcsine of val in radians. categories: - math - math_trig llAtan2: arguments: - y: - tooltip: A floating-point value representing the y coordinate. + tooltip: Y coordinate. type: float - x: - tooltip: A floating-point value representing the x coordinate. + tooltip: X coordinate. type: float slua-deprecated: use: math.atan2 @@ -7613,7 +7613,8 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the arctangent2 of y and x. + tooltip: "Returns the arctangent of y/x in radians, using the signs to determine the quadrant. + Note the argument order: Y is the first parameter, X is the second parameter." categories: - math - math_trig @@ -8065,7 +8066,7 @@ functions: llCos: arguments: - theta: - tooltip: Angle expressed in radians. + tooltip: An angle in radians. type: float slua-deprecated: use: math.cos @@ -8077,7 +8078,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the cosine of theta. + tooltip: Returns the cosine of theta. theta is in radians. categories: - math - math_trig @@ -15908,7 +15909,7 @@ functions: llSin: arguments: - theta: - tooltip: Angle expressed in radians. + tooltip: An angle in radians. type: float slua-deprecated: use: math.sin @@ -15920,7 +15921,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the sine of theta. + tooltip: Returns the sine of theta. theta is in radians. categories: - math - math_trig @@ -16286,7 +16287,7 @@ functions: llTan: arguments: - theta: - tooltip: Angle expressed in radians. + tooltip: An angle in radians. type: float slua-deprecated: use: math.tan @@ -16298,7 +16299,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the tangent of theta. + tooltip: Returns the tangent of theta. theta is in radians. categories: - math - math_trig diff --git a/slua_definitions.yaml b/slua_definitions.yaml index 3ddab340..c8ac450b 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -1636,29 +1636,29 @@ modules: fastcall: true typechecker: {checked: true} - name: acos - comment: Returns the arc cosine of n in radians. + comment: Returns the arccosine of val in radians. parameters: - - name: "n" - comment: "A number in the range [-1, 1]." + - name: val + comment: A number in the range [-1.0, 1.0]. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: asin - comment: Returns the arc sine of n in radians. + comment: Returns the arcsine of n in radians. parameters: - - name: "n" - comment: "A number in the range [-1, 1]." + - name: val + comment: A number in the range [-1.0, 1.0]. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: atan - comment: Returns the arc tangent of n in radians. + comment: Returns the arctangent of val in radians. parameters: - - name: "n" + - name: val comment: A number. type: number return-type: number @@ -1666,13 +1666,14 @@ modules: fastcall: true typechecker: {checked: true} - name: atan2 - comment: "Returns the arc tangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter." + comment: "Returns the arctangent of y/x in radians, using the signs to determine the quadrant. + Note the argument order: Y is the first parameter, X is the second parameter." parameters: - name: "y" - comment: Y-coordinate. + comment: Y coordinate. type: number - name: x - comment: X-coordinate. + comment: X coordinate. type: number return-type: number must-use: true @@ -1705,9 +1706,9 @@ modules: fastcall: true typechecker: {checked: true} - name: cos - comment: Returns the cosine of n. n is in radians. + comment: Returns the cosine of theta. theta is in radians. parameters: - - name: "n" + - name: theta comment: An angle in radians. type: number return-type: number @@ -1993,9 +1994,9 @@ modules: fastcall: true typechecker: {checked: true} - name: sin - comment: Returns the sine of n. n is in radians. + comment: Returns the sine of theta. theta is in radians. parameters: - - name: "n" + - name: theta comment: An angle in radians. type: number return-type: number @@ -2023,9 +2024,9 @@ modules: fastcall: true typechecker: {checked: true} - name: tan - comment: Returns the tangent of n. n is in radians. + comment: Returns the tangent of theta. theta is in radians. parameters: - - name: "n" + - name: theta comment: An angle in radians. type: number return-type: number From a2e98ada23c44ef44d7c86e1de1d06e9d999b0ec Mon Sep 17 00:00:00 2001 From: tapple Date: Sat, 4 Jul 2026 17:18:04 -0700 Subject: [PATCH 2/9] Review the wiki scrape for math category and update the slua math table to the same style --- lsl_definitions.yaml | 38 ++++++------ slua_definitions.yaml | 130 ++++++++++++++++++++++-------------------- 2 files changed, 86 insertions(+), 82 deletions(-) diff --git a/lsl_definitions.yaml b/lsl_definitions.yaml index c539b8e8..226ac0fd 100644 --- a/lsl_definitions.yaml +++ b/lsl_definitions.yaml @@ -7377,7 +7377,7 @@ functions: llAbs: arguments: - val: - tooltip: Any integer value. + tooltip: Integer to convert. type: integer slua-deprecated: use: math.abs @@ -7389,7 +7389,7 @@ functions: pure: true return: integer sleep: 0.0 - tooltip: Returns an integer representing the absolute (positive) value of val. + tooltip: Returns the absolute (positive) integer value of val. categories: - math llAcos: @@ -7838,7 +7838,7 @@ functions: llCeil: arguments: - val: - tooltip: Float value to round. + tooltip: Number to round up. type: float slua-deprecated: use: math.ceil @@ -7850,8 +7850,8 @@ functions: pure: true return: integer sleep: 0.0 - tooltip: Returns the smallest integer value greater than or equal to val - (rounded toward positive infinity). + tooltip: Returns val rounded toward positive infinity. + In other words, returns the smallest integer greater than or equal to val. categories: - math llChar: @@ -8796,7 +8796,7 @@ functions: llFabs: arguments: - val: - tooltip: Float value to convert. + tooltip: Number to convert. type: float slua-deprecated: use: math.abs @@ -8808,7 +8808,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the absolute (positive) value of val. + tooltip: Returns the absolute (positive) value of val. categories: - math llFindNotecardTextCount: @@ -8896,7 +8896,7 @@ functions: llFloor: arguments: - val: - tooltip: Float value to round. + tooltip: Number to round down. type: float slua-deprecated: use: math.floor @@ -8908,8 +8908,8 @@ functions: pure: true return: integer sleep: 0.0 - tooltip: Returns the largest integer value less than or equal to val (rounded - toward negative infinity). + tooltip: Returns val rounded toward negative infinity. + In other words, returns the largest integer less than or equal to val. categories: - math llForceMouselook: @@ -11564,6 +11564,7 @@ functions: - data_conversion - math - prim_appearance + - vector llLinkAdjustSoundVolume: arguments: - link: @@ -12545,7 +12546,7 @@ functions: llLog: arguments: - val: - tooltip: Float value to evaluate. + tooltip: Number to compute the logarithm of. type: float slua-deprecated: use: math.log @@ -12557,14 +12558,13 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the natural (base e) logarithm of the - positive value val (returns 0.0 if val <= 0). + tooltip: Returns natural (base e) logarithm of val. If negative, return 0.0. categories: - math llLog10: arguments: - val: - tooltip: Float value to evaluate. + tooltip: Number to compute the logarithm of. type: float slua-deprecated: use: math.log10 @@ -12576,8 +12576,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the base-10 (common) logarithm of the - positive value val (returns 0.0 if val <= 0). + tooltip: Returns base-10 (common) logarithm of val. If negative, return 0.0. categories: - math llLookAt: @@ -14317,7 +14316,7 @@ functions: llRound: arguments: - val: - tooltip: Float value to round. + tooltip: Number to round. type: float slua-deprecated: use: math.round @@ -16041,8 +16040,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the square root of the positive value val. - Triggers a math runtime error if val is less than 0.0 (imaginary results). + tooltip: Returns the square root of val. If negative, return Nan. categories: - math llStartAnimation: @@ -16939,8 +16937,10 @@ functions: tooltip: Returns a vector representing the conversion of the color srgb from the sRGB colorspace into the linear RGB colorspace. categories: + - data_conversion - math - prim_appearance + - vector types: float: tooltip: 32 bit floating point value.\nThe range is 1.175494351E-38 to 3.402823466E+38. diff --git a/slua_definitions.yaml b/slua_definitions.yaml index c8ac450b..599d71cc 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -1626,10 +1626,10 @@ modules: comment: Mathematical functions library. functions: - name: abs - comment: Returns the absolute value of n. + comment: Returns the absolute (positive) value of val. parameters: - - name: "n" - comment: A number. + - name: val + comment: Number to convert. type: number return-type: number must-use: true @@ -1637,19 +1637,21 @@ modules: typechecker: {checked: true} - name: acos comment: Returns the arccosine of val in radians. + Returns NaN if val is not in range [-1.0, 1.0]. parameters: - name: val - comment: A number in the range [-1.0, 1.0]. + comment: Cosine value in the range [-1.0, 1.0] to invert. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: asin - comment: Returns the arcsine of n in radians. + comment: Returns the arcsine of val in radians. + Returns NaN if val is not in range [-1.0, 1.0]. parameters: - name: val - comment: A number in the range [-1.0, 1.0]. + comment: Sine value in the range [-1.0, 1.0] to invert. type: number return-type: number must-use: true @@ -1659,7 +1661,7 @@ modules: comment: Returns the arctangent of val in radians. parameters: - name: val - comment: A number. + comment: Tangent value to invert. type: number return-type: number must-use: true @@ -1680,20 +1682,21 @@ modules: fastcall: true typechecker: {checked: true} - name: ceil - comment: Returns the smallest integer larger than or equal to n. + comment: Returns val rounded toward positive infinity. + In other words, returns the smallest integer greater than or equal to val. parameters: - - name: "n" - comment: A number to round up. + - name: val + comment: Number to round up. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: clamp - comment: Returns n clamped between min and max. Raises an error if min is greater than max. + comment: Returns val clamped between min and max. Raises an error if min is greater than max. parameters: - - name: "n" - comment: Value to be clamped. + - name: val + comment: The value to clamp. type: number - name: min comment: Minimum allowable value. @@ -1709,7 +1712,7 @@ modules: comment: Returns the cosine of theta. theta is in radians. parameters: - name: theta - comment: An angle in radians. + comment: Angle in radians. type: number return-type: number must-use: true @@ -1718,38 +1721,39 @@ modules: - name: cosh comment: Returns the hyperbolic cosine of n. parameters: - - name: "n" - comment: A number to compute the hyperbolic cosine of. + - name: val + comment: Number to compute the hyperbolic cosine of. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: deg - comment: Converts n from radians to degrees. + comment: Converts val from radians to degrees. parameters: - - name: "n" - comment: A value in radians. + - name: val + comment: Number in radians. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: exp - comment: Returns the base-e exponent of n. + comment: Returns the e to the power of val. parameters: - - name: "n" - comment: A number to compute e^n. + - name: val + comment: Number to compute e^n. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: floor - comment: Returns the largest integer smaller than or equal to n. + comment: Returns val rounded toward negative infinity. + In other words, returns the largest integer less than or equal to val. parameters: - - name: "n" - comment: A number to round down. + - name: val + comment: Number to round down. type: number return-type: number must-use: true @@ -1769,10 +1773,10 @@ modules: fastcall: true typechecker: {checked: true} - name: frexp - comment: Returns m and e such that n = m * 2^e. + comment: Returns significand s and integer exponent e such that val = s * 2^e. parameters: - - name: "n" - comment: A number to split into significand and exponent. + - name: val + comment: Number to split into significand and exponent. type: number return-type: (number, number) must-use: true @@ -1808,10 +1812,10 @@ modules: fastcall: true typechecker: {checked: true} - name: log - comment: Returns the logarithm of n in the given base, defaults to e. + comment: Returns the logarithm of val in the given base. The default base is e. parameters: - - name: "n" - comment: A number to compute logarithm. + - name: val + comment: Number to compute the logarithm of. type: number - name: base comment: Base of the logarithm. @@ -1822,19 +1826,19 @@ modules: fastcall: true typechecker: {checked: true} - name: log10 - comment: Returns the base-10 logarithm of n. + comment: Returns the base-10 logarithm of val. parameters: - - name: "n" - comment: A number to compute base-10 logarithm. + - name: val + comment: Number to compute base-10 logarithm. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: map - comment: Maps n from input range to output range. + comment: Maps val from input range to output range. parameters: - - name: "n" + - name: val comment: Number to map. type: number - name: inMin @@ -1855,8 +1859,8 @@ modules: - name: max comment: Returns the maximum value from the given numbers. parameters: - - name: "n" - comment: A number to find the maximum from. + - name: val + comment: Number to find the maximum from. type: number - name: ... comment: Numbers to find the maximum from. @@ -1869,8 +1873,8 @@ modules: - name: min comment: Returns the minimum value from the given numbers. parameters: - - name: "n" - comment: A number to find the minimum from. + - name: val + comment: Number to find the minimum from. type: number - name: ... comment: Numbers to find the minimum from. @@ -1881,10 +1885,10 @@ modules: fastcall: true typechecker: {checked: true} - name: modf - comment: Returns the integer and fractional parts of n. + comment: Returns the integer and fractional parts of val. parameters: - - name: "n" - comment: A number to split into integer and fractional parts. + - name: val + comment: Number to split into integer and fractional parts. type: number return-type: (number, number) must-use: true @@ -1921,10 +1925,10 @@ modules: fastcall: true typechecker: {checked: true} - name: rad - comment: Converts n from degrees to radians. + comment: Converts val from degrees to radians. parameters: - name: "n" - comment: A value in degrees. + comment: Value in degrees. type: number return-type: number must-use: true @@ -1974,20 +1978,20 @@ modules: reason: Disabled in SLua. typechecker: {checked: true} - name: round - comment: Rounds n to the nearest integer. + comment: Rounds val to the nearest integer. Halfway values are rounded away from zero. parameters: - - name: "n" - comment: A number to round to the nearest integer. Halfway values are rounded away from zero. + - name: val + comment: Number to round to the nearest integer. Halfway values are rounded away from zero. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: sign - comment: Returns -1 if n is negative, 1 if positive, and 0 if zero. + comment: Returns -1 if val is negative, 1 if positive, and 0 if zero. parameters: - - name: "n" - comment: A number to get the sign of. + - name: val + comment: Number to get the sign of. type: number return-type: number must-use: true @@ -1997,27 +2001,27 @@ modules: comment: Returns the sine of theta. theta is in radians. parameters: - name: theta - comment: An angle in radians. + comment: Angle in radians. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: sinh - comment: Returns the hyperbolic sine of n. + comment: Returns the hyperbolic sine of val. parameters: - - name: "n" - comment: A number to compute the hyperbolic sine of. + - name: val + comment: Number to compute the hyperbolic sine of. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: sqrt - comment: Returns the square root of n. + comment: Returns the square root of val. If negative, return Nan. parameters: - - name: "n" - comment: A number to compute the square root of. + - name: val + comment: Number to compute the square root of. type: number return-type: number must-use: true @@ -2027,17 +2031,17 @@ modules: comment: Returns the tangent of theta. theta is in radians. parameters: - name: theta - comment: An angle in radians. + comment: Angle in radians. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: tanh - comment: Returns the hyperbolic tangent of n. + comment: Returns the hyperbolic tangent of val. parameters: - - name: "n" - comment: A number to compute the hyperbolic tangent of. + - name: val + comment: Number to compute the hyperbolic tangent of. type: number return-type: number must-use: true @@ -2079,7 +2083,7 @@ modules: type: number value: 3.141592653589793 - name: huge - comment: A value larger than any other numeric value (infinity). + comment: Value larger than any other numeric value (infinity). type: number value: inf - name: os From 43673433913336f1b578964f1480944fc865e067 Mon Sep 17 00:00:00 2001 From: tapple Date: Wed, 8 Jul 2026 11:55:20 -0700 Subject: [PATCH 3/9] Review the wiki scrape for math category and update the slua math table to the same style --- lsl_definitions.yaml | 32 ++++++++++++++------------- slua_definitions.yaml | 51 +++++++++++++++++++++++-------------------- 2 files changed, 44 insertions(+), 39 deletions(-) diff --git a/lsl_definitions.yaml b/lsl_definitions.yaml index 226ac0fd..615916c2 100644 --- a/lsl_definitions.yaml +++ b/lsl_definitions.yaml @@ -12445,14 +12445,15 @@ functions: type: integer enum-semantics: ListStatisticsOperation - src: - tooltip: List of floats and integers to analyze. + tooltip: List of numbers to analyze. type: list + slua-type: "{number}" energy: 10.0 func-id: 315 must-use: true return: float sleep: 0.0 - tooltip: Returns a float representing the result of performing the statistical + tooltip: Returns the numeric result of the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. categories: @@ -12923,22 +12924,24 @@ functions: - script llModPow: arguments: - - a: - tooltip: Base integer value. + - base: + tooltip: 32-bit unsigned integer base. type: integer - - b: - tooltip: Power exponent (capped at 0xFFFF / 16 bits). + - exponent: + tooltip: 32-bit unsigned integer exponent. type: integer - - c: - tooltip: Modulus integer value. + - modulus: + tooltip: 32-bit unsigned integer modulus. type: integer energy: 10.0 func-id: 300 pure: true return: integer sleep: 0.0 - tooltip: Returns an integer representing a raised to the power b, modulo c - (i.e., (a**b)%c). The b value is capped at 0xFFFF (16 bits). + tooltip: Returns base raised to the power exponent, modulo modulus (i.e., (b^e)%m). + All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. + Output is wrapped to signed 32-bit integer range [-2147483648..2147483647]. + Will never overflow, unlike (b^e), which can overflow to inf. categories: - math llModifyLand: @@ -13325,10 +13328,10 @@ functions: llPow: arguments: - base: - tooltip: Base float value. + tooltip: Base number. type: float - exponent: - tooltip: Exponent float value. + tooltip: Exponent number. type: float slua-deprecated: use: "^" @@ -13340,8 +13343,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing base raised to the power exponent. Returns - 0 and triggers a Math Error for imaginary results. + tooltip: Returns base raised to the power exponent. If result is imaginary, returns NaN. categories: - math llPreloadSound: @@ -14327,7 +14329,7 @@ functions: must-use: true return: integer sleep: 0.0 - tooltip: Returns the integer that float val is closest to. + tooltip: Rounds val to the nearest integer. Halfway values are rounded toward infinity. categories: - math llSHA1String: diff --git a/slua_definitions.yaml b/slua_definitions.yaml index 599d71cc..c1a6ce49 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -1696,7 +1696,7 @@ modules: comment: Returns val clamped between min and max. Raises an error if min is greater than max. parameters: - name: val - comment: The value to clamp. + comment: Number to clamp. type: number - name: min comment: Minimum allowable value. @@ -1760,20 +1760,23 @@ modules: fastcall: true typechecker: {checked: true} - name: fmod - comment: Returns the remainder of x modulo y, rounded towards zero. + comment: Returns the remainder (modulo) of dividend/modulus, (i.e. d mod m), rounded towards zero. + Returns NaN if modulus is 0. Identical to d % m if both arguments have the same sign. parameters: - - name: x + - name: dividend comment: Dividend. type: number - - name: "y" - comment: Divisor. + - name: modulus + comment: Modulus. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: frexp - comment: Returns significand s and integer exponent e such that val = s * 2^e. + comment: Breaks a floating-point number into it's component parts significand and exponent. + In other words, Returns significand s and integer exponent e such that val = s * 2^e. + Inverse of math.ldexp. parameters: - name: val comment: Number to split into significand and exponent. @@ -1783,12 +1786,12 @@ modules: fastcall: true typechecker: {checked: true} - name: ldexp - comment: Returns s * 2^e. + comment: Returns s * 2^e. Inverse of math.frexp parameters: - - name: s + - name: significand comment: Significand. type: number - - name: e + - name: exponent comment: Exponent. type: number return-type: number @@ -1796,12 +1799,12 @@ modules: fastcall: true typechecker: {checked: true} - name: lerp - comment: Linearly interpolates between a and b using factor t. + comment: Linearly interpolates between start and end using factor t. parameters: - - name: a + - name: start comment: Start value. type: number - - name: b + - name: end comment: End value. type: number - name: t @@ -2048,9 +2051,9 @@ modules: fastcall: true typechecker: {checked: true} - name: isnan - comment: Returns true if n is NaN. + comment: Returns true if val is NaN. parameters: - - name: "n" + - name: val comment: Number to check as NaN. type: number return-type: boolean @@ -2058,9 +2061,9 @@ modules: fastcall: true typechecker: {checked: true} - name: isinf - comment: Returns true if n is infinite. + comment: Returns true if val is infinite. parameters: - - name: "n" + - name: val comment: Number to check as infinite. type: number return-type: boolean @@ -2068,9 +2071,9 @@ modules: fastcall: true typechecker: {checked: true} - name: isfinite - comment: Returns true if n is finite. + comment: Returns true if val is finite. parameters: - - name: "n" + - name: val comment: Number to check as finite. type: number return-type: boolean @@ -2218,12 +2221,12 @@ modules: must-use: true typechecker: {checked: true} - name: slerp - comment: Spherical linear interpolation from a to b using factor t. + comment: Spherical linear interpolation from start to end using factor t. parameters: - - name: a + - name: start comment: Start quaternion. type: quaternion - - name: b + - name: end comment: End quaternion. type: quaternion - name: t @@ -3078,12 +3081,12 @@ modules: fastcall: true typechecker: {checked: true} - name: lerp - comment: Linearly interpolates between a and b using factor t. + comment: Linearly interpolates between start and end using factor t. parameters: - - name: a + - name: start comment: Start vector. type: vector - - name: b + - name: end comment: End vector. type: vector - name: t From 80e04920306316f9d340e9589e3c9def5bc7c130 Mon Sep 17 00:00:00 2001 From: tapple Date: Wed, 8 Jul 2026 13:19:40 -0700 Subject: [PATCH 4/9] Review the wiki scrape for vector category and update the slua vector table to the same style --- lsl_definitions.yaml | 13 +++++----- slua_definitions.yaml | 59 ++++++++++++++++++++++--------------------- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/lsl_definitions.yaml b/lsl_definitions.yaml index 615916c2..a4720ffb 100644 --- a/lsl_definitions.yaml +++ b/lsl_definitions.yaml @@ -11551,14 +11551,14 @@ functions: llLinear2sRGB: arguments: - color: - tooltip: RGB color vector in linear space to convert. + tooltip: Color vector in the linear RGB space to convert. type: vector energy: 10.0 func-id: 715 must-use: true return: vector sleep: 0.0 - tooltip: Returns a vector representing the conversion of color from the linear + tooltip: Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace. categories: - data_conversion @@ -16705,8 +16705,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the magnitude (geometric length) of the - vector vec. + tooltip: Returns the magnitude (geometric length) of vec. categories: - math - math_3d @@ -16725,7 +16724,7 @@ functions: pure: true return: vector sleep: 0.0 - tooltip: Returns a normalized unit vector sharing the same direction as vec. + tooltip: Returns the normalized unit vector pointing the same direction as vec. categories: - math - math_3d @@ -16928,7 +16927,7 @@ functions: - data_conversion llsRGB2Linear: arguments: - - srgb: + - color: tooltip: Color vector in the sRGB colorspace to convert. type: vector energy: 10.0 @@ -16936,7 +16935,7 @@ functions: must-use: true return: vector sleep: 0.0 - tooltip: Returns a vector representing the conversion of the color srgb from the + tooltip: Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace. categories: - data_conversion diff --git a/slua_definitions.yaml b/slua_definitions.yaml index c1a6ce49..ceadbe82 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -2936,32 +2936,32 @@ modules: fastcall: true typechecker: {checked: true} - name: magnitude - comment: Computes the magnitude of the vector. + comment: Returns the magnitude (geometric length) of vec. parameters: - - name: v - comment: Input vector. + - name: vec + comment: Vector to evaluate. type: vector return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: normalize - comment: Computes the normalized version (unit vector) of the vector. + comment: Returns the normalized unit vector pointing the same direction as vec. parameters: - - name: v - comment: Input vector. + - name: vec + comment: Vector to normalize. type: vector return-type: vector must-use: true fastcall: true typechecker: {checked: true} - name: cross - comment: Computes the cross product of two vectors. + comment: Returns the cross product of two vectors. parameters: - - name: a + - name: vec1 comment: Left input vector. type: vector - - name: b + - name: vec2 comment: Right input vector. type: vector return-type: vector @@ -2969,12 +2969,12 @@ modules: fastcall: true typechecker: {checked: true} - name: dot - comment: Computes the dot product of two vectors. + comment: Returns the dot product of two vectors. parameters: - - name: a + - name: vec1 comment: Left input vector. type: vector - - name: b + - name: vec2 comment: Right input vector. type: vector return-type: number @@ -2982,13 +2982,14 @@ modules: fastcall: true typechecker: {checked: true} - name: angle - comment: Computes the angle between two vectors in radians. + comment: Returns the angle between two vectors in radians. The axis, if specified, is used to determine the sign of the angle. + If no axis is specified, the angle is positive, as if axis was vector.cross(vec1, vec2). parameters: - - name: a + - name: vec1 type: vector comment: Left input vector. - - name: b + - name: vec2 comment: Right input vector. type: vector - name: axis @@ -3001,8 +3002,8 @@ modules: - name: floor comment: Applies math.floor to each component of the vector. parameters: - - name: v - comment: Input vector. + - name: vec + comment: Vector to round down. type: vector return-type: vector must-use: true @@ -3011,8 +3012,8 @@ modules: - name: ceil comment: Applies math.ceil to each component of the vector. parameters: - - name: v - comment: Input vector. + - name: vec + comment: Vector to round up. type: vector return-type: vector must-use: true @@ -3021,8 +3022,8 @@ modules: - name: abs comment: Applies math.abs to each component of the vector. parameters: - - name: v - comment: Input vector. + - name: vec + comment: Vector to convert. type: vector return-type: vector must-use: true @@ -3031,8 +3032,8 @@ modules: - name: sign comment: Applies math.sign to each component of the vector. parameters: - - name: v - comment: Input vector. + - name: vec + comment: Vector to get the sign of. type: vector return-type: vector must-use: true @@ -3041,8 +3042,8 @@ modules: - name: clamp comment: Clamps each component of the vector between min and max values. parameters: - - name: v - comment: Input vector to be clamped. + - name: vec + comment: Vector to be clamped. type: vector - name: min comment: Minimum vector value. @@ -3057,8 +3058,8 @@ modules: - name: max comment: Applies math.max to each component of the vectors. parameters: - - name: v - comment: Input vector. + - name: vec + comment: Vector to find the maximum from. type: vector - name: ... comment: Vectors to find the maximum from. @@ -3070,8 +3071,8 @@ modules: - name: min comment: Applies math.min to each component of the vectors. parameters: - - name: v - comment: Input vector. + - name: vec + comment: Vector to find the minimum from. type: vector - name: ... comment: Vectors to find the minimum from. From 8041f56ee68487ce0f4cafdf74ce98b972e4ddfa Mon Sep 17 00:00:00 2001 From: tapple Date: Wed, 8 Jul 2026 14:23:10 -0700 Subject: [PATCH 5/9] Review the wiki scrape for quaternion category and update the slua quaternion table to the same style --- lsl_definitions.yaml | 63 ++++++++++++++++++--------------------- slua_definitions.yaml | 68 +++++++++++++++++++++++-------------------- 2 files changed, 65 insertions(+), 66 deletions(-) diff --git a/lsl_definitions.yaml b/lsl_definitions.yaml index a4720ffb..f11d82aa 100644 --- a/lsl_definitions.yaml +++ b/lsl_definitions.yaml @@ -7518,10 +7518,10 @@ functions: - prim_inventory llAngleBetween: arguments: - - a: + - start_rot: tooltip: Starting rotation. type: rotation - - b: + - end_rot: tooltip: Ending rotation. type: rotation energy: 10.0 @@ -7529,8 +7529,7 @@ functions: pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the angle in radians between rotations a - and b. + tooltip: Returns the angle, in radians, between rotations start_rot and and end_rot. categories: - math - math_3d @@ -7714,18 +7713,17 @@ functions: llAxisAngle2Rot: arguments: - axis: - tooltip: Axis vector around which the rotation is generated. + tooltip: Axis vector to rotate around. type: vector - angle: - tooltip: Angle of rotation, expressed in radians. + tooltip: Angle to rotate, in radians. type: float energy: 10.0 func-id: 169 pure: true return: rotation sleep: 0.0 - tooltip: Returns the rotation representing a generated angle (in radians) about - the specified axis. + tooltip: Returns the rotation that rotates angle radians around the axis vector. categories: - math - math_3d @@ -8742,15 +8740,15 @@ functions: - web llEuler2Rot: arguments: - - v: - tooltip: Vector of Euler angles to convert. + - vec: + tooltip: Vector of Euler angles to convert, in radians. type: vector energy: 10.0 func-id: 16 pure: true return: rotation sleep: 0.0 - tooltip: Returns the rotation representation of the Euler angles vector v. + tooltip: Returns the quaternion representation of the Euler angles (in radians) within vec. categories: - math - math_3d @@ -14111,15 +14109,15 @@ functions: - rez llRot2Angle: arguments: - - rot: - tooltip: Rotation value. + - q: + tooltip: Rotation to evaluate. type: rotation energy: 10.0 func-id: 171 pure: true return: float sleep: 0.0 - tooltip: Returns a float representing the rotation angle of rot. + tooltip: Returns the angle, in radians, that q rotates. categories: - math - math_3d @@ -14127,15 +14125,15 @@ functions: - quaternion llRot2Axis: arguments: - - rot: - tooltip: Rotation value. + - q: + tooltip: Rotation to evaluate. type: rotation energy: 10.0 func-id: 170 pure: true return: vector sleep: 0.0 - tooltip: Returns a vector representing the rotation axis of rot. + tooltip: Returns the unit vector axis that q rotates around. categories: - math - math_3d @@ -14144,16 +14142,15 @@ functions: - vector llRot2Euler: arguments: - - quat: - tooltip: Rotation value to convert. + - q: + tooltip: Rotation to convert. type: rotation energy: 10.0 func-id: 15 pure: true return: vector sleep: 0.0 - tooltip: Returns a vector representing the Euler rotation (roll, pitch, yaw) of - quat, with each component expressed in radians. + tooltip: Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles will be in radians. categories: - math - math_3d @@ -14161,7 +14158,7 @@ functions: llRot2Fwd: arguments: - q: - tooltip: Rotation value. + tooltip: Rotation to convert. type: rotation slua-deprecated: use: quaternion.tofwd @@ -14171,9 +14168,8 @@ functions: pure: true return: vector sleep: 0.0 - tooltip: Returns a unit vector pointing in the local positive X direction - (forward) relative to the parent (root prim or region) defined by rotation - q. + tooltip: Returns the unit vector pointing toward positive X (forward) + in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q. categories: - math - math_3d @@ -14183,7 +14179,7 @@ functions: llRot2Left: arguments: - q: - tooltip: Rotation value. + tooltip: Rotation to convert. type: rotation slua-deprecated: use: quaternion.toleft @@ -14193,8 +14189,8 @@ functions: pure: true return: vector sleep: 0.0 - tooltip: Returns a unit vector pointing in the local positive Y direction (left) - relative to the parent (root prim or region) defined by rotation q. + tooltip: Returns the unit vector pointing toward positive Y (left) + in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q. categories: - math - math_3d @@ -14204,7 +14200,7 @@ functions: llRot2Up: arguments: - q: - tooltip: Rotation value. + tooltip: Rotation to convert. type: rotation slua-deprecated: use: quaternion.toup @@ -14214,8 +14210,8 @@ functions: pure: true return: vector sleep: 0.0 - tooltip: Returns a unit vector pointing in the local positive Z direction (up) - relative to the parent (root prim or region) defined by rotation q. + tooltip: Returns the unit vector pointing toward positive Z (up) + in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q. categories: - math - math_3d @@ -14228,15 +14224,14 @@ functions: tooltip: Starting vector. type: vector - end_vec: - tooltip: Target ending vector. + tooltip: Ending vector. type: vector energy: 10.0 func-id: 21 pure: true return: rotation sleep: 0.0 - tooltip: Returns a rotation representing the shortest path rotation from vector - start to vector end. + tooltip: Returns the shortest-path quaternion that rotates start_vec onto end_vec. categories: - math - math_3d diff --git a/slua_definitions.yaml b/slua_definitions.yaml index ceadbe82..beb2cec0 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -1802,10 +1802,10 @@ modules: comment: Linearly interpolates between start and end using factor t. parameters: - name: start - comment: Start value. + comment: Starting value. type: number - name: end - comment: End value. + comment: Ending value. type: number - name: t comment: Interpolation factor. @@ -2191,30 +2191,30 @@ modules: must-use: true typechecker: {checked: true} - name: normalize - comment: Computes the normalized version (unit quaternion) of the quaternion. + comment: Returns the normalized unit quaternion pointing the same direction as q. parameters: - name: q - comment: Input quaternion. + comment: Quaternion to normalize. type: quaternion return-type: quaternion must-use: true typechecker: {checked: true} - name: magnitude - comment: Computes the magnitude of the quaternion. + comment: Returns the magnitude (geometric length) of the quaternion. parameters: - name: q - comment: Input quaternion. + comment: Quaternion to evaluate. type: quaternion return-type: number must-use: true typechecker: {checked: true} - name: dot - comment: Computes the dot product of two quaternions. + comment: Returns the dot product of two quaternions. parameters: - - name: a + - name: q1 comment: Left input quaternion. type: quaternion - - name: b + - name: q2 comment: Right input quaternion. type: quaternion return-type: number @@ -2224,10 +2224,10 @@ modules: comment: Spherical linear interpolation from start to end using factor t. parameters: - name: start - comment: Start quaternion. + comment: Starting quaternion. type: quaternion - name: end - comment: End quaternion. + comment: Ending quaternion. type: quaternion - name: t comment: Interpolation factor. @@ -2236,37 +2236,41 @@ modules: must-use: true typechecker: {checked: true} - name: conjugate - comment: Computes the conjugate of the quaternion. + comment: Returns the conjugate of the quaternion. + Equivilant to quaternion(-q.x, -q.y, -q.z, q.s)) parameters: - name: q - comment: Input quaternion. + comment: Quaternion to conjugate. type: quaternion return-type: quaternion must-use: true typechecker: {checked: true} - name: tofwd - comment: Computes the forward vector from the quaternion. + comment: Returns the unit vector pointing toward positive X direction (forward) + in the coordinate space of rotation q. Equivilant to vector(1, 0, 0) * q. parameters: - name: q - comment: Input quaternion. + comment: Quaternion to convert. type: quaternion return-type: vector must-use: true typechecker: {checked: true} - name: toleft - comment: Computes the left vector from the quaternion. + comment: Returns the unit vector pointing toward positive Y direction (left) + in the coordinate space of rotation q. Equivilant to vector(0, 1, 0) * q. parameters: - name: q - comment: Input quaternion. + comment: Quaternion to convert. type: quaternion return-type: vector must-use: true typechecker: {checked: true} - name: toup - comment: Computes the up vector from the quaternion. + comment: Returns the unit vector pointing toward positive Z direction (up) + in the coordinate space of rotation q. Equivilant to vector(0, 0, 1) * q. parameters: - name: q - comment: Input quaternion. + comment: Quaternion to convert. type: quaternion return-type: vector must-use: true @@ -2936,7 +2940,7 @@ modules: fastcall: true typechecker: {checked: true} - name: magnitude - comment: Returns the magnitude (geometric length) of vec. + comment: Returns the magnitude (geometric length) of the vector. parameters: - name: vec comment: Vector to evaluate. @@ -2958,11 +2962,11 @@ modules: - name: cross comment: Returns the cross product of two vectors. parameters: - - name: vec1 - comment: Left input vector. + - name: start_vec + comment: Starting vector. type: vector - - name: vec2 - comment: Right input vector. + - name: end_vec + comment: Ending vector. type: vector return-type: vector must-use: true @@ -2982,15 +2986,15 @@ modules: fastcall: true typechecker: {checked: true} - name: angle - comment: Returns the angle between two vectors in radians. + comment: Returns the angle from start_vec to end_vec in radians. The axis, if specified, is used to determine the sign of the angle. - If no axis is specified, the angle is positive, as if axis was vector.cross(vec1, vec2). + If no axis is specified, the angle is positive, as if axis was vector.cross(start_vec, end_vec). parameters: - - name: vec1 + - name: start_vec type: vector - comment: Left input vector. - - name: vec2 - comment: Right input vector. + comment: Starting vector. + - name: end_vec + comment: Ending vector. type: vector - name: axis comment: Axis to determine the sign of the angle. @@ -3085,10 +3089,10 @@ modules: comment: Linearly interpolates between start and end using factor t. parameters: - name: start - comment: Start vector. + comment: Starting vector. type: vector - name: end - comment: End vector. + comment: Ending vector. type: vector - name: t comment: Interpolation factor. From 11a13f0df1624d46aacbae6555f318060c63ec4c Mon Sep 17 00:00:00 2001 From: tapple Date: Wed, 8 Jul 2026 14:57:21 -0700 Subject: [PATCH 6/9] Style slua bit32 table like math --- slua_definitions.yaml | 110 +++++++++++++++++++++--------------------- 1 file changed, 55 insertions(+), 55 deletions(-) diff --git a/slua_definitions.yaml b/slua_definitions.yaml index beb2cec0..05d9f9e2 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -748,12 +748,12 @@ modules: functions: - name: arshift comment: |- - Shifts n by i bits to the right. If i is negative, a left shift is performed. + Returns val shifted by i bits to the right. If i is negative, a left shift is performed. Does an arithmetic shift: The most significant bit of n is propagated during the shift. Returns 0 if i < -31, or all sign bits if i > 31. parameters: - - name: "n" - comment: Number to shift. + - name: val + comment: Integer to shift. type: number - name: i comment: Number of bits to shift. @@ -763,68 +763,67 @@ modules: fastcall: true typechecker: {checked: true} - name: band - comment: Performs a bitwise AND operation on input numbers. + comment: Returns the bitwise AND of the given numbers. parameters: - name: ... - comment: Numbers to perform bitwise AND on. + comment: Integers to perform bitwise AND on. type: ...number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: bnot - comment: Returns the bitwise negation of the input number. + comment: Returns the bitwise negation of val. parameters: - - name: "n" - comment: Number to negate. + - name: val + comment: Integer to negate. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: bor - comment: Performs a bitwise OR operation on input numbers. + comment: Returns the bitwise OR of the given numbers. parameters: - name: ... - comment: Numbers to perform bitwise OR on. + comment: Integers to perform bitwise OR on. type: ...number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: bxor - comment: Performs a bitwise XOR operation on input numbers. + comment: Returns the bitwise XOR of the given numbers. parameters: - name: ... - comment: Numbers to perform bitwise XOR on. + comment: Integers to perform bitwise XOR on. type: ...number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: btest - comment: |- - Performs a bitwise AND operation on input numbers. - Returns true if result is non-zero. + comment: Returns true if the bitwise AND of the given numbers is non-zero. parameters: - name: ... - comment: Numbers to perform bitwise AND on. + comment: Integers to perform bitwise AND on. type: ...number return-type: boolean must-use: true fastcall: true typechecker: {checked: true} - name: extract - comment: "Extracts bits from n at position field with width. Raises an error if the selected bit range goes outside [0, 31]." + comment: Returns width bits from src, starting from bit index field. + Raises an error if the selected bit range is goes outside the range [0, 31]. parameters: - - name: "n" - comment: Number to extract from. + - name: src + comment: Integer to extract from. type: number - name: field comment: Starting index. type: number - name: width - comment: Number of bits to extract. + comment: Number of bits to extract, or 1 if omitted. type: number? default-value: 1 return-type: number @@ -832,10 +831,10 @@ modules: fastcall: true typechecker: {checked: true} - name: lrotate - comment: Rotates n by i bits to the left. If i is negative, a right rotate is performed. + comment: Returns val rotated by i bits to the left. If i is negative, a right rotate is performed. parameters: - - name: "n" - comment: Number to rotate. + - name: val + comment: Integer to rotate. type: number - name: i comment: Number of bits to rotate. @@ -845,10 +844,10 @@ modules: fastcall: true typechecker: {checked: true} - name: lshift - comment: "Shifts n by i bits to the left. If i is negative, a right shift is performed. Returns 0 if i is outside the [-31, 31] range." + comment: Returns val shifted by i bits to the left. If i is negative, a right shift is performed. Returns 0 if i is outside the [-31, 31] range. parameters: - - name: "n" - comment: Number to shift. + - name: val + comment: Integer to shift. type: number - name: i comment: Number of bits to shift. @@ -858,19 +857,20 @@ modules: fastcall: true typechecker: {checked: true} - name: replace - comment: "Replaces bits in n at position field with width using value v. Raises an error if the selected bit range goes outside [0, 31]." + comment: Returns dst with width bits replaced from src, starting from bit index field. + Raises an error if the selected bit range goes outside the range [0, 31]. parameters: - - name: "n" - comment: Number to replace in. + - name: dst + comment: Integer to replace bits in. type: number - - name: v - comment: Value containing the new bits to insert. + - name: src + comment: Integer containing the replacement bits. type: number - name: field - comment: Starting index. + comment: Starting bit index, zero-based type: number - name: width - comment: Number of bits to replace. + comment: Number of bits to replace, or 1 if omitted. type: number? default-value: 1 return-type: number @@ -878,10 +878,10 @@ modules: fastcall: true typechecker: {checked: true} - name: rrotate - comment: Rotates n by i bits to the right. If i is negative, a left rotate is performed. + comment: Returns val rotated by i bits to the right. If i is negative, a left rotate is performed. parameters: - - name: "n" - comment: Number to rotate. + - name: val + comment: Integer to rotate. type: number - name: i comment: Number of bits to rotate. @@ -891,10 +891,10 @@ modules: fastcall: true typechecker: {checked: true} - name: rshift - comment: "Shifts n by i bits to the right. If i is negative, a left shift is performed. Returns 0 if i is outside the [-31, 31] range." + comment: Returns val shifted by i bits to the right. If i is negative, a left shift is performed. Returns 0 if i is outside the [-31, 31] range. parameters: - - name: "n" - comment: Number to shift. + - name: val + comment: Integer to shift. type: number - name: i comment: Number of bits to shift. @@ -904,53 +904,53 @@ modules: fastcall: true typechecker: {checked: true} - name: s32 - comment: Wrap this number from float64 range to signed int32 range and truncate to integer. - Makes integer arithmetic compatible with LSL. + comment: Returns val, wrapped from float64 range to signed int32 range and truncated to integer. + Makes integer arithmetic compatable with LSL. parameters: - - name: "n" - comment: Number to truncate. + - name: val + comment: Integer to truncate. type: number return-type: number must-use: true typechecker: {checked: true} - name: smul - comment: Multiplies two signed 32-bit integers. Returns the result as a signed 32-bit integer, wrapping as necessary. + comment: Returns the product of two signed 32-bit integers as a signed 32-bit integer, wrapping as necessary. Avoids precision loss associated with float64 multiplication. Compatible with LSL integer multiplication. parameters: - - name: a + - name: val1 comment: Left factor. type: number - - name: b + - name: val2 comment: Right factor. type: number return-type: number must-use: true typechecker: {checked: true} - name: countlz - comment: Count leading zeros. + comment: Returns the count of val's leading zeros. parameters: - - name: "n" - comment: Number whose leading zeros will be counted. + - name: val + comment: Integer to count leading zeros in. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: countrz - comment: Count trailing zeros. + comment: Returns the count of val's troiling zeros. parameters: - - name: "n" - comment: Number whose trailing zeros will be counted. + - name: val + comment: Integer to count trailing zeros in. type: number return-type: number must-use: true fastcall: true typechecker: {checked: true} - name: byteswap - comment: Swap byte order. + comment: Returns val with its bytes swapped to the reverse order. parameters: - - name: "n" - comment: Number whose byte order will be swapped. + - name: val + comment: Integer whose byte order will be swapped. type: number return-type: number must-use: true From 28597c8141e6adecb85a230b8bb778a21210855f Mon Sep 17 00:00:00 2001 From: tapple Date: Wed, 8 Jul 2026 15:28:34 -0700 Subject: [PATCH 7/9] Review math constants --- lsl_definitions.yaml | 14 ++++++-------- slua_definitions.yaml | 20 ++++++++++---------- 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/lsl_definitions.yaml b/lsl_definitions.yaml index f11d82aa..878987bd 100644 --- a/lsl_definitions.yaml +++ b/lsl_definitions.yaml @@ -3682,7 +3682,7 @@ constants: type: integer value: '0x2000' PI: - tooltip: Mathematical constant Pi (3.14159265), representing the number of + tooltip: Mathematical constant pi, representing the number of radians in a half circle (semi-circle). When used in sensor functions, it specifies a full sphere scan. type: float @@ -3694,7 +3694,7 @@ constants: type: integer value: '0x8' PI_BY_TWO: - tooltip: Constant Pi/2 (1.57079633), representing the number of radians in a + tooltip: Mathematical constant pi/2, representing the number of radians in a quarter circle. When used in sensor functions, it specifies a hemisphere scan. type: float @@ -5075,8 +5075,7 @@ constants: type: integer value: '0x00' RAD_TO_DEG: - tooltip: Constant 57.2957795 (precise value is 180/PI). Multiply a value in - radians by this number to convert it to degrees. + tooltip: 180/PI. Multiply a value in radians by this number to convert it to degrees. type: float value: '57.2957795' RCERR_CAST_TIME_EXCEEDED: @@ -5803,7 +5802,7 @@ constants: type: integer value: '0x02' SQRT2: - tooltip: Mathematical constant representing the square root of 2 (1.41421356). + tooltip: Mathematical constant representing the square root of 2. type: float value: '1.41421356' STATUS_BLOCK_GRAB: @@ -6265,8 +6264,7 @@ constants: slua-removed: true value: 1 TWO_PI: - tooltip: Mathematical constant representing the number of radians in a full - circle (6.28318530, twice the value of PI). + tooltip: Mathematical constant pi*2, representing the number of radians in a full circle. type: float value: '6.28318530' TYPE_FLOAT: @@ -14324,7 +14322,7 @@ functions: must-use: true return: integer sleep: 0.0 - tooltip: Rounds val to the nearest integer. Halfway values are rounded toward infinity. + tooltip: Returns val rounded to the nearest integer. Halfway values are rounded toward infinity. categories: - math llSHA1String: diff --git a/slua_definitions.yaml b/slua_definitions.yaml index 05d9f9e2..ab6a7a4a 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -1729,9 +1729,9 @@ modules: fastcall: true typechecker: {checked: true} - name: deg - comment: Converts val from radians to degrees. + comment: Returns theta converted from radians to degrees. parameters: - - name: val + - name: theta comment: Number in radians. type: number return-type: number @@ -1928,10 +1928,10 @@ modules: fastcall: true typechecker: {checked: true} - name: rad - comment: Converts val from degrees to radians. + comment: Returns theta converted from degrees to radians. parameters: - - name: "n" - comment: Value in degrees. + - name: theta + comment: Angle in degrees. type: number return-type: number must-use: true @@ -1981,7 +1981,7 @@ modules: reason: Disabled in SLua. typechecker: {checked: true} - name: round - comment: Rounds val to the nearest integer. Halfway values are rounded away from zero. + comment: Returns val rounded to the nearest integer. Halfway values are rounded away from zero. parameters: - name: val comment: Number to round to the nearest integer. Halfway values are rounded away from zero. @@ -2082,7 +2082,7 @@ modules: typechecker: {checked: true} constants: - name: pi - comment: Value of pi. + comment: The number of radians in a half circle (semi-circle). type: number value: 3.141592653589793 - name: huge @@ -2277,7 +2277,7 @@ modules: typechecker: {checked: true} constants: - name: identity - comment: Identity quaternion constant. + comment: Identity quaternion constant. Causes no change when rotated. type: quaternion value: quaternion(0, 0, 0, 1) - name: string @@ -3103,11 +3103,11 @@ modules: typechecker: {checked: true} constants: - name: zero - comment: Constant vector with all components set to 0. + comment: Vector constant with all components set to 0. type: vector value: vector(0, 0, 0) - name: one - comment: Constant vector with all components set to 1. + comment: Vector constant with all components set to 1. type: vector value: vector(1, 1, 1) - name: ll From 1a3f7f99dfc934327d86e1126459c59798822074 Mon Sep 17 00:00:00 2001 From: tapple Date: Wed, 8 Jul 2026 15:43:12 -0700 Subject: [PATCH 8/9] generate files --- generated/builtins.txt | 14 +- generated/experimental/category_docs.yaml | 374 ++++++------ .../experimental/category_functions.yaml | 47 +- generated/lsl_keywords_pretty.xml | 154 ++--- generated/lua_keywords_pretty.xml | 577 +++++++++--------- generated/secondlife.d.luau | 152 ++--- generated/secondlife.docs.json | 284 ++++----- generated/secondlife_selene.yml | 516 ++++++++-------- slua_definitions.yaml | 4 +- 9 files changed, 1078 insertions(+), 1044 deletions(-) diff --git a/generated/builtins.txt b/generated/builtins.txt index 34060914..2a31e3fd 100644 --- a/generated/builtins.txt +++ b/generated/builtins.txt @@ -7,7 +7,7 @@ void llAdjustDamage( integer number, float new_damage ) void llAdjustSoundVolume( float volume ) integer llAgentInExperience( key agent ) void llAllowInventoryDrop( integer add ) -float llAngleBetween( rotation a, rotation b ) +float llAngleBetween( rotation start_rot, rotation end_rot ) void llApplyImpulse( vector momentum, integer is_local ) void llApplyRotationalImpulse( vector force, integer is_local ) float llAsin( float val ) @@ -74,7 +74,7 @@ integer llEdgeOfWorld( vector pos, vector dir ) void llEjectFromLand( key avatar ) void llEmail( string address, string subject, string message ) string llEscapeURL( string url ) -rotation llEuler2Rot( vector v ) +rotation llEuler2Rot( vector vec ) void llEvade( key target, list options ) void llExecCharacterCmd( integer command, list options ) float llFabs( float val ) @@ -312,7 +312,7 @@ void llMapBeacon( string region_name, vector pos, list options ) void llMapDestination( string simname, vector pos, vector look_at ) void llMessageLinked( integer link, integer num, string str, key id ) void llMinEventDelay( float delay ) -integer llModPow( integer a, integer b, integer c ) +integer llModPow( integer base, integer exponent, integer modulus ) void llModifyLand( integer action, integer brush ) void llMoveToTarget( vector target, float tau ) key llName2Key( string name ) @@ -377,9 +377,9 @@ integer llReturnObjectsByOwner( key owner, integer scope ) void llRezAtRoot( string item, vector pos, vector vel, rotation rot, integer start_param ) void llRezObject( string item, vector pos, vector vel, rotation rot, integer start_param ) key llRezObjectWithParams( string item, list options ) -float llRot2Angle( rotation rot ) -vector llRot2Axis( rotation rot ) -vector llRot2Euler( rotation quat ) +float llRot2Angle( rotation q ) +vector llRot2Axis( rotation q ) +vector llRot2Euler( rotation q ) vector llRot2Fwd( rotation q ) vector llRot2Left( rotation q ) vector llRot2Up( rotation q ) @@ -524,7 +524,7 @@ vector llWorldPosToHUD( vector world_pos ) string llXorBase64( string str1, string str2 ) string llXorBase64Strings( string str1, string str2 ) string llXorBase64StringsCorrect( string str1, string str2 ) -vector llsRGB2Linear( vector srgb ) +vector llsRGB2Linear( vector color ) const integer ACTIVE = 0x2 const integer AGENT = 0x1 const integer AGENT_ALWAYS_RUN = 0x1000 diff --git a/generated/experimental/category_docs.yaml b/generated/experimental/category_docs.yaml index 942cb2e3..5503c91a 100644 --- a/generated/experimental/category_docs.yaml +++ b/generated/experimental/category_docs.yaml @@ -584,8 +584,8 @@ data_conversion: specifiers: A list of key names or array indices specifying the path to the value. tooltip: Parses the JSON string json and returns the JSON type constant (JSON_*) representing the value found at specifiers. llLinear2sRGB( vector color ) -> vector: - color: RGB color vector in linear space to convert. - tooltip: Returns a vector representing the conversion of color from the linear RGB colorspace into the sRGB colorspace. + color: Color vector in the linear RGB space to convert. + tooltip: Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace. llList2CSV( list src ) -> string: src: Source list to convert. tooltip: Returns a string of comma-separated values taken in order from the list src. @@ -643,6 +643,9 @@ data_conversion: str1: First Base64 string. str2: Second Base64 string (will repeat if shorter than str1). tooltip: Deprecated (use llXorBase64 instead). Correctly performs (unless nulls are present) a bitwise exclusive OR (XOR) on Base64 strings str1 and str2. + llsRGB2Linear( vector color ) -> vector: + color: Color vector in the sRGB colorspace to convert. + tooltip: Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace. data_storage: linkset_data( integer action, string name, string value ): action: An integer constant representing the action taken (e.g., LINKSETDATA_UPDATE, LINKSETDATA_DELETE, LINKSETDATA_RESET). @@ -1528,223 +1531,224 @@ list: tooltip: Returns a copy of the list src sorted into blocks of stride by the element at stride_index in each block. Sorted in ascending order (if ascending is TRUE) or descending order (if FALSE). llListStatistics( integer operation, list src ) -> float: operation: LIST_STAT_* constant of the statistical operation to perform. - src: List of floats and integers to analyze. - tooltip: Returns a float representing the result of performing the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. + src: List of numbers to analyze. + tooltip: Returns the numeric result of the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. math: llAbs( integer val ) -> integer: - val: Any integer value. - tooltip: Returns an integer representing the absolute (positive) value of val. + val: Integer to convert. + tooltip: Returns the absolute (positive) integer value of val. llAcos( float val ) -> float: - val: A floating-point value falling in the range [-1.0, 1.0]. - tooltip: Returns a float representing the arc-cosine of val in radians. - llAngleBetween( rotation a, rotation b ) -> float: - a: Starting rotation. - b: Ending rotation. - tooltip: Returns a float representing the angle in radians between rotations a and b. + val: A number in the range [-1.0, 1.0]. + tooltip: Returns the arccosine of val in radians. + llAngleBetween( rotation start_rot, rotation end_rot ) -> float: + start_rot: Starting rotation. + end_rot: Ending rotation. + tooltip: Returns the angle, in radians, between rotations start_rot and and end_rot. llAsin( float val ) -> float: - val: A floating-point value falling in the range [-1.0, 1.0]. - tooltip: Returns a float representing the arc-sine of val in radians. + val: A number in the range [-1.0, 1.0]. + tooltip: Returns the arcsine of val in radians. llAtan2( float y, float x ) -> float: - y: A floating-point value representing the y coordinate. - x: A floating-point value representing the x coordinate. - tooltip: Returns a float representing the arctangent2 of y and x. + y: Y coordinate. + x: X coordinate. + tooltip: 'Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter.' llAxes2Rot( vector fwd, vector left, vector up ) -> rotation: fwd: Forward/back directional vector of the rotation. left: Left/right directional vector of the rotation. up: Up/down directional vector of the rotation. tooltip: Returns the rotation defined by the coordinate axes fwd, left, and up. llAxisAngle2Rot( vector axis, float angle ) -> rotation: - axis: Axis vector around which the rotation is generated. - angle: Angle of rotation, expressed in radians. - tooltip: Returns the rotation representing a generated angle (in radians) about the specified axis. + axis: Axis vector to rotate around. + angle: Angle to rotate, in radians. + tooltip: Returns the rotation that rotates angle radians around the axis vector. llCeil( float val ) -> integer: - val: Float value to round. - tooltip: Returns the smallest integer value greater than or equal to val (rounded toward positive infinity). + val: Number to round up. + tooltip: Returns val rounded toward positive infinity. In other words, returns the smallest integer greater than or equal to val. llCos( float theta ) -> float: - theta: Angle expressed in radians. - tooltip: Returns a float representing the cosine of theta. - llEuler2Rot( vector v ) -> rotation: - v: Vector of Euler angles to convert. - tooltip: Returns the rotation representation of the Euler angles vector v. + theta: An angle in radians. + tooltip: Returns the cosine of theta. theta is in radians. + llEuler2Rot( vector vec ) -> rotation: + vec: Vector of Euler angles to convert, in radians. + tooltip: Returns the quaternion representation of the Euler angles (in radians) within vec. llFabs( float val ) -> float: - val: Float value to convert. - tooltip: Returns a float representing the absolute (positive) value of val. + val: Number to convert. + tooltip: Returns the absolute (positive) value of val. llFloor( float val ) -> integer: - val: Float value to round. - tooltip: Returns the largest integer value less than or equal to val (rounded toward negative infinity). + val: Number to round down. + tooltip: Returns val rounded toward negative infinity. In other words, returns the largest integer less than or equal to val. llFrand( float mag ) -> float: mag: Float magnitude of the random range. tooltip: Returns a pseudo-random float in the range [0.0, mag) or (mag, 0.0] depending on the sign of mag. The value is inclusive of 0.0 but exclusive of mag. llLinear2sRGB( vector color ) -> vector: - color: RGB color vector in linear space to convert. - tooltip: Returns a vector representing the conversion of color from the linear RGB colorspace into the sRGB colorspace. + color: Color vector in the linear RGB space to convert. + tooltip: Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace. llListStatistics( integer operation, list src ) -> float: operation: LIST_STAT_* constant of the statistical operation to perform. - src: List of floats and integers to analyze. - tooltip: Returns a float representing the result of performing the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. + src: List of numbers to analyze. + tooltip: Returns the numeric result of the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. llLog( float val ) -> float: - val: Float value to evaluate. - tooltip: Returns a float representing the natural (base e) logarithm of the positive value val (returns 0.0 if val <= 0). + val: Number to compute the logarithm of. + tooltip: Returns natural (base e) logarithm of val. If negative, return 0.0. llLog10( float val ) -> float: - val: Float value to evaluate. - tooltip: Returns a float representing the base-10 (common) logarithm of the positive value val (returns 0.0 if val <= 0). - llModPow( integer a, integer b, integer c ) -> integer: - a: Base integer value. - b: Power exponent (capped at 0xFFFF / 16 bits). - c: Modulus integer value. - tooltip: Returns an integer representing a raised to the power b, modulo c (i.e., (a**b)%c). The b value is capped at 0xFFFF (16 bits). + val: Number to compute the logarithm of. + tooltip: Returns base-10 (common) logarithm of val. If negative, return 0.0. + llModPow( integer base, integer exponent, integer modulus ) -> integer: + base: 32-bit unsigned integer base. + exponent: 32-bit unsigned integer exponent. + modulus: 32-bit unsigned integer modulus. + tooltip: Returns base raised to the power exponent, modulo modulus (i.e., (b^e)%m). All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. Output is wrapped to signed 32-bit integer + range [-2147483648..2147483647]. Will never overflow, unlike (b^e), which can overflow to inf. llPow( float base, float exponent ) -> float: - base: Base float value. - exponent: Exponent float value. - tooltip: Returns a float representing base raised to the power exponent. Returns 0 and triggers a Math Error for imaginary results. - llRot2Angle( rotation rot ) -> float: - rot: Rotation value. - tooltip: Returns a float representing the rotation angle of rot. - llRot2Axis( rotation rot ) -> vector: - rot: Rotation value. - tooltip: Returns a vector representing the rotation axis of rot. - llRot2Euler( rotation quat ) -> vector: - quat: Rotation value to convert. - tooltip: Returns a vector representing the Euler rotation (roll, pitch, yaw) of quat, with each component expressed in radians. + base: Base number. + exponent: Exponent number. + tooltip: Returns base raised to the power exponent. If result is imaginary, returns NaN. + llRot2Angle( rotation q ) -> float: + q: Rotation to evaluate. + tooltip: Returns the angle, in radians, that q rotates. + llRot2Axis( rotation q ) -> vector: + q: Rotation to evaluate. + tooltip: Returns the unit vector axis that q rotates around. + llRot2Euler( rotation q ) -> vector: + q: Rotation to convert. + tooltip: Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles will be in radians. llRot2Fwd( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q. llRot2Left( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q. llRot2Up( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q. llRotBetween( vector start_vec, vector end_vec ) -> rotation: start_vec: Starting vector. - end_vec: Target ending vector. - tooltip: Returns a rotation representing the shortest path rotation from vector start to vector end. + end_vec: Ending vector. + tooltip: Returns the shortest-path quaternion that rotates start_vec onto end_vec. llRound( float val ) -> integer: - val: Float value to round. - tooltip: Returns the integer that float val is closest to. + val: Number to round. + tooltip: Returns val rounded to the nearest integer. Halfway values are rounded toward infinity. llSin( float theta ) -> float: - theta: Angle expressed in radians. - tooltip: Returns a float representing the sine of theta. + theta: An angle in radians. + tooltip: Returns the sine of theta. theta is in radians. llSqrt( float val ) -> float: val: Positive float value (must be >= 0.0). - tooltip: Returns a float representing the square root of the positive value val. Triggers a math runtime error if val is less than 0.0 (imaginary results). + tooltip: Returns the square root of val. If negative, return Nan. llTan( float theta ) -> float: - theta: Angle expressed in radians. - tooltip: Returns a float representing the tangent of theta. + theta: An angle in radians. + tooltip: Returns the tangent of theta. theta is in radians. llVecDist( vector vec_a, vector vec_b ) -> float: vec_a: First vector. vec_b: Second vector. tooltip: Returns a float representing the undirected, non-negative distance between vectors vec_a and vec_b. llVecMag( vector vec ) -> float: vec: Vector to evaluate. - tooltip: Returns a float representing the magnitude (geometric length) of the vector vec. + tooltip: Returns the magnitude (geometric length) of vec. llVecNorm( vector vec ) -> vector: vec: Vector to normalize. - tooltip: Returns a normalized unit vector sharing the same direction as vec. - llsRGB2Linear( vector srgb ) -> vector: - srgb: Color vector in the sRGB colorspace to convert. - tooltip: Returns a vector representing the conversion of the color srgb from the sRGB colorspace into the linear RGB colorspace. + tooltip: Returns the normalized unit vector pointing the same direction as vec. + llsRGB2Linear( vector color ) -> vector: + color: Color vector in the sRGB colorspace to convert. + tooltip: Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace. math_3d: - llAngleBetween( rotation a, rotation b ) -> float: - a: Starting rotation. - b: Ending rotation. - tooltip: Returns a float representing the angle in radians between rotations a and b. + llAngleBetween( rotation start_rot, rotation end_rot ) -> float: + start_rot: Starting rotation. + end_rot: Ending rotation. + tooltip: Returns the angle, in radians, between rotations start_rot and and end_rot. llAxes2Rot( vector fwd, vector left, vector up ) -> rotation: fwd: Forward/back directional vector of the rotation. left: Left/right directional vector of the rotation. up: Up/down directional vector of the rotation. tooltip: Returns the rotation defined by the coordinate axes fwd, left, and up. llAxisAngle2Rot( vector axis, float angle ) -> rotation: - axis: Axis vector around which the rotation is generated. - angle: Angle of rotation, expressed in radians. - tooltip: Returns the rotation representing a generated angle (in radians) about the specified axis. - llEuler2Rot( vector v ) -> rotation: - v: Vector of Euler angles to convert. - tooltip: Returns the rotation representation of the Euler angles vector v. - llRot2Angle( rotation rot ) -> float: - rot: Rotation value. - tooltip: Returns a float representing the rotation angle of rot. - llRot2Axis( rotation rot ) -> vector: - rot: Rotation value. - tooltip: Returns a vector representing the rotation axis of rot. - llRot2Euler( rotation quat ) -> vector: - quat: Rotation value to convert. - tooltip: Returns a vector representing the Euler rotation (roll, pitch, yaw) of quat, with each component expressed in radians. + axis: Axis vector to rotate around. + angle: Angle to rotate, in radians. + tooltip: Returns the rotation that rotates angle radians around the axis vector. + llEuler2Rot( vector vec ) -> rotation: + vec: Vector of Euler angles to convert, in radians. + tooltip: Returns the quaternion representation of the Euler angles (in radians) within vec. + llRot2Angle( rotation q ) -> float: + q: Rotation to evaluate. + tooltip: Returns the angle, in radians, that q rotates. + llRot2Axis( rotation q ) -> vector: + q: Rotation to evaluate. + tooltip: Returns the unit vector axis that q rotates around. + llRot2Euler( rotation q ) -> vector: + q: Rotation to convert. + tooltip: Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles will be in radians. llRot2Fwd( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q. llRot2Left( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q. llRot2Up( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q. llRotBetween( vector start_vec, vector end_vec ) -> rotation: start_vec: Starting vector. - end_vec: Target ending vector. - tooltip: Returns a rotation representing the shortest path rotation from vector start to vector end. + end_vec: Ending vector. + tooltip: Returns the shortest-path quaternion that rotates start_vec onto end_vec. llVecDist( vector vec_a, vector vec_b ) -> float: vec_a: First vector. vec_b: Second vector. tooltip: Returns a float representing the undirected, non-negative distance between vectors vec_a and vec_b. llVecMag( vector vec ) -> float: vec: Vector to evaluate. - tooltip: Returns a float representing the magnitude (geometric length) of the vector vec. + tooltip: Returns the magnitude (geometric length) of vec. llVecNorm( vector vec ) -> vector: vec: Vector to normalize. - tooltip: Returns a normalized unit vector sharing the same direction as vec. + tooltip: Returns the normalized unit vector pointing the same direction as vec. math_trig: llAcos( float val ) -> float: - val: A floating-point value falling in the range [-1.0, 1.0]. - tooltip: Returns a float representing the arc-cosine of val in radians. - llAngleBetween( rotation a, rotation b ) -> float: - a: Starting rotation. - b: Ending rotation. - tooltip: Returns a float representing the angle in radians between rotations a and b. + val: A number in the range [-1.0, 1.0]. + tooltip: Returns the arccosine of val in radians. + llAngleBetween( rotation start_rot, rotation end_rot ) -> float: + start_rot: Starting rotation. + end_rot: Ending rotation. + tooltip: Returns the angle, in radians, between rotations start_rot and and end_rot. llAsin( float val ) -> float: - val: A floating-point value falling in the range [-1.0, 1.0]. - tooltip: Returns a float representing the arc-sine of val in radians. + val: A number in the range [-1.0, 1.0]. + tooltip: Returns the arcsine of val in radians. llAtan2( float y, float x ) -> float: - y: A floating-point value representing the y coordinate. - x: A floating-point value representing the x coordinate. - tooltip: Returns a float representing the arctangent2 of y and x. + y: Y coordinate. + x: X coordinate. + tooltip: 'Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter.' llAxes2Rot( vector fwd, vector left, vector up ) -> rotation: fwd: Forward/back directional vector of the rotation. left: Left/right directional vector of the rotation. up: Up/down directional vector of the rotation. tooltip: Returns the rotation defined by the coordinate axes fwd, left, and up. llAxisAngle2Rot( vector axis, float angle ) -> rotation: - axis: Axis vector around which the rotation is generated. - angle: Angle of rotation, expressed in radians. - tooltip: Returns the rotation representing a generated angle (in radians) about the specified axis. + axis: Axis vector to rotate around. + angle: Angle to rotate, in radians. + tooltip: Returns the rotation that rotates angle radians around the axis vector. llCos( float theta ) -> float: - theta: Angle expressed in radians. - tooltip: Returns a float representing the cosine of theta. - llRot2Angle( rotation rot ) -> float: - rot: Rotation value. - tooltip: Returns a float representing the rotation angle of rot. - llRot2Axis( rotation rot ) -> vector: - rot: Rotation value. - tooltip: Returns a vector representing the rotation axis of rot. + theta: An angle in radians. + tooltip: Returns the cosine of theta. theta is in radians. + llRot2Angle( rotation q ) -> float: + q: Rotation to evaluate. + tooltip: Returns the angle, in radians, that q rotates. + llRot2Axis( rotation q ) -> vector: + q: Rotation to evaluate. + tooltip: Returns the unit vector axis that q rotates around. llRot2Fwd( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q. llRot2Left( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q. llRot2Up( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q. llRotBetween( vector start_vec, vector end_vec ) -> rotation: start_vec: Starting vector. - end_vec: Target ending vector. - tooltip: Returns a rotation representing the shortest path rotation from vector start to vector end. + end_vec: Ending vector. + tooltip: Returns the shortest-path quaternion that rotates start_vec onto end_vec. llSin( float theta ) -> float: - theta: Angle expressed in radians. - tooltip: Returns a float representing the sine of theta. + theta: An angle in radians. + tooltip: Returns the sine of theta. theta is in radians. llTan( float theta ) -> float: - theta: Angle expressed in radians. - tooltip: Returns a float representing the tangent of theta. + theta: An angle in radians. + tooltip: Returns the tangent of theta. theta is in radians. media: changed( integer changes ): changes: A bitfield of CHANGED_* flags representing what changed. @@ -2736,8 +2740,8 @@ prim_appearance: face: Face number (or ALL_SIDES) of the prim to inspect. tooltip: Checks the specified face on the linked prim link. Returns TRUE if the face material is a PBR render material, or FALSE if it uses Blinn-Phong diffuse textures. llLinear2sRGB( vector color ) -> vector: - color: RGB color vector in linear space to convert. - tooltip: Returns a vector representing the conversion of color from the linear RGB colorspace into the sRGB colorspace. + color: Color vector in the linear RGB space to convert. + tooltip: Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace. llOffsetTexture( float u, float v, integer face ) -> void: u: Horizontal (U) offset, typically in the interval [-1.0, 1.0]. v: Vertical (V) offset, typically in the interval [-1.0, 1.0]. @@ -2837,9 +2841,9 @@ prim_appearance: rate: Playback rate in frames per second (or radians/sec for ROTATE, UV coords/sec for SMOOTH). Must not be zero. tooltip: Animates the texture on face of the prim by setting its scale and offset. mode defines options, sizex/sizey define frames, start defines the start frame/angle, length defines duration, and rate defines playback speed. - llsRGB2Linear( vector srgb ) -> vector: - srgb: Color vector in the sRGB colorspace to convert. - tooltip: Returns a vector representing the conversion of the color srgb from the sRGB colorspace into the linear RGB colorspace. + llsRGB2Linear( vector color ) -> vector: + color: Color vector in the sRGB colorspace to convert. + tooltip: Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace. prim_inventory: changed( integer changes ): changes: A bitfield of CHANGED_* flags representing what changed. @@ -3059,44 +3063,44 @@ prim_properties: text: Context menu text to display. tooltip: Displays the string text instead of 'Touch' in the right-click context menu. quaternion: - llAngleBetween( rotation a, rotation b ) -> float: - a: Starting rotation. - b: Ending rotation. - tooltip: Returns a float representing the angle in radians between rotations a and b. + llAngleBetween( rotation start_rot, rotation end_rot ) -> float: + start_rot: Starting rotation. + end_rot: Ending rotation. + tooltip: Returns the angle, in radians, between rotations start_rot and and end_rot. llAxes2Rot( vector fwd, vector left, vector up ) -> rotation: fwd: Forward/back directional vector of the rotation. left: Left/right directional vector of the rotation. up: Up/down directional vector of the rotation. tooltip: Returns the rotation defined by the coordinate axes fwd, left, and up. llAxisAngle2Rot( vector axis, float angle ) -> rotation: - axis: Axis vector around which the rotation is generated. - angle: Angle of rotation, expressed in radians. - tooltip: Returns the rotation representing a generated angle (in radians) about the specified axis. - llEuler2Rot( vector v ) -> rotation: - v: Vector of Euler angles to convert. - tooltip: Returns the rotation representation of the Euler angles vector v. - llRot2Angle( rotation rot ) -> float: - rot: Rotation value. - tooltip: Returns a float representing the rotation angle of rot. - llRot2Axis( rotation rot ) -> vector: - rot: Rotation value. - tooltip: Returns a vector representing the rotation axis of rot. - llRot2Euler( rotation quat ) -> vector: - quat: Rotation value to convert. - tooltip: Returns a vector representing the Euler rotation (roll, pitch, yaw) of quat, with each component expressed in radians. + axis: Axis vector to rotate around. + angle: Angle to rotate, in radians. + tooltip: Returns the rotation that rotates angle radians around the axis vector. + llEuler2Rot( vector vec ) -> rotation: + vec: Vector of Euler angles to convert, in radians. + tooltip: Returns the quaternion representation of the Euler angles (in radians) within vec. + llRot2Angle( rotation q ) -> float: + q: Rotation to evaluate. + tooltip: Returns the angle, in radians, that q rotates. + llRot2Axis( rotation q ) -> vector: + q: Rotation to evaluate. + tooltip: Returns the unit vector axis that q rotates around. + llRot2Euler( rotation q ) -> vector: + q: Rotation to convert. + tooltip: Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles will be in radians. llRot2Fwd( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q. llRot2Left( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q. llRot2Up( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q. llRotBetween( vector start_vec, vector end_vec ) -> rotation: start_vec: Starting vector. - end_vec: Target ending vector. - tooltip: Returns a rotation representing the shortest path rotation from vector start to vector end. + end_vec: Ending vector. + tooltip: Returns the shortest-path quaternion that rotates start_vec onto end_vec. region: changed( integer changes ): changes: A bitfield of CHANGED_* flags representing what changed. @@ -3866,28 +3870,34 @@ uuid: tooltip: Asynchronously requests the Agent ID key (UUID) for the agent specified by their current or historical username, returning NULL_KEY if not found. Returns a key query handle for the dataserver event. vector: - llRot2Axis( rotation rot ) -> vector: - rot: Rotation value. - tooltip: Returns a vector representing the rotation axis of rot. + llLinear2sRGB( vector color ) -> vector: + color: Color vector in the linear RGB space to convert. + tooltip: Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace. + llRot2Axis( rotation q ) -> vector: + q: Rotation to evaluate. + tooltip: Returns the unit vector axis that q rotates around. llRot2Fwd( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q. llRot2Left( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q. llRot2Up( rotation q ) -> vector: - q: Rotation value. - tooltip: Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q. + q: Rotation to convert. + tooltip: Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q. llVecDist( vector vec_a, vector vec_b ) -> float: vec_a: First vector. vec_b: Second vector. tooltip: Returns a float representing the undirected, non-negative distance between vectors vec_a and vec_b. llVecMag( vector vec ) -> float: vec: Vector to evaluate. - tooltip: Returns a float representing the magnitude (geometric length) of the vector vec. + tooltip: Returns the magnitude (geometric length) of vec. llVecNorm( vector vec ) -> vector: vec: Vector to normalize. - tooltip: Returns a normalized unit vector sharing the same direction as vec. + tooltip: Returns the normalized unit vector pointing the same direction as vec. + llsRGB2Linear( vector color ) -> vector: + color: Color vector in the sRGB colorspace to convert. + tooltip: Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace. vehicles: llRemoveVehicleFlags( integer flags ) -> void: flags: A bitwise mask of VEHICLE_FLAG_* constants to disable. diff --git a/generated/experimental/category_functions.yaml b/generated/experimental/category_functions.yaml index b5119339..9bd5faba 100644 --- a/generated/experimental/category_functions.yaml +++ b/generated/experimental/category_functions.yaml @@ -171,6 +171,7 @@ data_conversion: - llXorBase64( string str1, string str2 ) -> string - llXorBase64Strings( string str1, string str2 ) -> string // deprecated - llXorBase64StringsCorrect( string str1, string str2 ) -> string // deprecated +- llsRGB2Linear( vector color ) -> vector data_storage: - linkset_data( integer action, string name, string value ) - llCreateKeyValue( string k, string v ) -> key @@ -404,14 +405,14 @@ list: math: - llAbs( integer val ) -> integer - llAcos( float val ) -> float -- llAngleBetween( rotation a, rotation b ) -> float +- llAngleBetween( rotation start_rot, rotation end_rot ) -> float - llAsin( float val ) -> float - llAtan2( float y, float x ) -> float - llAxes2Rot( vector fwd, vector left, vector up ) -> rotation - llAxisAngle2Rot( vector axis, float angle ) -> rotation - llCeil( float val ) -> integer - llCos( float theta ) -> float -- llEuler2Rot( vector v ) -> rotation +- llEuler2Rot( vector vec ) -> rotation - llFabs( float val ) -> float - llFloor( float val ) -> integer - llFrand( float mag ) -> float @@ -419,11 +420,11 @@ math: - llListStatistics( integer operation, list src ) -> float - llLog( float val ) -> float - llLog10( float val ) -> float -- llModPow( integer a, integer b, integer c ) -> integer +- llModPow( integer base, integer exponent, integer modulus ) -> integer - llPow( float base, float exponent ) -> float -- llRot2Angle( rotation rot ) -> float -- llRot2Axis( rotation rot ) -> vector -- llRot2Euler( rotation quat ) -> vector +- llRot2Angle( rotation q ) -> float +- llRot2Axis( rotation q ) -> vector +- llRot2Euler( rotation q ) -> vector - llRot2Fwd( rotation q ) -> vector - llRot2Left( rotation q ) -> vector - llRot2Up( rotation q ) -> vector @@ -435,15 +436,15 @@ math: - llVecDist( vector vec_a, vector vec_b ) -> float - llVecMag( vector vec ) -> float - llVecNorm( vector vec ) -> vector -- llsRGB2Linear( vector srgb ) -> vector +- llsRGB2Linear( vector color ) -> vector math_3d: -- llAngleBetween( rotation a, rotation b ) -> float +- llAngleBetween( rotation start_rot, rotation end_rot ) -> float - llAxes2Rot( vector fwd, vector left, vector up ) -> rotation - llAxisAngle2Rot( vector axis, float angle ) -> rotation -- llEuler2Rot( vector v ) -> rotation -- llRot2Angle( rotation rot ) -> float -- llRot2Axis( rotation rot ) -> vector -- llRot2Euler( rotation quat ) -> vector +- llEuler2Rot( vector vec ) -> rotation +- llRot2Angle( rotation q ) -> float +- llRot2Axis( rotation q ) -> vector +- llRot2Euler( rotation q ) -> vector - llRot2Fwd( rotation q ) -> vector - llRot2Left( rotation q ) -> vector - llRot2Up( rotation q ) -> vector @@ -453,14 +454,14 @@ math_3d: - llVecNorm( vector vec ) -> vector math_trig: - llAcos( float val ) -> float -- llAngleBetween( rotation a, rotation b ) -> float +- llAngleBetween( rotation start_rot, rotation end_rot ) -> float - llAsin( float val ) -> float - llAtan2( float y, float x ) -> float - llAxes2Rot( vector fwd, vector left, vector up ) -> rotation - llAxisAngle2Rot( vector axis, float angle ) -> rotation - llCos( float theta ) -> float -- llRot2Angle( rotation rot ) -> float -- llRot2Axis( rotation rot ) -> vector +- llRot2Angle( rotation q ) -> float +- llRot2Axis( rotation q ) -> vector - llRot2Fwd( rotation q ) -> vector - llRot2Left( rotation q ) -> vector - llRot2Up( rotation q ) -> vector @@ -776,7 +777,7 @@ prim_appearance: - llSetText( string text, vector color, float alpha ) -> void - llSetTexture( string texture, integer face ) -> void - llSetTextureAnim( integer mode, integer face, integer sizex, integer sizey, float start, float length, float rate ) -> void -- llsRGB2Linear( vector srgb ) -> vector +- llsRGB2Linear( vector color ) -> vector prim_inventory: - changed( integer changes ) - llAllowInventoryDrop( integer add ) -> void @@ -835,13 +836,13 @@ prim_properties: - llSetText( string text, vector color, float alpha ) -> void - llSetTouchText( string text ) -> void quaternion: -- llAngleBetween( rotation a, rotation b ) -> float +- llAngleBetween( rotation start_rot, rotation end_rot ) -> float - llAxes2Rot( vector fwd, vector left, vector up ) -> rotation - llAxisAngle2Rot( vector axis, float angle ) -> rotation -- llEuler2Rot( vector v ) -> rotation -- llRot2Angle( rotation rot ) -> float -- llRot2Axis( rotation rot ) -> vector -- llRot2Euler( rotation quat ) -> vector +- llEuler2Rot( vector vec ) -> rotation +- llRot2Angle( rotation q ) -> float +- llRot2Axis( rotation q ) -> vector +- llRot2Euler( rotation q ) -> vector - llRot2Fwd( rotation q ) -> vector - llRot2Left( rotation q ) -> vector - llRot2Up( rotation q ) -> vector @@ -1071,13 +1072,15 @@ uuid: - llGetOwnerKey( key id ) -> key - llRequestUserKey( string username ) -> key vector: -- llRot2Axis( rotation rot ) -> vector +- llLinear2sRGB( vector color ) -> vector +- llRot2Axis( rotation q ) -> vector - llRot2Fwd( rotation q ) -> vector - llRot2Left( rotation q ) -> vector - llRot2Up( rotation q ) -> vector - llVecDist( vector vec_a, vector vec_b ) -> float - llVecMag( vector vec ) -> float - llVecNorm( vector vec ) -> vector +- llsRGB2Linear( vector color ) -> vector vehicles: - llRemoveVehicleFlags( integer flags ) -> void - llSetVehicleFlags( integer flags ) -> void diff --git a/generated/lsl_keywords_pretty.xml b/generated/lsl_keywords_pretty.xml index 442dd235..98296adc 100644 --- a/generated/lsl_keywords_pretty.xml +++ b/generated/lsl_keywords_pretty.xml @@ -4878,7 +4878,7 @@ This file is auto-generated by https://github.com/secondlife/lsl-definitions. -- PI tooltip - Mathematical constant Pi (3.14159265), representing the number of radians in a half circle (semi-circle). When used in sensor functions, it specifies a full sphere scan. + Mathematical constant pi, representing the number of radians in a half circle (semi-circle). When used in sensor functions, it specifies a full sphere scan. type float value @@ -4896,7 +4896,7 @@ This file is auto-generated by https://github.com/secondlife/lsl-definitions. -- PI_BY_TWO tooltip - Constant Pi/2 (1.57079633), representing the number of radians in a quarter circle. When used in sensor functions, it specifies a hemisphere scan. + Mathematical constant pi/2, representing the number of radians in a quarter circle. When used in sensor functions, it specifies a hemisphere scan. type float value @@ -6799,7 +6799,7 @@ float falloff – ranges from 0.01 to 2.0 RAD_TO_DEG tooltip - Constant 57.2957795 (precise value is 180/PI). Multiply a value in radians by this number to convert it to degrees. + 180/PI. Multiply a value in radians by this number to convert it to degrees. type float value @@ -7876,7 +7876,7 @@ float falloff – ranges from 0.01 to 2.0 SQRT2 tooltip - Mathematical constant representing the square root of 2 (1.41421356). + Mathematical constant representing the square root of 2. type float value @@ -8553,7 +8553,7 @@ float falloff – ranges from 0.01 to 2.0 TWO_PI tooltip - Mathematical constant representing the number of radians in a full circle (6.28318530, twice the value of PI). + Mathematical constant pi*2, representing the number of radians in a full circle. type float value @@ -10286,7 +10286,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - Any integer value. + Integer to convert. type integer @@ -10299,7 +10299,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns an integer representing the absolute (positive) value of val. + Returns the absolute (positive) integer value of val. llAcos @@ -10309,7 +10309,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - A floating-point value falling in the range [-1.0, 1.0]. + A number in the range [-1.0, 1.0]. type float @@ -10322,7 +10322,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the arc-cosine of val in radians. + Returns the arccosine of val in radians. llAddToLandBanList @@ -10496,7 +10496,7 @@ If another state is defined before the default state, the compiler will report a arguments - a + start_rot tooltip Starting rotation. @@ -10505,7 +10505,7 @@ If another state is defined before the default state, the compiler will report a - b + end_rot tooltip Ending rotation. @@ -10521,7 +10521,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the angle in radians between rotations a and b. + Returns the angle, in radians, between rotations start_rot and and end_rot. llApplyImpulse @@ -10595,7 +10595,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - A floating-point value falling in the range [-1.0, 1.0]. + A number in the range [-1.0, 1.0]. type float @@ -10608,7 +10608,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the arc-sine of val in radians. + Returns the arcsine of val in radians. llAtan2 @@ -10618,7 +10618,7 @@ If another state is defined before the default state, the compiler will report a y tooltip - A floating-point value representing the y coordinate. + Y coordinate. type float @@ -10627,7 +10627,7 @@ If another state is defined before the default state, the compiler will report a x tooltip - A floating-point value representing the x coordinate. + X coordinate. type float @@ -10640,7 +10640,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the arctangent2 of y and x. + Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter. llAttachToAvatar @@ -10774,7 +10774,7 @@ If another state is defined before the default state, the compiler will report a axis tooltip - Axis vector around which the rotation is generated. + Axis vector to rotate around. type vector @@ -10783,7 +10783,7 @@ If another state is defined before the default state, the compiler will report a angle tooltip - Angle of rotation, expressed in radians. + Angle to rotate, in radians. type float @@ -10796,7 +10796,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns the rotation representing a generated angle (in radians) about the specified axis. + Returns the rotation that rotates angle radians around the axis vector. llBase64ToInteger @@ -10953,7 +10953,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - Float value to round. + Number to round up. type float @@ -10966,7 +10966,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns the smallest integer value greater than or equal to val (rounded toward positive infinity). + Returns val rounded toward positive infinity. In other words, returns the smallest integer greater than or equal to val. llChar @@ -11248,7 +11248,7 @@ If another state is defined before the default state, the compiler will report a theta tooltip - Angle expressed in radians. + An angle in radians. type float @@ -11261,7 +11261,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the cosine of theta. + Returns the cosine of theta. theta is in radians. llCreateCharacter @@ -12210,10 +12210,10 @@ If another state is defined before the default state, the compiler will report a arguments - v + vec tooltip - Vector of Euler angles to convert. + Vector of Euler angles to convert, in radians. type vector @@ -12226,7 +12226,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns the rotation representation of the Euler angles vector v. + Returns the quaternion representation of the Euler angles (in radians) within vec. llEvade @@ -12300,7 +12300,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - Float value to convert. + Number to convert. type float @@ -12313,7 +12313,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the absolute (positive) value of val. + Returns the absolute (positive) value of val. llFindNotecardTextCount @@ -12464,7 +12464,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - Float value to round. + Number to round down. type float @@ -12477,7 +12477,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns the largest integer value less than or equal to val (rounded toward negative infinity). + Returns val rounded toward negative infinity. In other words, returns the largest integer less than or equal to val. llForceMouselook @@ -16168,7 +16168,7 @@ If another state is defined before the default state, the compiler will report a color tooltip - RGB color vector in linear space to convert. + Color vector in the linear RGB space to convert. type vector @@ -16181,7 +16181,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a vector representing the conversion of color from the linear RGB colorspace into the sRGB colorspace. + Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace. llLinkAdjustSoundVolume @@ -17538,7 +17538,7 @@ If another state is defined before the default state, the compiler will report a src tooltip - List of floats and integers to analyze. + List of numbers to analyze. type list @@ -17551,7 +17551,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the result of performing the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. + Returns the numeric result of the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. llListen @@ -17707,7 +17707,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - Float value to evaluate. + Number to compute the logarithm of. type float @@ -17720,7 +17720,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the natural (base e) logarithm of the positive value val (returns 0.0 if val <= 0). + Returns natural (base e) logarithm of val. If negative, return 0.0. llLog10 @@ -17730,7 +17730,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - Float value to evaluate. + Number to compute the logarithm of. type float @@ -17743,7 +17743,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the base-10 (common) logarithm of the positive value val (returns 0.0 if val <= 0). + Returns base-10 (common) logarithm of val. If negative, return 0.0. llLookAt @@ -18442,28 +18442,28 @@ If another state is defined before the default state, the compiler will report a arguments - a + base tooltip - Base integer value. + 32-bit unsigned integer base. type integer - b + exponent tooltip - Power exponent (capped at 0xFFFF / 16 bits). + 32-bit unsigned integer exponent. type integer - c + modulus tooltip - Modulus integer value. + 32-bit unsigned integer modulus. type integer @@ -18476,7 +18476,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns an integer representing a raised to the power b, modulo c (i.e., (a**b)%c). The b value is capped at 0xFFFF (16 bits). + Returns base raised to the power exponent, modulo modulus (i.e., (b^e)%m). All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. Output is wrapped to signed 32-bit integer range [-2147483648..2147483647]. Will never overflow, unlike (b^e), which can overflow to inf. llModifyLand @@ -19078,7 +19078,7 @@ If another state is defined before the default state, the compiler will report a base tooltip - Base float value. + Base number. type float @@ -19087,7 +19087,7 @@ If another state is defined before the default state, the compiler will report a exponent tooltip - Exponent float value. + Exponent number. type float @@ -19100,7 +19100,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing base raised to the power exponent. Returns 0 and triggers a Math Error for imaginary results. + Returns base raised to the power exponent. If result is imaginary, returns NaN. llPreloadSound @@ -20310,10 +20310,10 @@ If another state is defined before the default state, the compiler will report a arguments - rot + q tooltip - Rotation value. + Rotation to evaluate. type rotation @@ -20326,17 +20326,17 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the rotation angle of rot. + Returns the angle, in radians, that q rotates. llRot2Axis arguments - rot + q tooltip - Rotation value. + Rotation to evaluate. type rotation @@ -20349,17 +20349,17 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a vector representing the rotation axis of rot. + Returns the unit vector axis that q rotates around. llRot2Euler arguments - quat + q tooltip - Rotation value to convert. + Rotation to convert. type rotation @@ -20372,7 +20372,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a vector representing the Euler rotation (roll, pitch, yaw) of quat, with each component expressed in radians. + Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles will be in radians. llRot2Fwd @@ -20382,7 +20382,7 @@ If another state is defined before the default state, the compiler will report a q tooltip - Rotation value. + Rotation to convert. type rotation @@ -20395,7 +20395,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q. + Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q. llRot2Left @@ -20405,7 +20405,7 @@ If another state is defined before the default state, the compiler will report a q tooltip - Rotation value. + Rotation to convert. type rotation @@ -20418,7 +20418,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q. + Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q. llRot2Up @@ -20428,7 +20428,7 @@ If another state is defined before the default state, the compiler will report a q tooltip - Rotation value. + Rotation to convert. type rotation @@ -20441,7 +20441,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q. + Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q. llRotBetween @@ -20460,7 +20460,7 @@ If another state is defined before the default state, the compiler will report a end_vec tooltip - Target ending vector. + Ending vector. type vector @@ -20473,7 +20473,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a rotation representing the shortest path rotation from vector start to vector end. + Returns the shortest-path quaternion that rotates start_vec onto end_vec. llRotLookAt @@ -20611,7 +20611,7 @@ If another state is defined before the default state, the compiler will report a val tooltip - Float value to round. + Number to round. type float @@ -20624,7 +20624,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns the integer that float val is closest to. + Returns val rounded to the nearest integer. Halfway values are rounded toward infinity. llSHA1String @@ -23243,7 +23243,7 @@ If another state is defined before the default state, the compiler will report a theta tooltip - Angle expressed in radians. + An angle in radians. type float @@ -23256,7 +23256,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the sine of theta. + Returns the sine of theta. theta is in radians. llSitOnLink @@ -23443,7 +23443,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the square root of the positive value val. Triggers a math runtime error if val is less than 0.0 (imaginary results). + Returns the square root of val. If negative, return Nan. llStartAnimation @@ -23777,7 +23777,7 @@ If another state is defined before the default state, the compiler will report a theta tooltip - Angle expressed in radians. + An angle in radians. type float @@ -23790,7 +23790,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the tangent of theta. + Returns the tangent of theta. theta is in radians. llTarget @@ -24466,7 +24466,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a float representing the magnitude (geometric length) of the vector vec. + Returns the magnitude (geometric length) of vec. llVecNorm @@ -24489,7 +24489,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a normalized unit vector sharing the same direction as vec. + Returns the normalized unit vector pointing the same direction as vec. llVerifyRSA @@ -24813,7 +24813,7 @@ If another state is defined before the default state, the compiler will report a arguments - srgb + color tooltip Color vector in the sRGB colorspace to convert. @@ -24829,7 +24829,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Returns a vector representing the conversion of the color srgb from the sRGB colorspace into the linear RGB colorspace. + Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace. llsd-lsl-syntax-version diff --git a/generated/lua_keywords_pretty.xml b/generated/lua_keywords_pretty.xml index 44292b1b..fe29ac72 100644 --- a/generated/lua_keywords_pretty.xml +++ b/generated/lua_keywords_pretty.xml @@ -331,7 +331,7 @@ export type rotation = quaternion math.huge tooltip - A value larger than any other numeric value (infinity). + Value larger than any other numeric value (infinity). type number value @@ -340,7 +340,7 @@ export type rotation = quaternion math.pi tooltip - Value of pi. + The number of radians in a half circle (semi-circle). type number value @@ -349,7 +349,7 @@ export type rotation = quaternion quaternion.identity tooltip - Identity quaternion constant. + Identity quaternion constant. Causes no change when rotated. type quaternion value @@ -367,7 +367,7 @@ export type rotation = quaternion vector.one tooltip - Constant vector with all components set to 1. + Vector constant with all components set to 1. type vector value @@ -376,7 +376,7 @@ export type rotation = quaternion vector.zero tooltip - Constant vector with all components set to 0. + Vector constant with all components set to 0. type vector value @@ -5166,7 +5166,7 @@ export type rotation = quaternion PI tooltip - Mathematical constant Pi (3.14159265), representing the number of radians in a half circle (semi-circle). When used in sensor functions, it specifies a full sphere scan. + Mathematical constant pi, representing the number of radians in a half circle (semi-circle). When used in sensor functions, it specifies a full sphere scan. type number value @@ -5184,7 +5184,7 @@ export type rotation = quaternion PI_BY_TWO tooltip - Constant Pi/2 (1.57079633), representing the number of radians in a quarter circle. When used in sensor functions, it specifies a hemisphere scan. + Mathematical constant pi/2, representing the number of radians in a quarter circle. When used in sensor functions, it specifies a hemisphere scan. type number value @@ -7087,7 +7087,7 @@ float falloff – ranges from 0.01 to 2.0 RAD_TO_DEG tooltip - Constant 57.2957795 (precise value is 180/PI). Multiply a value in radians by this number to convert it to degrees. + 180/PI. Multiply a value in radians by this number to convert it to degrees. type number value @@ -8164,7 +8164,7 @@ float falloff – ranges from 0.01 to 2.0 SQRT2 tooltip - Mathematical constant representing the square root of 2 (1.41421356). + Mathematical constant representing the square root of 2. type number value @@ -8832,7 +8832,7 @@ float falloff – ranges from 0.01 to 2.0 TWO_PI tooltip - Mathematical constant representing the number of radians in a full circle (6.28318530, twice the value of PI). + Mathematical constant pi*2, representing the number of radians in a full circle. type number value @@ -11438,10 +11438,10 @@ float falloff – ranges from 0.01 to 2.0 arguments - n + val tooltip - Number to shift. + Integer to shift. type number @@ -11463,7 +11463,7 @@ float falloff – ranges from 0.01 to 2.0 sleep 0.0 tooltip - Shifts n by i bits to the right. If i is negative, a left shift is performed. + Returns val shifted by i bits to the right. If i is negative, a left shift is performed. Does an arithmetic shift: The most significant bit of n is propagated during the shift. Returns 0 if i < -31, or all sign bits if i > 31. @@ -11475,7 +11475,7 @@ Returns 0 if i < -31, or all sign bits if i > 31. ... tooltip - Numbers to perform bitwise AND on. + Integers to perform bitwise AND on. type ...number @@ -11488,17 +11488,17 @@ Returns 0 if i < -31, or all sign bits if i > 31. sleep 0.0 tooltip - Performs a bitwise AND operation on input numbers. + Returns the bitwise AND of the given numbers. bit32.bnot arguments - n + val tooltip - Number to negate. + Integer to negate. type number @@ -11511,7 +11511,7 @@ Returns 0 if i < -31, or all sign bits if i > 31. sleep 0.0 tooltip - Returns the bitwise negation of the input number. + Returns the bitwise negation of val. bit32.bor @@ -11521,7 +11521,7 @@ Returns 0 if i < -31, or all sign bits if i > 31. ... tooltip - Numbers to perform bitwise OR on. + Integers to perform bitwise OR on. type ...number @@ -11534,7 +11534,7 @@ Returns 0 if i < -31, or all sign bits if i > 31. sleep 0.0 tooltip - Performs a bitwise OR operation on input numbers. + Returns the bitwise OR of the given numbers. bit32.btest @@ -11544,7 +11544,7 @@ Returns 0 if i < -31, or all sign bits if i > 31. ... tooltip - Numbers to perform bitwise AND on. + Integers to perform bitwise AND on. type ...number @@ -11557,8 +11557,7 @@ Returns 0 if i < -31, or all sign bits if i > 31. sleep 0.0 tooltip - Performs a bitwise AND operation on input numbers. -Returns true if result is non-zero. + Returns true if the bitwise AND of the given numbers is non-zero. bit32.bxor @@ -11568,7 +11567,7 @@ Returns true if result is non-zero. ... tooltip - Numbers to perform bitwise XOR on. + Integers to perform bitwise XOR on. type ...number @@ -11581,17 +11580,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Performs a bitwise XOR operation on input numbers. + Returns the bitwise XOR of the given numbers. bit32.byteswap arguments - n + val tooltip - Number whose byte order will be swapped. + Integer whose byte order will be swapped. type number @@ -11604,17 +11603,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Swap byte order. + Returns val with its bytes swapped to the reverse order. bit32.countlz arguments - n + val tooltip - Number whose leading zeros will be counted. + Integer to count leading zeros in. type number @@ -11627,17 +11626,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Count leading zeros. + Returns the count of val's leading zeros. bit32.countrz arguments - n + val tooltip - Number whose trailing zeros will be counted. + Integer to count trailing zeros in. type number @@ -11650,17 +11649,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Count trailing zeros. + Returns the count of val's troiling zeros. bit32.extract arguments - n + src tooltip - Number to extract from. + Integer to extract from. type number @@ -11678,7 +11677,7 @@ Returns true if result is non-zero. width tooltip - Number of bits to extract (optional, defaults to 1). + Number of bits to extract, or 1 if omitted (optional, defaults to 1). type number? @@ -11691,17 +11690,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Extracts bits from n at position field with width. Raises an error if the selected bit range goes outside [0, 31]. + Returns width bits from src, starting from bit index field. Raises an error if the selected bit range is goes outside the range [0, 31]. bit32.lrotate arguments - n + val tooltip - Number to rotate. + Integer to rotate. type number @@ -11723,17 +11722,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Rotates n by i bits to the left. If i is negative, a right rotate is performed. + Returns val rotated by i bits to the left. If i is negative, a right rotate is performed. bit32.lshift arguments - n + val tooltip - Number to shift. + Integer to shift. type number @@ -11755,26 +11754,26 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Shifts n by i bits to the left. If i is negative, a right shift is performed. Returns 0 if i is outside the [-31, 31] range. + Returns val shifted by i bits to the left. If i is negative, a right shift is performed. Returns 0 if i is outside the [-31, 31] range. bit32.replace arguments - n + dst tooltip - Number to replace in. + Integer to replace bits in. type number - v + src tooltip - Value containing the new bits to insert. + Integer containing the replacement bits. type number @@ -11783,7 +11782,7 @@ Returns true if result is non-zero. field tooltip - Starting index. + Starting bit index, zero-based type number @@ -11792,7 +11791,7 @@ Returns true if result is non-zero. width tooltip - Number of bits to replace (optional, defaults to 1). + Number of bits to replace, or 1 if omitted (optional, defaults to 1). type number? @@ -11805,17 +11804,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Replaces bits in n at position field with width using value v. Raises an error if the selected bit range goes outside [0, 31]. + Returns dst with width bits replaced from src, starting from bit index field. Raises an error if the selected bit range goes outside the range [0, 31]. bit32.rrotate arguments - n + val tooltip - Number to rotate. + Integer to rotate. type number @@ -11837,17 +11836,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Rotates n by i bits to the right. If i is negative, a left rotate is performed. + Returns val rotated by i bits to the right. If i is negative, a left rotate is performed. bit32.rshift arguments - n + val tooltip - Number to shift. + Integer to shift. type number @@ -11869,17 +11868,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Shifts n by i bits to the right. If i is negative, a left shift is performed. Returns 0 if i is outside the [-31, 31] range. + Returns val shifted by i bits to the right. If i is negative, a left shift is performed. Returns 0 if i is outside the [-31, 31] range. bit32.s32 arguments - n + val tooltip - Number to truncate. + Integer to truncate. type number @@ -11892,14 +11891,14 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Wrap this number from float64 range to signed int32 range and truncate to integer. Makes integer arithmetic compatible with LSL. + Returns val, wrapped from float64 range to signed int32 range and truncated to integer. Makes integer arithmetic compatable with LSL. bit32.smul arguments - a + val1 tooltip Left factor. @@ -11908,7 +11907,7 @@ Returns true if result is non-zero. - b + val2 tooltip Right factor. @@ -11924,7 +11923,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Multiplies two signed 32-bit integers. Returns the result as a signed 32-bit integer, wrapping as necessary. Avoids precision loss associated with float64 multiplication. Compatible with LSL integer multiplication. + Returns the product of two signed 32-bit integers as a signed 32-bit integer, wrapping as necessary. Avoids precision loss associated with float64 multiplication. Compatible with LSL integer multiplication. buffer @@ -13508,10 +13507,10 @@ Returns true if result is non-zero. arguments - n + val tooltip - A number. + Number to convert. type number @@ -13524,17 +13523,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the absolute value of n. + Returns the absolute (positive) value of val. math.acos arguments - n + val tooltip - A number in the range [-1, 1]. + Cosine value in the range [-1.0, 1.0] to invert. type number @@ -13547,17 +13546,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the arc cosine of n in radians. + Returns the arccosine of val in radians. Returns NaN if val is not in range [-1.0, 1.0]. math.asin arguments - n + val tooltip - A number in the range [-1, 1]. + Sine value in the range [-1.0, 1.0] to invert. type number @@ -13570,17 +13569,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the arc sine of n in radians. + Returns the arcsine of val in radians. Returns NaN if val is not in range [-1.0, 1.0]. math.atan arguments - n + val tooltip - A number. + Tangent value to invert. type number @@ -13593,7 +13592,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the arc tangent of n in radians. + Returns the arctangent of val in radians. math.atan2 @@ -13603,7 +13602,7 @@ Returns true if result is non-zero. y tooltip - Y-coordinate. + Y coordinate. type number @@ -13612,7 +13611,7 @@ Returns true if result is non-zero. x tooltip - X-coordinate. + X coordinate. type number @@ -13625,17 +13624,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the arc tangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter. + Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter. math.ceil arguments - n + val tooltip - A number to round up. + Number to round up. type number @@ -13648,17 +13647,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the smallest integer larger than or equal to n. + Returns val rounded toward positive infinity. In other words, returns the smallest integer greater than or equal to val. math.clamp arguments - n + val tooltip - Value to be clamped. + Number to clamp. type number @@ -13689,17 +13688,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns n clamped between min and max. Raises an error if min is greater than max. + Returns val clamped between min and max. Raises an error if min is greater than max. math.cos arguments - n + theta tooltip - An angle in radians. + Angle in radians. type number @@ -13712,17 +13711,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the cosine of n. n is in radians. + Returns the cosine of theta. theta is in radians. math.cosh arguments - n + val tooltip - A number to compute the hyperbolic cosine of. + Number to compute the hyperbolic cosine of. type number @@ -13742,10 +13741,10 @@ Returns true if result is non-zero. arguments - n + theta tooltip - A value in radians. + Number in radians. type number @@ -13758,17 +13757,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Converts n from radians to degrees. + Returns theta converted from radians to degrees. math.exp arguments - n + val tooltip - A number to compute e^n. + Number to compute e^n. type number @@ -13781,17 +13780,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the base-e exponent of n. + Returns the e to the power of val. math.floor arguments - n + val tooltip - A number to round down. + Number to round down. type number @@ -13804,14 +13803,14 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the largest integer smaller than or equal to n. + Returns val rounded toward negative infinity. In other words, returns the largest integer less than or equal to val. math.fmod arguments - x + dividend tooltip Dividend. @@ -13820,10 +13819,10 @@ Returns true if result is non-zero. - y + modulus tooltip - Divisor. + Modulus. type number @@ -13836,17 +13835,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the remainder of x modulo y, rounded towards zero. + Returns the remainder (modulo) of dividend/modulus, (i.e. d mod m), rounded towards zero. Returns NaN if modulus is 0. Identical to d % m if both arguments have the same sign. math.frexp arguments - n + val tooltip - A number to split into significand and exponent. + Number to split into significand and exponent. type number @@ -13859,14 +13858,14 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns m and e such that n = m * 2^e. + Breaks a floating-point number into it's component parts significand and exponent. In other words, Returns significand s and integer exponent e such that val = s * 2^e. Inverse of math.ldexp. math.isfinite arguments - n + val tooltip Number to check as finite. @@ -13882,14 +13881,14 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns true if n is finite. + Returns true if val is finite. math.isinf arguments - n + val tooltip Number to check as infinite. @@ -13905,14 +13904,14 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns true if n is infinite. + Returns true if val is infinite. math.isnan arguments - n + val tooltip Number to check as NaN. @@ -13928,14 +13927,14 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns true if n is NaN. + Returns true if val is NaN. math.ldexp arguments - s + significand tooltip Significand. @@ -13944,7 +13943,7 @@ Returns true if result is non-zero. - e + exponent tooltip Exponent. @@ -13960,26 +13959,26 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns s * 2^e. + Returns s * 2^e. Inverse of math.frexp math.lerp arguments - a + start tooltip - Start value. + Starting value. type number - b + end tooltip - End value. + Ending value. type number @@ -14001,17 +14000,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Linearly interpolates between a and b using factor t. + Linearly interpolates between start and end using factor t. math.log arguments - n + val tooltip - A number to compute logarithm. + Number to compute the logarithm of. type number @@ -14033,17 +14032,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the logarithm of n in the given base, defaults to e. + Returns the logarithm of val in the given base. The default base is e. math.log10 arguments - n + val tooltip - A number to compute base-10 logarithm. + Number to compute base-10 logarithm. type number @@ -14056,14 +14055,14 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the base-10 logarithm of n. + Returns the base-10 logarithm of val. math.map arguments - n + val tooltip Number to map. @@ -14115,17 +14114,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Maps n from input range to output range. + Maps val from input range to output range. math.max arguments - n + val tooltip - A number to find the maximum from. + Number to find the maximum from. type number @@ -14154,10 +14153,10 @@ Returns true if result is non-zero. arguments - n + val tooltip - A number to find the minimum from. + Number to find the minimum from. type number @@ -14186,10 +14185,10 @@ Returns true if result is non-zero. arguments - n + val tooltip - A number to split into integer and fractional parts. + Number to split into integer and fractional parts. type number @@ -14202,7 +14201,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the integer and fractional parts of n. + Returns the integer and fractional parts of val. math.noise @@ -14282,10 +14281,10 @@ Returns true if result is non-zero. arguments - n + theta tooltip - A value in degrees. + Angle in degrees. type number @@ -14298,7 +14297,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Converts n from degrees to radians. + Returns theta converted from degrees to radians. math.random @@ -14362,10 +14361,10 @@ Returns true if result is non-zero. arguments - n + val tooltip - A number to round to the nearest integer. Halfway values are rounded away from zero. + Number to round to the nearest integer. Halfway values are rounded away from zero. type number @@ -14378,17 +14377,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Rounds n to the nearest integer. + Returns val rounded to the nearest integer. Halfway values are rounded away from zero. math.sign arguments - n + val tooltip - A number to get the sign of. + Number to get the sign of. type number @@ -14401,17 +14400,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns -1 if n is negative, 1 if positive, and 0 if zero. + Returns -1 if val is negative, 1 if positive, and 0 if zero. math.sin arguments - n + theta tooltip - An angle in radians. + Angle in radians. type number @@ -14424,17 +14423,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the sine of n. n is in radians. + Returns the sine of theta. theta is in radians. math.sinh arguments - n + val tooltip - A number to compute the hyperbolic sine of. + Number to compute the hyperbolic sine of. type number @@ -14447,17 +14446,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the hyperbolic sine of n. + Returns the hyperbolic sine of val. math.sqrt arguments - n + val tooltip - A number to compute the square root of. + Number to compute the square root of. type number @@ -14470,17 +14469,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the square root of n. + Returns the square root of val. If negative, return Nan. math.tan arguments - n + theta tooltip - An angle in radians. + Angle in radians. type number @@ -14493,17 +14492,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the tangent of n. n is in radians. + Returns the tangent of theta. theta is in radians. math.tanh arguments - n + val tooltip - A number to compute the hyperbolic tangent of. + Number to compute the hyperbolic tangent of. type number @@ -14516,7 +14515,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the hyperbolic tangent of n. + Returns the hyperbolic tangent of val. os @@ -14686,7 +14685,7 @@ Returns true if result is non-zero. q tooltip - Input quaternion. + Quaternion to conjugate. type quaternion @@ -14699,7 +14698,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the conjugate of the quaternion. + Returns the conjugate of the quaternion. Equivilant to quaternion(-q.x, -q.y, -q.z, q.s)) quaternion.create @@ -14756,7 +14755,7 @@ Returns true if result is non-zero. arguments - a + q1 tooltip Left input quaternion. @@ -14765,7 +14764,7 @@ Returns true if result is non-zero. - b + q2 tooltip Right input quaternion. @@ -14781,7 +14780,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the dot product of two quaternions. + Returns the dot product of two quaternions. quaternion.magnitude @@ -14791,7 +14790,7 @@ Returns true if result is non-zero. q tooltip - Input quaternion. + Quaternion to evaluate. type quaternion @@ -14804,7 +14803,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the magnitude of the quaternion. + Returns the magnitude (geometric length) of the quaternion. quaternion.normalize @@ -14814,7 +14813,7 @@ Returns true if result is non-zero. q tooltip - Input quaternion. + Quaternion to normalize. type quaternion @@ -14827,26 +14826,26 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the normalized version (unit quaternion) of the quaternion. + Returns the normalized unit quaternion pointing the same direction as q. quaternion.slerp arguments - a + start_q tooltip - Start quaternion. + Starting quaternion. type quaternion - b + end_q tooltip - End quaternion. + Ending quaternion. type quaternion @@ -14868,7 +14867,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Spherical linear interpolation from a to b using factor t. + Spherical linear interpolation from start to end using factor t. quaternion.tofwd @@ -14878,7 +14877,7 @@ Returns true if result is non-zero. q tooltip - Input quaternion. + Quaternion to convert. type quaternion @@ -14891,7 +14890,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the forward vector from the quaternion. + Returns the unit vector pointing toward positive X direction (forward) in the coordinate space of rotation q. Equivilant to vector(1, 0, 0) * q. quaternion.toleft @@ -14901,7 +14900,7 @@ Returns true if result is non-zero. q tooltip - Input quaternion. + Quaternion to convert. type quaternion @@ -14914,7 +14913,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the left vector from the quaternion. + Returns the unit vector pointing toward positive Y direction (left) in the coordinate space of rotation q. Equivilant to vector(0, 1, 0) * q. quaternion.toup @@ -14924,7 +14923,7 @@ Returns true if result is non-zero. q tooltip - Input quaternion. + Quaternion to convert. type quaternion @@ -14937,7 +14936,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the up vector from the quaternion. + Returns the unit vector pointing toward positive Z direction (up) in the coordinate space of rotation q. Equivilant to vector(0, 0, 1) * q. string @@ -16501,10 +16500,10 @@ Returns true if result is non-zero. arguments - v + vec tooltip - Input vector. + Vector to convert. type vector @@ -16524,19 +16523,19 @@ Returns true if result is non-zero. arguments - a + start_vec tooltip - Left input vector. + Starting vector. type vector - b + end_vec tooltip - Right input vector. + Ending vector. type vector @@ -16558,17 +16557,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the angle between two vectors in radians. The axis, if specified, is used to determine the sign of the angle. + Returns the angle from start_vec to end_vec in radians. The axis, if specified, is used to determine the sign of the angle. If no axis is specified, the angle is positive, as if axis was vector.cross(start_vec, end_vec). vector.ceil arguments - v + vec tooltip - Input vector. + Vector to round up. type vector @@ -16588,10 +16587,10 @@ Returns true if result is non-zero. arguments - v + vec tooltip - Input vector to be clamped. + Vector to be clamped. type vector @@ -16670,19 +16669,19 @@ Returns true if result is non-zero. arguments - a + start_vec tooltip - Left input vector. + Starting vector. type vector - b + end_vec tooltip - Right input vector. + Ending vector. type vector @@ -16695,14 +16694,14 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the cross product of two vectors. + Returns the cross product of two vectors. vector.dot arguments - a + vec1 tooltip Left input vector. @@ -16711,7 +16710,7 @@ Returns true if result is non-zero. - b + vec2 tooltip Right input vector. @@ -16727,17 +16726,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the dot product of two vectors. + Returns the dot product of two vectors. vector.floor arguments - v + vec tooltip - Input vector. + Vector to round down. type vector @@ -16757,19 +16756,19 @@ Returns true if result is non-zero. arguments - a + start tooltip - Start vector. + Starting vector. type vector - b + end tooltip - End vector. + Ending vector. type vector @@ -16791,17 +16790,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Linearly interpolates between a and b using factor t. + Linearly interpolates between start and end using factor t. vector.magnitude arguments - v + vec tooltip - Input vector. + Vector to evaluate. type vector @@ -16814,17 +16813,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the magnitude of the vector. + Returns the magnitude (geometric length) of the vector. vector.max arguments - v + vec tooltip - Input vector. + Vector to find the maximum from. type vector @@ -16853,10 +16852,10 @@ Returns true if result is non-zero. arguments - v + vec tooltip - Input vector. + Vector to find the minimum from. type vector @@ -16885,10 +16884,10 @@ Returns true if result is non-zero. arguments - v + vec tooltip - Input vector. + Vector to normalize. type vector @@ -16901,17 +16900,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Computes the normalized version (unit vector) of the vector. + Returns the normalized unit vector pointing the same direction as vec. vector.sign arguments - v + vec tooltip - Input vector. + Vector to get the sign of. type vector @@ -16941,7 +16940,7 @@ Returns true if result is non-zero. val tooltip - Any integer value. + Integer to convert. type number @@ -16956,7 +16955,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns an integer representing the absolute (positive) value of val. + Returns the absolute (positive) integer value of val. ll.Acos @@ -16966,7 +16965,7 @@ Returns true if result is non-zero. val tooltip - A floating-point value falling in the range [-1.0, 1.0]. + A number in the range [-1.0, 1.0]. type number @@ -16981,7 +16980,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the arc-cosine of val in radians. + Returns the arccosine of val in radians. ll.AddToLandBanList @@ -17155,7 +17154,7 @@ Returns true if result is non-zero. arguments - a + start_rot tooltip Starting rotation. @@ -17164,7 +17163,7 @@ Returns true if result is non-zero. - b + end_rot tooltip Ending rotation. @@ -17180,7 +17179,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the angle in radians between rotations a and b. + Returns the angle, in radians, between rotations start_rot and and end_rot. ll.ApplyImpulse @@ -17254,7 +17253,7 @@ Returns true if result is non-zero. val tooltip - A floating-point value falling in the range [-1.0, 1.0]. + A number in the range [-1.0, 1.0]. type number @@ -17269,7 +17268,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the arc-sine of val in radians. + Returns the arcsine of val in radians. ll.Atan2 @@ -17279,7 +17278,7 @@ Returns true if result is non-zero. y tooltip - A floating-point value representing the y coordinate. + Y coordinate. type number @@ -17288,7 +17287,7 @@ Returns true if result is non-zero. x tooltip - A floating-point value representing the x coordinate. + X coordinate. type number @@ -17303,7 +17302,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the arctangent2 of y and x. + Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter. ll.AttachToAvatar @@ -17437,7 +17436,7 @@ Returns true if result is non-zero. axis tooltip - Axis vector around which the rotation is generated. + Axis vector to rotate around. type vector @@ -17446,7 +17445,7 @@ Returns true if result is non-zero. angle tooltip - Angle of rotation, expressed in radians. + Angle to rotate, in radians. type number @@ -17459,7 +17458,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the rotation representing a generated angle (in radians) about the specified axis. + Returns the rotation that rotates angle radians around the axis vector. ll.Base64ToInteger @@ -17620,7 +17619,7 @@ Returns true if result is non-zero. val tooltip - Float value to round. + Number to round up. type number @@ -17635,7 +17634,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the smallest integer value greater than or equal to val (rounded toward positive infinity). + Returns val rounded toward positive infinity. In other words, returns the smallest integer greater than or equal to val. ll.Char @@ -17917,7 +17916,7 @@ Returns true if result is non-zero. theta tooltip - Angle expressed in radians. + An angle in radians. type number @@ -17932,7 +17931,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the cosine of theta. + Returns the cosine of theta. theta is in radians. ll.CreateCharacter @@ -18917,10 +18916,10 @@ Returns true if result is non-zero. arguments - v + vec tooltip - Vector of Euler angles to convert. + Vector of Euler angles to convert, in radians. type vector @@ -18933,7 +18932,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the rotation representation of the Euler angles vector v. + Returns the quaternion representation of the Euler angles (in radians) within vec. ll.Evade @@ -19007,7 +19006,7 @@ Returns true if result is non-zero. val tooltip - Float value to convert. + Number to convert. type number @@ -19022,7 +19021,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the absolute (positive) value of val. + Returns the absolute (positive) value of val. ll.FindNotecardTextCount @@ -19173,7 +19172,7 @@ Returns true if result is non-zero. val tooltip - Float value to round. + Number to round down. type number @@ -19188,7 +19187,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the largest integer value less than or equal to val (rounded toward negative infinity). + Returns val rounded toward negative infinity. In other words, returns the largest integer less than or equal to val. ll.ForceMouselook @@ -22857,7 +22856,7 @@ Returns true if result is non-zero. color tooltip - RGB color vector in linear space to convert. + Color vector in the linear RGB space to convert. type vector @@ -22870,7 +22869,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a vector representing the conversion of color from the linear RGB colorspace into the sRGB colorspace. + Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace. ll.LinkAdjustSoundVolume @@ -24291,9 +24290,9 @@ Returns true if result is non-zero. src tooltip - List of floats and integers to analyze. + List of numbers to analyze. type - list + {number} @@ -24304,7 +24303,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the result of performing the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. + Returns the numeric result of the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src. ll.Listen @@ -24460,7 +24459,7 @@ Returns true if result is non-zero. val tooltip - Float value to evaluate. + Number to compute the logarithm of. type number @@ -24475,7 +24474,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the natural (base e) logarithm of the positive value val (returns 0.0 if val <= 0). + Returns natural (base e) logarithm of val. If negative, return 0.0. ll.Log10 @@ -24485,7 +24484,7 @@ Returns true if result is non-zero. val tooltip - Float value to evaluate. + Number to compute the logarithm of. type number @@ -24500,7 +24499,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the base-10 (common) logarithm of the positive value val (returns 0.0 if val <= 0). + Returns base-10 (common) logarithm of val. If negative, return 0.0. ll.LookAt @@ -25197,28 +25196,28 @@ Returns true if result is non-zero. arguments - a + base tooltip - Base integer value. + 32-bit unsigned integer base. type number - b + exponent tooltip - Power exponent (capped at 0xFFFF / 16 bits). + 32-bit unsigned integer exponent. type number - c + modulus tooltip - Modulus integer value. + 32-bit unsigned integer modulus. type number @@ -25231,7 +25230,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns an integer representing a raised to the power b, modulo c (i.e., (a**b)%c). The b value is capped at 0xFFFF (16 bits). + Returns base raised to the power exponent, modulo modulus (i.e., (b^e)%m). All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. Output is wrapped to signed 32-bit integer range [-2147483648..2147483647]. Will never overflow, unlike (b^e), which can overflow to inf. ll.ModifyLand @@ -25831,7 +25830,7 @@ Returns true if result is non-zero. base tooltip - Base float value. + Base number. type number @@ -25840,7 +25839,7 @@ Returns true if result is non-zero. exponent tooltip - Exponent float value. + Exponent number. type number @@ -25855,7 +25854,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing base raised to the power exponent. Returns 0 and triggers a Math Error for imaginary results. + Returns base raised to the power exponent. If result is imaginary, returns NaN. ll.PreloadSound @@ -27051,10 +27050,10 @@ Returns true if result is non-zero. arguments - rot + q tooltip - Rotation value. + Rotation to evaluate. type quaternion @@ -27067,17 +27066,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the rotation angle of rot. + Returns the angle, in radians, that q rotates. ll.Rot2Axis arguments - rot + q tooltip - Rotation value. + Rotation to evaluate. type quaternion @@ -27090,17 +27089,17 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a vector representing the rotation axis of rot. + Returns the unit vector axis that q rotates around. ll.Rot2Euler arguments - quat + q tooltip - Rotation value to convert. + Rotation to convert. type quaternion @@ -27113,7 +27112,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a vector representing the Euler rotation (roll, pitch, yaw) of quat, with each component expressed in radians. + Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles will be in radians. ll.Rot2Fwd @@ -27123,7 +27122,7 @@ Returns true if result is non-zero. q tooltip - Rotation value. + Rotation to convert. type quaternion @@ -27138,7 +27137,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q. + Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q. ll.Rot2Left @@ -27148,7 +27147,7 @@ Returns true if result is non-zero. q tooltip - Rotation value. + Rotation to convert. type quaternion @@ -27163,7 +27162,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q. + Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q. ll.Rot2Up @@ -27173,7 +27172,7 @@ Returns true if result is non-zero. q tooltip - Rotation value. + Rotation to convert. type quaternion @@ -27188,7 +27187,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q. + Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q. ll.RotBetween @@ -27207,7 +27206,7 @@ Returns true if result is non-zero. end_vec tooltip - Target ending vector. + Ending vector. type vector @@ -27220,7 +27219,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a rotation representing the shortest path rotation from vector start to vector end. + Returns the shortest-path quaternion that rotates start_vec onto end_vec. ll.RotLookAt @@ -27358,7 +27357,7 @@ Returns true if result is non-zero. val tooltip - Float value to round. + Number to round. type number @@ -27373,7 +27372,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns the integer that float val is closest to. + Returns val rounded to the nearest integer. Halfway values are rounded toward infinity. ll.SHA1String @@ -29936,7 +29935,7 @@ Returns true if result is non-zero. theta tooltip - Angle expressed in radians. + An angle in radians. type number @@ -29951,7 +29950,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the sine of theta. + Returns the sine of theta. theta is in radians. ll.SitOnLink @@ -30140,7 +30139,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the square root of the positive value val. Triggers a math runtime error if val is less than 0.0 (imaginary results). + Returns the square root of val. If negative, return Nan. ll.StartAnimation @@ -30478,7 +30477,7 @@ Returns true if result is non-zero. theta tooltip - Angle expressed in radians. + An angle in radians. type number @@ -30493,7 +30492,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the tangent of theta. + Returns the tangent of theta. theta is in radians. ll.Target @@ -31173,7 +31172,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a float representing the magnitude (geometric length) of the vector vec. + Returns the magnitude (geometric length) of vec. ll.VecNorm @@ -31198,7 +31197,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a normalized unit vector sharing the same direction as vec. + Returns the normalized unit vector pointing the same direction as vec. ll.VerifyRSA @@ -31520,7 +31519,7 @@ Returns true if result is non-zero. arguments - srgb + color tooltip Color vector in the sRGB colorspace to convert. @@ -31536,7 +31535,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Returns a vector representing the conversion of the color srgb from the sRGB colorspace into the linear RGB colorspace. + Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace. llsd-lsl-syntax-version diff --git a/generated/secondlife.d.luau b/generated/secondlife.d.luau index 1504889c..3889f3e0 100644 --- a/generated/secondlife.d.luau +++ b/generated/secondlife.d.luau @@ -335,23 +335,23 @@ declare function xpcall(f: (A...) -> R1..., err: (E) -> R --------------------------- declare bit32: { - arshift: @checked (n: number, i: number) -> number, + arshift: @checked (val: number, i: number) -> number, band: @checked (...number) -> number, - bnot: @checked (n: number) -> number, + bnot: @checked (val: number) -> number, bor: @checked (...number) -> number, bxor: @checked (...number) -> number, btest: @checked (...number) -> boolean, - extract: @checked (n: number, field: number, width: number?) -> number, - lrotate: @checked (n: number, i: number) -> number, - lshift: @checked (n: number, i: number) -> number, - replace: @checked (n: number, v: number, field: number, width: number?) -> number, - rrotate: @checked (n: number, i: number) -> number, - rshift: @checked (n: number, i: number) -> number, - s32: @checked (n: number) -> number, - smul: @checked (a: number, b: number) -> number, - countlz: @checked (n: number) -> number, - countrz: @checked (n: number) -> number, - byteswap: @checked (n: number) -> number, + extract: @checked (src: number, field: number, width: number?) -> number, + lrotate: @checked (val: number, i: number) -> number, + lshift: @checked (val: number, i: number) -> number, + replace: @checked (dst: number, src: number, field: number, width: number?) -> number, + rrotate: @checked (val: number, i: number) -> number, + rshift: @checked (val: number, i: number) -> number, + s32: @checked (val: number) -> number, + smul: @checked (val1: number, val2: number) -> number, + countlz: @checked (val: number) -> number, + countrz: @checked (val: number) -> number, + byteswap: @checked (val: number) -> number, } @@ -474,43 +474,43 @@ declare llprim: { declare math: { pi: number, huge: number, - abs: @checked (n: number) -> number, - acos: @checked (n: number) -> number, - asin: @checked (n: number) -> number, - atan: @checked (n: number) -> number, + abs: @checked (val: number) -> number, + acos: @checked (val: number) -> number, + asin: @checked (val: number) -> number, + atan: @checked (val: number) -> number, atan2: @checked (y: number, x: number) -> number, - ceil: @checked (n: number) -> number, - clamp: @checked (n: number, min: number, max: number) -> number, - cos: @checked (n: number) -> number, - cosh: @checked (n: number) -> number, - deg: @checked (n: number) -> number, - exp: @checked (n: number) -> number, - floor: @checked (n: number) -> number, - fmod: @checked (x: number, y: number) -> number, - frexp: @checked (n: number) -> (number, number), - ldexp: @checked (s: number, e: number) -> number, - lerp: @checked (a: number, b: number, t: number) -> number, - log: @checked (n: number, base: number?) -> number, - log10: @checked (n: number) -> number, - map: @checked (n: number, inMin: number, inMax: number, outMin: number, outMax: number) -> number, - max: @checked (n: number, ...number) -> number, - min: @checked (n: number, ...number) -> number, - modf: @checked (n: number) -> (number, number), + ceil: @checked (val: number) -> number, + clamp: @checked (val: number, min: number, max: number) -> number, + cos: @checked (theta: number) -> number, + cosh: @checked (val: number) -> number, + deg: @checked (theta: number) -> number, + exp: @checked (val: number) -> number, + floor: @checked (val: number) -> number, + fmod: @checked (dividend: number, modulus: number) -> number, + frexp: @checked (val: number) -> (number, number), + ldexp: @checked (significand: number, exponent: number) -> number, + lerp: @checked (start: number, end_: number, t: number) -> number, + log: @checked (val: number, base: number?) -> number, + log10: @checked (val: number) -> number, + map: @checked (val: number, inMin: number, inMax: number, outMin: number, outMax: number) -> number, + max: @checked (val: number, ...number) -> number, + min: @checked (val: number, ...number) -> number, + modf: @checked (val: number) -> (number, number), noise: @checked (x: number, y: number?, z: number?) -> number, pow: @checked (base: number, exponent: number) -> number, - rad: @checked (n: number) -> number, + rad: @checked (theta: number) -> number, random: @checked (min: number?, max: number?) -> number, randomseed: @checked @[deprecated {reason='Disabled in SLua.'}](seed: number) -> (), - round: @checked (n: number) -> number, - sign: @checked (n: number) -> number, - sin: @checked (n: number) -> number, - sinh: @checked (n: number) -> number, - sqrt: @checked (n: number) -> number, - tan: @checked (n: number) -> number, - tanh: @checked (n: number) -> number, - isnan: @checked (n: number) -> boolean, - isinf: @checked (n: number) -> boolean, - isfinite: @checked (n: number) -> boolean, + round: @checked (val: number) -> number, + sign: @checked (val: number) -> number, + sin: @checked (theta: number) -> number, + sinh: @checked (val: number) -> number, + sqrt: @checked (val: number) -> number, + tan: @checked (theta: number) -> number, + tanh: @checked (val: number) -> number, + isnan: @checked (val: number) -> boolean, + isinf: @checked (val: number) -> boolean, + isfinite: @checked (val: number) -> boolean, } @@ -537,8 +537,8 @@ declare quaternion: ((x: number, y: number, z: number, s: number) -> quaternion) create: (x: number, y: number, z: number, s: number) -> quaternion, normalize: (q: quaternion) -> quaternion, magnitude: (q: quaternion) -> number, - dot: (a: quaternion, b: quaternion) -> number, - slerp: (a: quaternion, b: quaternion, t: number) -> quaternion, + dot: (q1: quaternion, q2: quaternion) -> number, + slerp: (start_q: quaternion, end_q: quaternion, t: number) -> quaternion, conjugate: (q: quaternion) -> quaternion, tofwd: (q: quaternion) -> vector, toleft: (q: quaternion) -> vector, @@ -633,19 +633,19 @@ declare vector: ((x: number, y: number, z: number?) -> vector) & { zero: vector, one: vector, create: (x: number, y: number, z: number?) -> vector, - magnitude: (v: vector) -> number, - normalize: (v: vector) -> vector, - cross: (a: vector, b: vector) -> vector, - dot: (a: vector, b: vector) -> number, - angle: (a: vector, b: vector, axis: vector?) -> number, - floor: (v: vector) -> vector, - ceil: (v: vector) -> vector, - abs: (v: vector) -> vector, - sign: (v: vector) -> vector, - clamp: (v: vector, min: vector, max: vector) -> vector, - max: (v: vector, ...vector) -> vector, - min: (v: vector, ...vector) -> vector, - lerp: (a: vector, b: vector, t: number) -> vector, + magnitude: (vec: vector) -> number, + normalize: (vec: vector) -> vector, + cross: (start_vec: vector, end_vec: vector) -> vector, + dot: (vec1: vector, vec2: vector) -> number, + angle: (start_vec: vector, end_vec: vector, axis: vector?) -> number, + floor: (vec: vector) -> vector, + ceil: (vec: vector) -> vector, + abs: (vec: vector) -> vector, + sign: (vec: vector) -> vector, + clamp: (vec: vector, min: vector, max: vector) -> vector, + max: (vec: vector, ...vector) -> vector, + min: (vec: vector, ...vector) -> vector, + lerp: (start: vector, end_: vector, t: number) -> vector, } declare rotation: typeof(quaternion) @@ -665,7 +665,7 @@ declare ll: { AdjustSoundVolume: (volume: number) -> (), AgentInExperience: (agent: uuid) -> boolean, AllowInventoryDrop: (add: boolean | number) -> (), - AngleBetween: (a: quaternion, b: quaternion) -> number, + AngleBetween: (start_rot: quaternion, end_rot: quaternion) -> number, ApplyImpulse: (momentum: vector, is_local: boolean | number) -> (), ApplyRotationalImpulse: (force: vector, is_local: boolean | number) -> (), Asin: @[deprecated {use='math.asin', reason='Double precision; fastcall.'}](val: number) -> number, @@ -730,7 +730,7 @@ declare ll: { EjectFromLand: (avatar: uuid) -> (), Email: (address: string, subject: string, message: string) -> (), EscapeURL: (url: string) -> string, - Euler2Rot: (v: vector) -> quaternion, + Euler2Rot: (vec: vector) -> quaternion, Evade: (target: uuid, options: list) -> (), ExecCharacterCmd: (command: number, options: list) -> (), Fabs: @[deprecated {use='math.abs', reason='Double precision; fastcall.'}](val: number) -> number, @@ -945,7 +945,7 @@ declare ll: { ListReplaceList: @[deprecated {use='t[n] = x', reason='Unnecessary table copying.'}](dest: {T}, src: {T}, start_index: number, end_index: number) -> {T}, ListSort: (src: {T}, stride: number, ascending: boolean | number) -> {T}, ListSortStrided: @[deprecated {use='table.sort', reason='Prefer structured tables over strided lists.'}](src: {T}, stride: number, stride_index: number, ascending: boolean | number) -> {T}, - ListStatistics: (operation: number, src: list) -> number, + ListStatistics: (operation: number, src: {number}) -> number, Listen: (channel: number, name: string, id: uuid, msg: string) -> number, ListenControl: (handle: number, active: boolean | number) -> (), ListenRemove: (handle: number) -> (), @@ -966,7 +966,7 @@ declare ll: { MapDestination: (simname: string, pos: vector, look_at: vector) -> (), MessageLinked: (link: number, num: number, str: string | uuid, id: string | uuid) -> (), MinEventDelay: (delay: number) -> (), - ModPow: (a: number, b: number, c: number) -> number, + ModPow: (base: number, exponent: number, modulus: number) -> number, ModifyLand: (action: number, brush: number) -> (), MoveToTarget: (target: vector, tau: number) -> (), Name2Key: (name: string) -> uuid, @@ -1028,9 +1028,9 @@ declare ll: { RezAtRoot: (item: string, pos: vector, vel: vector, rot: quaternion, start_param: number) -> (), RezObject: (item: string, pos: vector, vel: vector, rot: quaternion, start_param: number) -> (), RezObjectWithParams: (item: string, options: list) -> uuid, - Rot2Angle: (rot: quaternion) -> number, - Rot2Axis: (rot: quaternion) -> vector, - Rot2Euler: (quat: quaternion) -> vector, + Rot2Angle: (q: quaternion) -> number, + Rot2Axis: (q: quaternion) -> vector, + Rot2Euler: (q: quaternion) -> vector, Rot2Fwd: @[deprecated {use='quaternion.tofwd'}](q: quaternion) -> vector, Rot2Left: @[deprecated {use='quaternion.toleft'}](q: quaternion) -> vector, Rot2Up: @[deprecated {use='quaternion.toup'}](q: quaternion) -> vector, @@ -1171,7 +1171,7 @@ declare ll: { XorBase64: (str1: string, str2: string) -> string, XorBase64Strings: @[deprecated {use='ll.XorBase64'}](str1: string, str2: string) -> string, XorBase64StringsCorrect: @[deprecated {use='ll.XorBase64'}](str1: string, str2: string) -> string, - sRGB2Linear: (srgb: vector) -> vector, + sRGB2Linear: (color: vector) -> vector, } @@ -1188,7 +1188,7 @@ declare llcompat: { AdjustSoundVolume: @deprecated (volume: number) -> (), AgentInExperience: @deprecated (agent: uuid) -> number, AllowInventoryDrop: @deprecated (add: boolean | number) -> (), - AngleBetween: @deprecated (a: quaternion, b: quaternion) -> number, + AngleBetween: @deprecated (start_rot: quaternion, end_rot: quaternion) -> number, ApplyImpulse: @deprecated (momentum: vector, is_local: boolean | number) -> (), ApplyRotationalImpulse: @deprecated (force: vector, is_local: boolean | number) -> (), Asin: @deprecated (val: number) -> number, @@ -1253,7 +1253,7 @@ declare llcompat: { EjectFromLand: @deprecated (avatar: uuid) -> (), Email: @deprecated (address: string, subject: string, message: string) -> (), EscapeURL: @deprecated (url: string) -> string, - Euler2Rot: @deprecated (v: vector) -> quaternion, + Euler2Rot: @deprecated (vec: vector) -> quaternion, Evade: @deprecated (target: uuid, options: list) -> (), ExecCharacterCmd: @deprecated (command: number, options: list) -> (), Fabs: @deprecated (val: number) -> number, @@ -1469,7 +1469,7 @@ declare llcompat: { ListReplaceList: @deprecated (dest: {T}, src: {T}, start_index: number, end_index: number) -> {T}, ListSort: @deprecated (src: {T}, stride: number, ascending: boolean | number) -> {T}, ListSortStrided: @deprecated (src: {T}, stride: number, stride_index: number, ascending: boolean | number) -> {T}, - ListStatistics: @deprecated (operation: number, src: list) -> number, + ListStatistics: @deprecated (operation: number, src: {number}) -> number, Listen: @deprecated (channel: number, name: string, id: uuid, msg: string) -> number, ListenControl: @deprecated (handle: number, active: boolean | number) -> (), ListenRemove: @deprecated (handle: number) -> (), @@ -1490,7 +1490,7 @@ declare llcompat: { MapDestination: @deprecated (simname: string, pos: vector, look_at: vector) -> (), MessageLinked: @deprecated (link: number, num: number, str: string | uuid, id: string | uuid) -> (), MinEventDelay: @deprecated (delay: number) -> (), - ModPow: @deprecated (a: number, b: number, c: number) -> number, + ModPow: @deprecated (base: number, exponent: number, modulus: number) -> number, ModifyLand: @deprecated (action: number, brush: number) -> (), MoveToTarget: @deprecated (target: vector, tau: number) -> (), Name2Key: @deprecated (name: string) -> uuid, @@ -1553,9 +1553,9 @@ declare llcompat: { RezAtRoot: @deprecated (item: string, pos: vector, vel: vector, rot: quaternion, start_param: number) -> (), RezObject: @deprecated (item: string, pos: vector, vel: vector, rot: quaternion, start_param: number) -> (), RezObjectWithParams: @deprecated (item: string, options: list) -> uuid, - Rot2Angle: @deprecated (rot: quaternion) -> number, - Rot2Axis: @deprecated (rot: quaternion) -> vector, - Rot2Euler: @deprecated (quat: quaternion) -> vector, + Rot2Angle: @deprecated (q: quaternion) -> number, + Rot2Axis: @deprecated (q: quaternion) -> vector, + Rot2Euler: @deprecated (q: quaternion) -> vector, Rot2Fwd: @deprecated (q: quaternion) -> vector, Rot2Left: @deprecated (q: quaternion) -> vector, Rot2Up: @deprecated (q: quaternion) -> vector, @@ -1698,7 +1698,7 @@ declare llcompat: { XorBase64: @deprecated (str1: string, str2: string) -> string, XorBase64Strings: @deprecated (str1: string, str2: string) -> string, XorBase64StringsCorrect: @deprecated (str1: string, str2: string) -> string, - sRGB2Linear: @deprecated (srgb: vector) -> vector, + sRGB2Linear: @deprecated (color: vector) -> vector, } declare ACTIVE: number diff --git a/generated/secondlife.docs.json b/generated/secondlife.docs.json index 7811e602..9ab16314 100644 --- a/generated/secondlife.docs.json +++ b/generated/secondlife.docs.json @@ -88,71 +88,71 @@ "learn_more_link": "https://luau.org/library/#bit32-library" }, "@sl-slua/global/bit32.arshift": { - "documentation": "Shifts n by i bits to the right. If i is negative, a left shift is performed.
Does an arithmetic shift: The most significant bit of n is propagated during the shift.
Returns 0 if i < -31, or all sign bits if i > 31.", + "documentation": "Returns val shifted by i bits to the right. If i is negative, a left shift is performed.
Does an arithmetic shift: The most significant bit of n is propagated during the shift.
Returns 0 if i < -31, or all sign bits if i > 31.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#arshift" }, "@sl-slua/global/bit32.band": { - "documentation": "Performs a bitwise AND operation on input numbers.", + "documentation": "Returns the bitwise AND of the given numbers.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#band" }, "@sl-slua/global/bit32.bnot": { - "documentation": "Returns the bitwise negation of the input number.", + "documentation": "Returns the bitwise negation of val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#bnot" }, "@sl-slua/global/bit32.bor": { - "documentation": "Performs a bitwise OR operation on input numbers.", + "documentation": "Returns the bitwise OR of the given numbers.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#bor" }, "@sl-slua/global/bit32.bxor": { - "documentation": "Performs a bitwise XOR operation on input numbers.", + "documentation": "Returns the bitwise XOR of the given numbers.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#bxor" }, "@sl-slua/global/bit32.btest": { - "documentation": "Performs a bitwise AND operation on input numbers.
Returns true if result is non-zero.", + "documentation": "Returns true if the bitwise AND of the given numbers is non-zero.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#btest" }, "@sl-slua/global/bit32.extract": { - "documentation": "Extracts bits from n at position field with width. Raises an error if the selected bit range goes outside [0, 31].", + "documentation": "Returns width bits from src, starting from bit index field. Raises an error if the selected bit range is goes outside the range [0, 31].", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#extract" }, "@sl-slua/global/bit32.lrotate": { - "documentation": "Rotates n by i bits to the left. If i is negative, a right rotate is performed.", + "documentation": "Returns val rotated by i bits to the left. If i is negative, a right rotate is performed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#lrotate" }, "@sl-slua/global/bit32.lshift": { - "documentation": "Shifts n by i bits to the left. If i is negative, a right shift is performed. Returns 0 if i is outside the [-31, 31] range.", + "documentation": "Returns val shifted by i bits to the left. If i is negative, a right shift is performed. Returns 0 if i is outside the [-31, 31] range.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#lshift" }, "@sl-slua/global/bit32.replace": { - "documentation": "Replaces bits in n at position field with width using value v. Raises an error if the selected bit range goes outside [0, 31].", + "documentation": "Returns dst with width bits replaced from src, starting from bit index field. Raises an error if the selected bit range goes outside the range [0, 31].", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#replace" }, "@sl-slua/global/bit32.rrotate": { - "documentation": "Rotates n by i bits to the right. If i is negative, a left rotate is performed.", + "documentation": "Returns val rotated by i bits to the right. If i is negative, a left rotate is performed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#rrotate" }, "@sl-slua/global/bit32.rshift": { - "documentation": "Shifts n by i bits to the right. If i is negative, a left shift is performed. Returns 0 if i is outside the [-31, 31] range.", + "documentation": "Returns val shifted by i bits to the right. If i is negative, a left shift is performed. Returns 0 if i is outside the [-31, 31] range.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#rshift" }, "@sl-slua/global/bit32.s32": { - "documentation": "Wrap this number from float64 range to signed int32 range and truncate to integer. Makes integer arithmetic compatible with LSL.", + "documentation": "Returns val, wrapped from float64 range to signed int32 range and truncated to integer. Makes integer arithmetic compatable with LSL.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#s32" }, "@sl-slua/global/bit32.smul": { - "documentation": "Multiplies two signed 32-bit integers. Returns the result as a signed 32-bit integer, wrapping as necessary. Avoids precision loss associated with float64 multiplication. Compatible with LSL integer multiplication.", + "documentation": "Returns the product of two signed 32-bit integers as a signed 32-bit integer, wrapping as necessary. Avoids precision loss associated with float64 multiplication. Compatible with LSL integer multiplication.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#smul" }, "@sl-slua/global/bit32.countlz": { - "documentation": "Count leading zeros.", + "documentation": "Returns the count of val's leading zeros.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#countlz" }, "@sl-slua/global/bit32.countrz": { - "documentation": "Count trailing zeros.", + "documentation": "Returns the count of val's troiling zeros.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#countrz" }, "@sl-slua/global/bit32.byteswap": { - "documentation": "Swap byte order.", + "documentation": "Returns val with its bytes swapped to the reverse order.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#byteswap" }, "@sl-slua/global/buffer": { @@ -387,43 +387,43 @@ "learn_more_link": "https://luau.org/library/#math-library" }, "@sl-slua/global/math.pi": { - "documentation": "Value: 3.141592653589793
Value of pi.", + "documentation": "Value: 3.141592653589793
The number of radians in a half circle (semi-circle).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#pi" }, "@sl-slua/global/math.huge": { - "documentation": "Value: inf
A value larger than any other numeric value (infinity).", + "documentation": "Value: inf
Value larger than any other numeric value (infinity).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#huge" }, "@sl-slua/global/math.abs": { - "documentation": "Returns the absolute value of n.", + "documentation": "Returns the absolute (positive) value of val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#abs" }, "@sl-slua/global/math.acos": { - "documentation": "Returns the arc cosine of n in radians.", + "documentation": "Returns the arccosine of val in radians. Returns NaN if val is not in range [-1.0, 1.0].", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#acos" }, "@sl-slua/global/math.asin": { - "documentation": "Returns the arc sine of n in radians.", + "documentation": "Returns the arcsine of val in radians. Returns NaN if val is not in range [-1.0, 1.0].", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#asin" }, "@sl-slua/global/math.atan": { - "documentation": "Returns the arc tangent of n in radians.", + "documentation": "Returns the arctangent of val in radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#atan" }, "@sl-slua/global/math.atan2": { - "documentation": "Returns the arc tangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter.", + "documentation": "Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#atan2" }, "@sl-slua/global/math.ceil": { - "documentation": "Returns the smallest integer larger than or equal to n.", + "documentation": "Returns val rounded toward positive infinity. In other words, returns the smallest integer greater than or equal to val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#ceil" }, "@sl-slua/global/math.clamp": { - "documentation": "Returns n clamped between min and max. Raises an error if min is greater than max.", + "documentation": "Returns val clamped between min and max. Raises an error if min is greater than max.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#clamp" }, "@sl-slua/global/math.cos": { - "documentation": "Returns the cosine of n. n is in radians.", + "documentation": "Returns the cosine of theta. theta is in radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#cos" }, "@sl-slua/global/math.cosh": { @@ -431,43 +431,43 @@ "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#cosh" }, "@sl-slua/global/math.deg": { - "documentation": "Converts n from radians to degrees.", + "documentation": "Returns theta converted from radians to degrees.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#deg" }, "@sl-slua/global/math.exp": { - "documentation": "Returns the base-e exponent of n.", + "documentation": "Returns the e to the power of val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#exp" }, "@sl-slua/global/math.floor": { - "documentation": "Returns the largest integer smaller than or equal to n.", + "documentation": "Returns val rounded toward negative infinity. In other words, returns the largest integer less than or equal to val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#floor" }, "@sl-slua/global/math.fmod": { - "documentation": "Returns the remainder of x modulo y, rounded towards zero.", + "documentation": "Returns the remainder (modulo) of dividend/modulus, (i.e. d mod m), rounded towards zero. Returns NaN if modulus is 0. Identical to d % m if both arguments have the same sign.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#fmod" }, "@sl-slua/global/math.frexp": { - "documentation": "Returns m and e such that n = m * 2^e.", + "documentation": "Breaks a floating-point number into it's component parts significand and exponent. In other words, Returns significand s and integer exponent e such that val = s * 2^e. Inverse of math.ldexp.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#frexp" }, "@sl-slua/global/math.ldexp": { - "documentation": "Returns s * 2^e.", + "documentation": "Returns s * 2^e. Inverse of math.frexp", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#ldexp" }, "@sl-slua/global/math.lerp": { - "documentation": "Linearly interpolates between a and b using factor t.", + "documentation": "Linearly interpolates between start and end using factor t.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#lerp" }, "@sl-slua/global/math.log": { - "documentation": "Returns the logarithm of n in the given base, defaults to e.", + "documentation": "Returns the logarithm of val in the given base. The default base is e.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#log" }, "@sl-slua/global/math.log10": { - "documentation": "Returns the base-10 logarithm of n.", + "documentation": "Returns the base-10 logarithm of val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#log10" }, "@sl-slua/global/math.map": { - "documentation": "Maps n from input range to output range.", + "documentation": "Maps val from input range to output range.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#map" }, "@sl-slua/global/math.max": { @@ -479,7 +479,7 @@ "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#min" }, "@sl-slua/global/math.modf": { - "documentation": "Returns the integer and fractional parts of n.", + "documentation": "Returns the integer and fractional parts of val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#modf" }, "@sl-slua/global/math.noise": { @@ -491,7 +491,7 @@ "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#pow" }, "@sl-slua/global/math.rad": { - "documentation": "Converts n from degrees to radians.", + "documentation": "Returns theta converted from degrees to radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#rad" }, "@sl-slua/global/math.random": { @@ -503,43 +503,43 @@ "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#randomseed" }, "@sl-slua/global/math.round": { - "documentation": "Rounds n to the nearest integer.", + "documentation": "Returns val rounded to the nearest integer. Halfway values are rounded away from zero.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#round" }, "@sl-slua/global/math.sign": { - "documentation": "Returns -1 if n is negative, 1 if positive, and 0 if zero.", + "documentation": "Returns -1 if val is negative, 1 if positive, and 0 if zero.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#sign" }, "@sl-slua/global/math.sin": { - "documentation": "Returns the sine of n. n is in radians.", + "documentation": "Returns the sine of theta. theta is in radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#sin" }, "@sl-slua/global/math.sinh": { - "documentation": "Returns the hyperbolic sine of n.", + "documentation": "Returns the hyperbolic sine of val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#sinh" }, "@sl-slua/global/math.sqrt": { - "documentation": "Returns the square root of n.", + "documentation": "Returns the square root of val. If negative, return Nan.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#sqrt" }, "@sl-slua/global/math.tan": { - "documentation": "Returns the tangent of n. n is in radians.", + "documentation": "Returns the tangent of theta. theta is in radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#tan" }, "@sl-slua/global/math.tanh": { - "documentation": "Returns the hyperbolic tangent of n.", + "documentation": "Returns the hyperbolic tangent of val.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#tanh" }, "@sl-slua/global/math.isnan": { - "documentation": "Returns true if n is NaN.", + "documentation": "Returns true if val is NaN.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#isnan" }, "@sl-slua/global/math.isinf": { - "documentation": "Returns true if n is infinite.", + "documentation": "Returns true if val is infinite.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#isinf" }, "@sl-slua/global/math.isfinite": { - "documentation": "Returns true if n is finite.", + "documentation": "Returns true if val is finite.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#isfinite" }, "@sl-slua/global/os": { @@ -566,7 +566,7 @@ "documentation": "Creates a new quaternion with the given component values. Alias of quaternion.create." }, "@sl-slua/global/quaternion.identity": { - "documentation": "Value: quaternion(0, 0, 0, 1)
Identity quaternion constant.", + "documentation": "Value: quaternion(0, 0, 0, 1)
Identity quaternion constant. Causes no change when rotated.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.create": { @@ -574,39 +574,39 @@ "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.normalize": { - "documentation": "Computes the normalized version (unit quaternion) of the quaternion.", + "documentation": "Returns the normalized unit quaternion pointing the same direction as q.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.magnitude": { - "documentation": "Computes the magnitude of the quaternion.", + "documentation": "Returns the magnitude (geometric length) of the quaternion.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.dot": { - "documentation": "Computes the dot product of two quaternions.", + "documentation": "Returns the dot product of two quaternions.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.slerp": { - "documentation": "Spherical linear interpolation from a to b using factor t.", + "documentation": "Spherical linear interpolation from start to end using factor t.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.conjugate": { - "documentation": "Computes the conjugate of the quaternion.", + "documentation": "Returns the conjugate of the quaternion. Equivilant to quaternion(-q.x, -q.y, -q.z, q.s))", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.tofwd": { - "documentation": "Computes the forward vector from the quaternion.", + "documentation": "Returns the unit vector pointing toward positive X direction (forward) in the coordinate space of rotation q. Equivilant to vector(1, 0, 0) * q.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.toleft": { - "documentation": "Computes the left vector from the quaternion.", + "documentation": "Returns the unit vector pointing toward positive Y direction (left) in the coordinate space of rotation q. Equivilant to vector(0, 1, 0) * q.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/quaternion.toup": { - "documentation": "Computes the up vector from the quaternion.", + "documentation": "Returns the unit vector pointing toward positive Z direction (up) in the coordinate space of rotation q. Equivilant to vector(0, 0, 1) * q.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.identity": { - "documentation": "Value: quaternion(0, 0, 0, 1)
Identity quaternion constant.", + "documentation": "Value: quaternion(0, 0, 0, 1)
Identity quaternion constant. Causes no change when rotated.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.create": { @@ -614,35 +614,35 @@ "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.normalize": { - "documentation": "Computes the normalized version (unit quaternion) of the quaternion.", + "documentation": "Returns the normalized unit quaternion pointing the same direction as q.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.magnitude": { - "documentation": "Computes the magnitude of the quaternion.", + "documentation": "Returns the magnitude (geometric length) of the quaternion.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.dot": { - "documentation": "Computes the dot product of two quaternions.", + "documentation": "Returns the dot product of two quaternions.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.slerp": { - "documentation": "Spherical linear interpolation from a to b using factor t.", + "documentation": "Spherical linear interpolation from start to end using factor t.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.conjugate": { - "documentation": "Computes the conjugate of the quaternion.", + "documentation": "Returns the conjugate of the quaternion. Equivilant to quaternion(-q.x, -q.y, -q.z, q.s))", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.tofwd": { - "documentation": "Computes the forward vector from the quaternion.", + "documentation": "Returns the unit vector pointing toward positive X direction (forward) in the coordinate space of rotation q. Equivilant to vector(1, 0, 0) * q.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.toleft": { - "documentation": "Computes the left vector from the quaternion.", + "documentation": "Returns the unit vector pointing toward positive Y direction (left) in the coordinate space of rotation q. Equivilant to vector(0, 1, 0) * q.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/rotation.toup": { - "documentation": "Computes the up vector from the quaternion.", + "documentation": "Returns the unit vector pointing toward positive Z direction (up) in the coordinate space of rotation q. Equivilant to vector(0, 0, 1) * q.", "learn_more_link": "https://suzanna-linn.github.io/slua/moving-rotations" }, "@sl-slua/global/string": { @@ -840,11 +840,11 @@ "learn_more_link": "https://luau.org/library/#vector-library" }, "@sl-slua/global/vector.zero": { - "documentation": "Value: vector(0, 0, 0)
Constant vector with all components set to 0.", + "documentation": "Value: vector(0, 0, 0)
Vector constant with all components set to 0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#zero" }, "@sl-slua/global/vector.one": { - "documentation": "Value: vector(1, 1, 1)
Constant vector with all components set to 1.", + "documentation": "Value: vector(1, 1, 1)
Vector constant with all components set to 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#one" }, "@sl-slua/global/vector.create": { @@ -852,23 +852,23 @@ "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#create" }, "@sl-slua/global/vector.magnitude": { - "documentation": "Computes the magnitude of the vector.", + "documentation": "Returns the magnitude (geometric length) of the vector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#magnitude" }, "@sl-slua/global/vector.normalize": { - "documentation": "Computes the normalized version (unit vector) of the vector.", + "documentation": "Returns the normalized unit vector pointing the same direction as vec.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#normalize" }, "@sl-slua/global/vector.cross": { - "documentation": "Computes the cross product of two vectors.", + "documentation": "Returns the cross product of two vectors.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#cross" }, "@sl-slua/global/vector.dot": { - "documentation": "Computes the dot product of two vectors.", + "documentation": "Returns the dot product of two vectors.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#dot" }, "@sl-slua/global/vector.angle": { - "documentation": "Computes the angle between two vectors in radians. The axis, if specified, is used to determine the sign of the angle.", + "documentation": "Returns the angle from start_vec to end_vec in radians. The axis, if specified, is used to determine the sign of the angle. If no axis is specified, the angle is positive, as if axis was vector.cross(start_vec, end_vec).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#angle" }, "@sl-slua/global/vector.floor": { @@ -900,18 +900,18 @@ "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#min" }, "@sl-slua/global/vector.lerp": { - "documentation": "Linearly interpolates between a and b using factor t.", + "documentation": "Linearly interpolates between start and end using factor t.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#lerp" }, "@sl-slua/global/ll": { "documentation": "Library for functions shared between LSL and SLua." }, "@sl-slua/global/ll.Abs": { - "documentation": "Returns an integer representing the absolute (positive) value of val.", + "documentation": "Returns the absolute (positive) integer value of val.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAbs" }, "@sl-slua/global/ll.Acos": { - "documentation": "Returns a float representing the arc-cosine of val in radians.", + "documentation": "Returns the arccosine of val in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAcos" }, "@sl-slua/global/ll.AddToLandBanList": { @@ -939,7 +939,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlAllowInventoryDrop" }, "@sl-slua/global/ll.AngleBetween": { - "documentation": "Returns a float representing the angle in radians between rotations a and b.", + "documentation": "Returns the angle, in radians, between rotations start_rot and and end_rot.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAngleBetween" }, "@sl-slua/global/ll.ApplyImpulse": { @@ -951,11 +951,11 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlApplyRotationalImpulse" }, "@sl-slua/global/ll.Asin": { - "documentation": "Returns a float representing the arc-sine of val in radians.", + "documentation": "Returns the arcsine of val in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAsin" }, "@sl-slua/global/ll.Atan2": { - "documentation": "Returns a float representing the arctangent2 of y and x.", + "documentation": "Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAtan2" }, "@sl-slua/global/ll.AttachToAvatar": { @@ -979,7 +979,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlAxes2Rot" }, "@sl-slua/global/ll.AxisAngle2Rot": { - "documentation": "Returns the rotation representing a generated angle (in radians) about the specified axis.", + "documentation": "Returns the rotation that rotates angle radians around the axis vector.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAxisAngle2Rot" }, "@sl-slua/global/ll.Base64ToInteger": { @@ -1007,7 +1007,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlCastRay" }, "@sl-slua/global/ll.Ceil": { - "documentation": "Returns the smallest integer value greater than or equal to val (rounded toward positive infinity).", + "documentation": "Returns val rounded toward positive infinity. In other words, returns the smallest integer greater than or equal to val.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlCeil" }, "@sl-slua/global/ll.Char": { @@ -1051,7 +1051,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlComputeHash" }, "@sl-slua/global/ll.Cos": { - "documentation": "Returns a float representing the cosine of theta.", + "documentation": "Returns the cosine of theta. theta is in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlCos" }, "@sl-slua/global/ll.CreateCharacter": { @@ -1199,7 +1199,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlEscapeURL" }, "@sl-slua/global/ll.Euler2Rot": { - "documentation": "Returns the rotation representation of the Euler angles vector v.", + "documentation": "Returns the quaternion representation of the Euler angles (in radians) within vec.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlEuler2Rot" }, "@sl-slua/global/ll.Evade": { @@ -1211,7 +1211,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlExecCharacterCmd" }, "@sl-slua/global/ll.Fabs": { - "documentation": "Returns a float representing the absolute (positive) value of val.", + "documentation": "Returns the absolute (positive) value of val.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlFabs" }, "@sl-slua/global/ll.FindNotecardTextCount": { @@ -1227,7 +1227,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlFleeFrom" }, "@sl-slua/global/ll.Floor": { - "documentation": "Returns the largest integer value less than or equal to val (rounded toward negative infinity).", + "documentation": "Returns val rounded toward negative infinity. In other words, returns the largest integer less than or equal to val.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlFloor" }, "@sl-slua/global/ll.ForceMouselook": { @@ -1899,7 +1899,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlKeysKeyValue" }, "@sl-slua/global/ll.Linear2sRGB": { - "documentation": "Returns a vector representing the conversion of color from the linear RGB colorspace into the sRGB colorspace.", + "documentation": "Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlLinear2sRGB" }, "@sl-slua/global/ll.LinkAdjustSoundVolume": { @@ -2059,7 +2059,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlListSortStrided" }, "@sl-slua/global/ll.ListStatistics": { - "documentation": "Returns a float representing the result of performing the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src.", + "documentation": "Returns the numeric result of the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlListStatistics" }, "@sl-slua/global/ll.Listen": { @@ -2079,11 +2079,11 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlLoadURL" }, "@sl-slua/global/ll.Log": { - "documentation": "Returns a float representing the natural (base e) logarithm of the positive value val (returns 0.0 if val <= 0).", + "documentation": "Returns natural (base e) logarithm of val. If negative, return 0.0.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlLog" }, "@sl-slua/global/ll.Log10": { - "documentation": "Returns a float representing the base-10 (common) logarithm of the positive value val (returns 0.0 if val <= 0).", + "documentation": "Returns base-10 (common) logarithm of val. If negative, return 0.0.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlLog10" }, "@sl-slua/global/ll.LookAt": { @@ -2143,7 +2143,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlMinEventDelay" }, "@sl-slua/global/ll.ModPow": { - "documentation": "Returns an integer representing a raised to the power b, modulo c (i.e., (a**b)%c). The b value is capped at 0xFFFF (16 bits).", + "documentation": "Returns base raised to the power exponent, modulo modulus (i.e., (b^e)%m). All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. Output is wrapped to signed 32-bit integer range [-2147483648..2147483647]. Will never overflow, unlike (b^e), which can overflow to inf.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlModPow" }, "@sl-slua/global/ll.ModifyLand": { @@ -2227,7 +2227,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlPlaySoundSlave" }, "@sl-slua/global/ll.Pow": { - "documentation": "Returns a float representing base raised to the power exponent. Returns 0 and triggers a Math Error for imaginary results.", + "documentation": "Returns base raised to the power exponent. If result is imaginary, returns NaN.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlPow" }, "@sl-slua/global/ll.PreloadSound": { @@ -2391,31 +2391,31 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlRezObjectWithParams" }, "@sl-slua/global/ll.Rot2Angle": { - "documentation": "Returns a float representing the rotation angle of rot.", + "documentation": "Returns the angle, in radians, that q rotates.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Angle" }, "@sl-slua/global/ll.Rot2Axis": { - "documentation": "Returns a vector representing the rotation axis of rot.", + "documentation": "Returns the unit vector axis that q rotates around.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Axis" }, "@sl-slua/global/ll.Rot2Euler": { - "documentation": "Returns a vector representing the Euler rotation (roll, pitch, yaw) of quat, with each component expressed in radians.", + "documentation": "Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles will be in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Euler" }, "@sl-slua/global/ll.Rot2Fwd": { - "documentation": "Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q.", + "documentation": "Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Fwd" }, "@sl-slua/global/ll.Rot2Left": { - "documentation": "Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q.", + "documentation": "Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Left" }, "@sl-slua/global/ll.Rot2Up": { - "documentation": "Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q.", + "documentation": "Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Up" }, "@sl-slua/global/ll.RotBetween": { - "documentation": "Returns a rotation representing the shortest path rotation from vector start to vector end.", + "documentation": "Returns the shortest-path quaternion that rotates start_vec onto end_vec.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRotBetween" }, "@sl-slua/global/ll.RotLookAt": { @@ -2435,7 +2435,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlRotateTexture" }, "@sl-slua/global/ll.Round": { - "documentation": "Returns the integer that float val is closest to.", + "documentation": "Returns val rounded to the nearest integer. Halfway values are rounded toward infinity.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRound" }, "@sl-slua/global/ll.SHA1String": { @@ -2751,7 +2751,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlSignRSA" }, "@sl-slua/global/ll.Sin": { - "documentation": "Returns a float representing the sine of theta.", + "documentation": "Returns the sine of theta. theta is in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlSin" }, "@sl-slua/global/ll.SitOnLink": { @@ -2775,7 +2775,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlSoundPreload" }, "@sl-slua/global/ll.Sqrt": { - "documentation": "Returns a float representing the square root of the positive value val. Triggers a math runtime error if val is less than 0.0 (imaginary results).", + "documentation": "Returns the square root of val. If negative, return Nan.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlSqrt" }, "@sl-slua/global/ll.StartAnimation": { @@ -2835,7 +2835,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlTakeControls" }, "@sl-slua/global/ll.Tan": { - "documentation": "Returns a float representing the tangent of theta.", + "documentation": "Returns the tangent of theta. theta is in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlTan" }, "@sl-slua/global/ll.Target": { @@ -2915,11 +2915,11 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlVecDist" }, "@sl-slua/global/ll.VecMag": { - "documentation": "Returns a float representing the magnitude (geometric length) of the vector vec.", + "documentation": "Returns the magnitude (geometric length) of vec.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlVecMag" }, "@sl-slua/global/ll.VecNorm": { - "documentation": "Returns a normalized unit vector sharing the same direction as vec.", + "documentation": "Returns the normalized unit vector pointing the same direction as vec.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlVecNorm" }, "@sl-slua/global/ll.VerifyRSA": { @@ -2963,18 +2963,18 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlXorBase64StringsCorrect" }, "@sl-slua/global/ll.sRGB2Linear": { - "documentation": "Returns a vector representing the conversion of the color srgb from the sRGB colorspace into the linear RGB colorspace.", + "documentation": "Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlsRGB2Linear" }, "@sl-slua/global/llcompat": { "documentation": "Like ll, but exactly matches LSL semantics." }, "@sl-slua/global/llcompat.Abs": { - "documentation": "Returns an integer representing the absolute (positive) value of val.", + "documentation": "Returns the absolute (positive) integer value of val.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAbs" }, "@sl-slua/global/llcompat.Acos": { - "documentation": "Returns a float representing the arc-cosine of val in radians.", + "documentation": "Returns the arccosine of val in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAcos" }, "@sl-slua/global/llcompat.AddToLandBanList": { @@ -3002,7 +3002,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlAllowInventoryDrop" }, "@sl-slua/global/llcompat.AngleBetween": { - "documentation": "Returns a float representing the angle in radians between rotations a and b.", + "documentation": "Returns the angle, in radians, between rotations start_rot and and end_rot.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAngleBetween" }, "@sl-slua/global/llcompat.ApplyImpulse": { @@ -3014,11 +3014,11 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlApplyRotationalImpulse" }, "@sl-slua/global/llcompat.Asin": { - "documentation": "Returns a float representing the arc-sine of val in radians.", + "documentation": "Returns the arcsine of val in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAsin" }, "@sl-slua/global/llcompat.Atan2": { - "documentation": "Returns a float representing the arctangent2 of y and x.", + "documentation": "Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAtan2" }, "@sl-slua/global/llcompat.AttachToAvatar": { @@ -3042,7 +3042,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlAxes2Rot" }, "@sl-slua/global/llcompat.AxisAngle2Rot": { - "documentation": "Returns the rotation representing a generated angle (in radians) about the specified axis.", + "documentation": "Returns the rotation that rotates angle radians around the axis vector.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlAxisAngle2Rot" }, "@sl-slua/global/llcompat.Base64ToInteger": { @@ -3070,7 +3070,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlCastRay" }, "@sl-slua/global/llcompat.Ceil": { - "documentation": "Returns the smallest integer value greater than or equal to val (rounded toward positive infinity).", + "documentation": "Returns val rounded toward positive infinity. In other words, returns the smallest integer greater than or equal to val.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlCeil" }, "@sl-slua/global/llcompat.Char": { @@ -3114,7 +3114,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlComputeHash" }, "@sl-slua/global/llcompat.Cos": { - "documentation": "Returns a float representing the cosine of theta.", + "documentation": "Returns the cosine of theta. theta is in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlCos" }, "@sl-slua/global/llcompat.CreateCharacter": { @@ -3262,7 +3262,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlEscapeURL" }, "@sl-slua/global/llcompat.Euler2Rot": { - "documentation": "Returns the rotation representation of the Euler angles vector v.", + "documentation": "Returns the quaternion representation of the Euler angles (in radians) within vec.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlEuler2Rot" }, "@sl-slua/global/llcompat.Evade": { @@ -3274,7 +3274,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlExecCharacterCmd" }, "@sl-slua/global/llcompat.Fabs": { - "documentation": "Returns a float representing the absolute (positive) value of val.", + "documentation": "Returns the absolute (positive) value of val.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlFabs" }, "@sl-slua/global/llcompat.FindNotecardTextCount": { @@ -3290,7 +3290,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlFleeFrom" }, "@sl-slua/global/llcompat.Floor": { - "documentation": "Returns the largest integer value less than or equal to val (rounded toward negative infinity).", + "documentation": "Returns val rounded toward negative infinity. In other words, returns the largest integer less than or equal to val.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlFloor" }, "@sl-slua/global/llcompat.ForceMouselook": { @@ -3966,7 +3966,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlKeysKeyValue" }, "@sl-slua/global/llcompat.Linear2sRGB": { - "documentation": "Returns a vector representing the conversion of color from the linear RGB colorspace into the sRGB colorspace.", + "documentation": "Returns the color vector converted from the linear RGB colorspace into the sRGB colorspace.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlLinear2sRGB" }, "@sl-slua/global/llcompat.LinkAdjustSoundVolume": { @@ -4126,7 +4126,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlListSortStrided" }, "@sl-slua/global/llcompat.ListStatistics": { - "documentation": "Returns a float representing the result of performing the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src.", + "documentation": "Returns the numeric result of the statistical aggregate function operation (a LIST_STAT_* constant) on the numeric list src.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlListStatistics" }, "@sl-slua/global/llcompat.Listen": { @@ -4146,11 +4146,11 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlLoadURL" }, "@sl-slua/global/llcompat.Log": { - "documentation": "Returns a float representing the natural (base e) logarithm of the positive value val (returns 0.0 if val <= 0).", + "documentation": "Returns natural (base e) logarithm of val. If negative, return 0.0.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlLog" }, "@sl-slua/global/llcompat.Log10": { - "documentation": "Returns a float representing the base-10 (common) logarithm of the positive value val (returns 0.0 if val <= 0).", + "documentation": "Returns base-10 (common) logarithm of val. If negative, return 0.0.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlLog10" }, "@sl-slua/global/llcompat.LookAt": { @@ -4210,7 +4210,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlMinEventDelay" }, "@sl-slua/global/llcompat.ModPow": { - "documentation": "Returns an integer representing a raised to the power b, modulo c (i.e., (a**b)%c). The b value is capped at 0xFFFF (16 bits).", + "documentation": "Returns base raised to the power exponent, modulo modulus (i.e., (b^e)%m). All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. Output is wrapped to signed 32-bit integer range [-2147483648..2147483647]. Will never overflow, unlike (b^e), which can overflow to inf.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlModPow" }, "@sl-slua/global/llcompat.ModifyLand": { @@ -4294,7 +4294,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlPlaySoundSlave" }, "@sl-slua/global/llcompat.Pow": { - "documentation": "Returns a float representing base raised to the power exponent. Returns 0 and triggers a Math Error for imaginary results.", + "documentation": "Returns base raised to the power exponent. If result is imaginary, returns NaN.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlPow" }, "@sl-slua/global/llcompat.PreloadSound": { @@ -4462,31 +4462,31 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlRezObjectWithParams" }, "@sl-slua/global/llcompat.Rot2Angle": { - "documentation": "Returns a float representing the rotation angle of rot.", + "documentation": "Returns the angle, in radians, that q rotates.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Angle" }, "@sl-slua/global/llcompat.Rot2Axis": { - "documentation": "Returns a vector representing the rotation axis of rot.", + "documentation": "Returns the unit vector axis that q rotates around.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Axis" }, "@sl-slua/global/llcompat.Rot2Euler": { - "documentation": "Returns a vector representing the Euler rotation (roll, pitch, yaw) of quat, with each component expressed in radians.", + "documentation": "Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles will be in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Euler" }, "@sl-slua/global/llcompat.Rot2Fwd": { - "documentation": "Returns a unit vector pointing in the local positive X direction (forward) relative to the parent (root prim or region) defined by rotation q.", + "documentation": "Returns the unit vector pointing toward positive X (forward) in the coordinate space of rotation q. Equivilant to <1, 0, 0> * q.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Fwd" }, "@sl-slua/global/llcompat.Rot2Left": { - "documentation": "Returns a unit vector pointing in the local positive Y direction (left) relative to the parent (root prim or region) defined by rotation q.", + "documentation": "Returns the unit vector pointing toward positive Y (left) in the coordinate space of rotation q. Equivilant to <0, 1, 0> * q.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Left" }, "@sl-slua/global/llcompat.Rot2Up": { - "documentation": "Returns a unit vector pointing in the local positive Z direction (up) relative to the parent (root prim or region) defined by rotation q.", + "documentation": "Returns the unit vector pointing toward positive Z (up) in the coordinate space of rotation q. Equivilant to <0, 0, 1> * q.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRot2Up" }, "@sl-slua/global/llcompat.RotBetween": { - "documentation": "Returns a rotation representing the shortest path rotation from vector start to vector end.", + "documentation": "Returns the shortest-path quaternion that rotates start_vec onto end_vec.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRotBetween" }, "@sl-slua/global/llcompat.RotLookAt": { @@ -4506,7 +4506,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlRotateTexture" }, "@sl-slua/global/llcompat.Round": { - "documentation": "Returns the integer that float val is closest to.", + "documentation": "Returns val rounded to the nearest integer. Halfway values are rounded toward infinity.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRound" }, "@sl-slua/global/llcompat.SHA1String": { @@ -4830,7 +4830,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlSignRSA" }, "@sl-slua/global/llcompat.Sin": { - "documentation": "Returns a float representing the sine of theta.", + "documentation": "Returns the sine of theta. theta is in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlSin" }, "@sl-slua/global/llcompat.SitOnLink": { @@ -4854,7 +4854,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlSoundPreload" }, "@sl-slua/global/llcompat.Sqrt": { - "documentation": "Returns a float representing the square root of the positive value val. Triggers a math runtime error if val is less than 0.0 (imaginary results).", + "documentation": "Returns the square root of val. If negative, return Nan.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlSqrt" }, "@sl-slua/global/llcompat.StartAnimation": { @@ -4914,7 +4914,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlTakeControls" }, "@sl-slua/global/llcompat.Tan": { - "documentation": "Returns a float representing the tangent of theta.", + "documentation": "Returns the tangent of theta. theta is in radians.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlTan" }, "@sl-slua/global/llcompat.Target": { @@ -4994,11 +4994,11 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlVecDist" }, "@sl-slua/global/llcompat.VecMag": { - "documentation": "Returns a float representing the magnitude (geometric length) of the vector vec.", + "documentation": "Returns the magnitude (geometric length) of vec.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlVecMag" }, "@sl-slua/global/llcompat.VecNorm": { - "documentation": "Returns a normalized unit vector sharing the same direction as vec.", + "documentation": "Returns the normalized unit vector pointing the same direction as vec.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlVecNorm" }, "@sl-slua/global/llcompat.VerifyRSA": { @@ -5042,7 +5042,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlXorBase64StringsCorrect" }, "@sl-slua/global/llcompat.sRGB2Linear": { - "documentation": "Returns a vector representing the conversion of the color srgb from the sRGB colorspace into the linear RGB colorspace.", + "documentation": "Returns the color vector converted from the sRGB colorspace into the linear RGB colorspace.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlsRGB2Linear" }, "@sl-slua/global/ACTIVE": { @@ -6627,13 +6627,13 @@ "documentation": "Value: 0x2000
Permissions mask representing transfer permission." }, "@sl-slua/global/PI": { - "documentation": "Value: 3.14159265
Mathematical constant Pi (3.14159265), representing the number of radians in a half circle (semi-circle). When used in sensor functions, it specifies a full sphere scan." + "documentation": "Value: 3.14159265
Mathematical constant pi, representing the number of radians in a half circle (semi-circle). When used in sensor functions, it specifies a full sphere scan." }, "@sl-slua/global/PING_PONG": { "documentation": "Value: 0x8
Used with texture animation functions to cause the animation to play forward first, and then in reverse." }, "@sl-slua/global/PI_BY_TWO": { - "documentation": "Value: 1.57079633
Constant Pi/2 (1.57079633), representing the number of radians in a quarter circle. When used in sensor functions, it specifies a hemisphere scan." + "documentation": "Value: 1.57079633
Mathematical constant pi/2, representing the number of radians in a quarter circle. When used in sensor functions, it specifies a hemisphere scan." }, "@sl-slua/global/PRIM_ALLOW_UNSIT": { "documentation": "Value: 39
Prim parameter for allowing or restricting manual standing for avatars seated on this prim within a valid experience. Ignored if the avatar was not seated via llSitOnLink. When restriction is active, participating seated avatars cannot manually stand or select another prim to sit on." @@ -7257,7 +7257,7 @@ "documentation": "Value: 0x00
Path update status code triggered when the character enters the slowdown distance near its current goal." }, "@sl-slua/global/RAD_TO_DEG": { - "documentation": "Value: 57.2957795
Constant 57.2957795 (precise value is 180/PI). Multiply a value in radians by this number to convert it to degrees." + "documentation": "Value: 57.2957795
180/PI. Multiply a value in radians by this number to convert it to degrees." }, "@sl-slua/global/RCERR_CAST_TIME_EXCEEDED": { "documentation": "Value: -3
Raycast error indicating the parcel or agent exceeded the maximum allocated raycast time. Waiting a few frames and retrying will usually succeed as resources replenish." @@ -7614,7 +7614,7 @@ "documentation": "Value: 0x02
Sound playback option that triggers a non-attached sound once at the prim's current location (does not move with the prim). This flag overrides all other sound playback options." }, "@sl-slua/global/SQRT2": { - "documentation": "Value: 1.41421356
Mathematical constant representing the square root of 2 (1.41421356)." + "documentation": "Value: 1.41421356
Mathematical constant representing the square root of 2." }, "@sl-slua/global/STATUS_BLOCK_GRAB": { "documentation": "Value: 0x40
Status flag (default FALSE) that blocks click-and-drag grab movements on unlinked prims or the root prim of a linkset. Useful for preventing physical objects from being trivially disturbed." @@ -7836,7 +7836,7 @@ "documentation": "Value: 0" }, "@sl-slua/global/TWO_PI": { - "documentation": "Value: 6.28318530
Mathematical constant representing the number of radians in a full circle (6.28318530, twice the value of PI)." + "documentation": "Value: 6.28318530
Mathematical constant pi*2, representing the number of radians in a full circle." }, "@sl-slua/global/TYPE_FLOAT": { "documentation": "Value: 2
Variable type constant indicating the list entry or value is a float." diff --git a/generated/secondlife_selene.yml b/generated/secondlife_selene.yml index 8f040e36..cf1af668 100644 --- a/generated/secondlife_selene.yml +++ b/generated/secondlife_selene.yml @@ -2486,9 +2486,9 @@ globals: PI: property: read-only type: number - description: Mathematical constant Pi (3.14159265), representing the number of - radians in a half circle (semi-circle). When used in sensor functions, it specifies - a full sphere scan. + description: Mathematical constant pi, representing the number of radians in a + half circle (semi-circle). When used in sensor functions, it specifies a full + sphere scan. PING_PONG: property: read-only type: number @@ -2497,7 +2497,7 @@ globals: PI_BY_TWO: property: read-only type: number - description: Constant Pi/2 (1.57079633), representing the number of radians in + description: Mathematical constant pi/2, representing the number of radians in a quarter circle. When used in sensor functions, it specifies a hemisphere scan. PRIM_ALLOW_UNSIT: property: read-only @@ -3548,8 +3548,8 @@ globals: RAD_TO_DEG: property: read-only type: number - description: Constant 57.2957795 (precise value is 180/PI). Multiply a value in - radians by this number to convert it to degrees. + description: 180/PI. Multiply a value in radians by this number to convert it + to degrees. RCERR_CAST_TIME_EXCEEDED: property: read-only type: number @@ -4120,7 +4120,7 @@ globals: SQRT2: property: read-only type: number - description: Mathematical constant representing the square root of 2 (1.41421356). + description: Mathematical constant representing the square root of 2. STATUS_BLOCK_GRAB: property: read-only type: number @@ -4492,8 +4492,8 @@ globals: TWO_PI: property: read-only type: number - description: Mathematical constant representing the number of radians in a full - circle (6.28318530, twice the value of PI). + description: Mathematical constant pi*2, representing the number of radians in + a full circle. TYPE_FLOAT: property: read-only type: number @@ -5071,8 +5071,8 @@ globals: - type: number - type: number must_use: true - description: 'Shifts n by i bits to the right. If i is negative, a left shift - is performed. + description: 'Returns val shifted by i bits to the right. If i is negative, a + left shift is performed. Does an arithmetic shift: The most significant bit of n is propagated during the shift. @@ -5082,29 +5082,27 @@ globals: args: - type: '...' must_use: true - description: Performs a bitwise AND operation on input numbers. + description: Returns the bitwise AND of the given numbers. bit32.bnot: args: - type: number must_use: true - description: Returns the bitwise negation of the input number. + description: Returns the bitwise negation of val. bit32.bor: args: - type: '...' must_use: true - description: Performs a bitwise OR operation on input numbers. + description: Returns the bitwise OR of the given numbers. bit32.bxor: args: - type: '...' must_use: true - description: Performs a bitwise XOR operation on input numbers. + description: Returns the bitwise XOR of the given numbers. bit32.btest: args: - type: '...' must_use: true - description: 'Performs a bitwise AND operation on input numbers. - - Returns true if result is non-zero.' + description: Returns true if the bitwise AND of the given numbers is non-zero. bit32.extract: args: - type: number @@ -5112,22 +5110,22 @@ globals: - type: number required: false must_use: true - description: Extracts bits from n at position field with width. Raises an error - if the selected bit range goes outside [0, 31]. + description: Returns width bits from src, starting from bit index field. Raises + an error if the selected bit range is goes outside the range [0, 31]. bit32.lrotate: args: - type: number - type: number must_use: true - description: Rotates n by i bits to the left. If i is negative, a right rotate - is performed. + description: Returns val rotated by i bits to the left. If i is negative, a right + rotate is performed. bit32.lshift: args: - type: number - type: number must_use: true - description: Shifts n by i bits to the left. If i is negative, a right shift is - performed. Returns 0 if i is outside the [-31, 31] range. + description: Returns val shifted by i bits to the left. If i is negative, a right + shift is performed. Returns 0 if i is outside the [-31, 31] range. bit32.replace: args: - type: number @@ -5136,51 +5134,52 @@ globals: - type: number required: false must_use: true - description: Replaces bits in n at position field with width using value v. Raises - an error if the selected bit range goes outside [0, 31]. + description: Returns dst with width bits replaced from src, starting from bit + index field. Raises an error if the selected bit range goes outside the range + [0, 31]. bit32.rrotate: args: - type: number - type: number must_use: true - description: Rotates n by i bits to the right. If i is negative, a left rotate - is performed. + description: Returns val rotated by i bits to the right. If i is negative, a left + rotate is performed. bit32.rshift: args: - type: number - type: number must_use: true - description: Shifts n by i bits to the right. If i is negative, a left shift is - performed. Returns 0 if i is outside the [-31, 31] range. + description: Returns val shifted by i bits to the right. If i is negative, a left + shift is performed. Returns 0 if i is outside the [-31, 31] range. bit32.s32: args: - type: number must_use: true - description: Wrap this number from float64 range to signed int32 range and truncate - to integer. Makes integer arithmetic compatible with LSL. + description: Returns val, wrapped from float64 range to signed int32 range and + truncated to integer. Makes integer arithmetic compatable with LSL. bit32.smul: args: - type: number - type: number must_use: true - description: Multiplies two signed 32-bit integers. Returns the result as a signed - 32-bit integer, wrapping as necessary. Avoids precision loss associated with - float64 multiplication. Compatible with LSL integer multiplication. + description: Returns the product of two signed 32-bit integers as a signed 32-bit + integer, wrapping as necessary. Avoids precision loss associated with float64 + multiplication. Compatible with LSL integer multiplication. bit32.countlz: args: - type: number must_use: true - description: Count leading zeros. + description: Returns the count of val's leading zeros. bit32.countrz: args: - type: number must_use: true - description: Count trailing zeros. + description: Returns the count of val's troiling zeros. bit32.byteswap: args: - type: number must_use: true - description: Swap byte order. + description: Returns val with its bytes swapped to the reverse order. buffer.create: args: - type: number @@ -5552,57 +5551,60 @@ globals: math.pi: property: read-only type: number - description: Value of pi. + description: The number of radians in a half circle (semi-circle). math.huge: property: read-only type: number - description: A value larger than any other numeric value (infinity). + description: Value larger than any other numeric value (infinity). math.abs: args: - type: number must_use: true - description: Returns the absolute value of n. + description: Returns the absolute (positive) value of val. math.acos: args: - type: number must_use: true - description: Returns the arc cosine of n in radians. + description: Returns the arccosine of val in radians. Returns NaN if val is not + in range [-1.0, 1.0]. math.asin: args: - type: number must_use: true - description: Returns the arc sine of n in radians. + description: Returns the arcsine of val in radians. Returns NaN if val is not + in range [-1.0, 1.0]. math.atan: args: - type: number must_use: true - description: Returns the arc tangent of n in radians. + description: Returns the arctangent of val in radians. math.atan2: args: - type: number - type: number must_use: true - description: 'Returns the arc tangent of y/x in radians, using the signs to determine + description: 'Returns the arctangent of y/x in radians, using the signs to determine the quadrant. Note the argument order: Y is the first parameter, X is the second parameter.' math.ceil: args: - type: number must_use: true - description: Returns the smallest integer larger than or equal to n. + description: Returns val rounded toward positive infinity. In other words, returns + the smallest integer greater than or equal to val. math.clamp: args: - type: number - type: number - type: number must_use: true - description: Returns n clamped between min and max. Raises an error if min is + description: Returns val clamped between min and max. Raises an error if min is greater than max. math.cos: args: - type: number must_use: true - description: Returns the cosine of n. n is in radians. + description: Returns the cosine of theta. theta is in radians. math.cosh: args: - type: number @@ -5612,53 +5614,59 @@ globals: args: - type: number must_use: true - description: Converts n from radians to degrees. + description: Returns theta converted from radians to degrees. math.exp: args: - type: number must_use: true - description: Returns the base-e exponent of n. + description: Returns the e to the power of val. math.floor: args: - type: number must_use: true - description: Returns the largest integer smaller than or equal to n. + description: Returns val rounded toward negative infinity. In other words, returns + the largest integer less than or equal to val. math.fmod: args: - type: number - type: number must_use: true - description: Returns the remainder of x modulo y, rounded towards zero. + description: Returns the remainder (modulo) of dividend/modulus, (i.e. d mod m), + rounded towards zero. Returns NaN if modulus is 0. Identical to d % m if both + arguments have the same sign. math.frexp: args: - type: number must_use: true - description: Returns m and e such that n = m * 2^e. + description: Breaks a floating-point number into it's component parts significand + and exponent. In other words, Returns significand s and integer exponent e such + that val = s * 2^e. Inverse of math.ldexp. math.ldexp: args: - type: number - type: number must_use: true - description: Returns s * 2^e. + description: Returns s * 2^e. Inverse of math.frexp math.lerp: args: - type: number - type: number - type: number must_use: true - description: Linearly interpolates between a and b using factor t. + description: Linearly interpolates between start and end using factor t. math.log: args: - type: number - type: number required: false must_use: true - description: Returns the logarithm of n in the given base, defaults to e. + description: Returns the logarithm of val in the given base. The default base + is e. math.log10: args: - type: number must_use: true - description: Returns the base-10 logarithm of n. + description: Returns the base-10 logarithm of val. math.map: args: - type: number @@ -5667,7 +5675,7 @@ globals: - type: number - type: number must_use: true - description: Maps n from input range to output range. + description: Maps val from input range to output range. math.max: args: - type: number @@ -5686,7 +5694,7 @@ globals: args: - type: number must_use: true - description: Returns the integer and fractional parts of n. + description: Returns the integer and fractional parts of val. math.noise: args: - type: number @@ -5707,7 +5715,7 @@ globals: args: - type: number must_use: true - description: Converts n from degrees to radians. + description: Returns theta converted from degrees to radians. math.random: args: - type: number @@ -5726,52 +5734,53 @@ globals: args: - type: number must_use: true - description: Rounds n to the nearest integer. + description: Returns val rounded to the nearest integer. Halfway values are rounded + away from zero. math.sign: args: - type: number must_use: true - description: Returns -1 if n is negative, 1 if positive, and 0 if zero. + description: Returns -1 if val is negative, 1 if positive, and 0 if zero. math.sin: args: - type: number must_use: true - description: Returns the sine of n. n is in radians. + description: Returns the sine of theta. theta is in radians. math.sinh: args: - type: number must_use: true - description: Returns the hyperbolic sine of n. + description: Returns the hyperbolic sine of val. math.sqrt: args: - type: number must_use: true - description: Returns the square root of n. + description: Returns the square root of val. If negative, return Nan. math.tan: args: - type: number must_use: true - description: Returns the tangent of n. n is in radians. + description: Returns the tangent of theta. theta is in radians. math.tanh: args: - type: number must_use: true - description: Returns the hyperbolic tangent of n. + description: Returns the hyperbolic tangent of val. math.isnan: args: - type: number must_use: true - description: Returns true if n is NaN. + description: Returns true if val is NaN. math.isinf: args: - type: number must_use: true - description: Returns true if n is infinite. + description: Returns true if val is infinite. math.isfinite: args: - type: number must_use: true - description: Returns true if n is finite. + description: Returns true if val is finite. os.clock: args: [] must_use: true @@ -5817,7 +5826,7 @@ globals: quaternion.create. quaternion.identity: struct: quaternion - description: Identity quaternion constant. + description: Identity quaternion constant. Causes no change when rotated. quaternion.create: args: - type: number @@ -5831,13 +5840,14 @@ globals: - type: display: quaternion must_use: true - description: Computes the normalized version (unit quaternion) of the quaternion. + description: Returns the normalized unit quaternion pointing the same direction + as q. quaternion.magnitude: args: - type: display: quaternion must_use: true - description: Computes the magnitude of the quaternion. + description: Returns the magnitude (geometric length) of the quaternion. quaternion.dot: args: - type: @@ -5845,7 +5855,7 @@ globals: - type: display: quaternion must_use: true - description: Computes the dot product of two quaternions. + description: Returns the dot product of two quaternions. quaternion.slerp: args: - type: @@ -5854,31 +5864,35 @@ globals: display: quaternion - type: number must_use: true - description: Spherical linear interpolation from a to b using factor t. + description: Spherical linear interpolation from start to end using factor t. quaternion.conjugate: args: - type: display: quaternion must_use: true - description: Computes the conjugate of the quaternion. + description: Returns the conjugate of the quaternion. Equivilant to quaternion(-q.x, + -q.y, -q.z, q.s)) quaternion.tofwd: args: - type: display: quaternion must_use: true - description: Computes the forward vector from the quaternion. + description: Returns the unit vector pointing toward positive X direction (forward) + in the coordinate space of rotation q. Equivilant to vector(1, 0, 0) * q. quaternion.toleft: args: - type: display: quaternion must_use: true - description: Computes the left vector from the quaternion. + description: Returns the unit vector pointing toward positive Y direction (left) + in the coordinate space of rotation q. Equivilant to vector(0, 1, 0) * q. quaternion.toup: args: - type: display: quaternion must_use: true - description: Computes the up vector from the quaternion. + description: Returns the unit vector pointing toward positive Z direction (up) + in the coordinate space of rotation q. Equivilant to vector(0, 0, 1) * q. rotation: args: - type: number @@ -5890,7 +5904,7 @@ globals: quaternion.create. rotation.identity: struct: quaternion - description: Identity quaternion constant. + description: Identity quaternion constant. Causes no change when rotated. rotation.create: args: - type: number @@ -5904,13 +5918,14 @@ globals: - type: display: quaternion must_use: true - description: Computes the normalized version (unit quaternion) of the quaternion. + description: Returns the normalized unit quaternion pointing the same direction + as q. rotation.magnitude: args: - type: display: quaternion must_use: true - description: Computes the magnitude of the quaternion. + description: Returns the magnitude (geometric length) of the quaternion. rotation.dot: args: - type: @@ -5918,7 +5933,7 @@ globals: - type: display: quaternion must_use: true - description: Computes the dot product of two quaternions. + description: Returns the dot product of two quaternions. rotation.slerp: args: - type: @@ -5927,31 +5942,35 @@ globals: display: quaternion - type: number must_use: true - description: Spherical linear interpolation from a to b using factor t. + description: Spherical linear interpolation from start to end using factor t. rotation.conjugate: args: - type: display: quaternion must_use: true - description: Computes the conjugate of the quaternion. + description: Returns the conjugate of the quaternion. Equivilant to quaternion(-q.x, + -q.y, -q.z, q.s)) rotation.tofwd: args: - type: display: quaternion must_use: true - description: Computes the forward vector from the quaternion. + description: Returns the unit vector pointing toward positive X direction (forward) + in the coordinate space of rotation q. Equivilant to vector(1, 0, 0) * q. rotation.toleft: args: - type: display: quaternion must_use: true - description: Computes the left vector from the quaternion. + description: Returns the unit vector pointing toward positive Y direction (left) + in the coordinate space of rotation q. Equivilant to vector(0, 1, 0) * q. rotation.toup: args: - type: display: quaternion must_use: true - description: Computes the up vector from the quaternion. + description: Returns the unit vector pointing toward positive Z direction (up) + in the coordinate space of rotation q. Equivilant to vector(0, 0, 1) * q. string.byte: args: - type: string @@ -6307,10 +6326,10 @@ globals: description: Creates a new vector with the given component values. Alias of vector.create. vector.zero: struct: vector - description: Constant vector with all components set to 0. + description: Vector constant with all components set to 0. vector.one: struct: vector - description: Constant vector with all components set to 1. + description: Vector constant with all components set to 1. vector.create: args: - type: number @@ -6324,13 +6343,14 @@ globals: - type: display: vector must_use: true - description: Computes the magnitude of the vector. + description: Returns the magnitude (geometric length) of the vector. vector.normalize: args: - type: display: vector must_use: true - description: Computes the normalized version (unit vector) of the vector. + description: Returns the normalized unit vector pointing the same direction as + vec. vector.cross: args: - type: @@ -6338,7 +6358,7 @@ globals: - type: display: vector must_use: true - description: Computes the cross product of two vectors. + description: Returns the cross product of two vectors. vector.dot: args: - type: @@ -6346,7 +6366,7 @@ globals: - type: display: vector must_use: true - description: Computes the dot product of two vectors. + description: Returns the dot product of two vectors. vector.angle: args: - type: @@ -6357,8 +6377,9 @@ globals: display: vector required: false must_use: true - description: Computes the angle between two vectors in radians. The axis, if specified, - is used to determine the sign of the angle. + description: Returns the angle from start_vec to end_vec in radians. The axis, + if specified, is used to determine the sign of the angle. If no axis is specified, + the angle is positive, as if axis was vector.cross(start_vec, end_vec). vector.floor: args: - type: @@ -6415,7 +6436,7 @@ globals: display: vector - type: number must_use: true - description: Linearly interpolates between a and b using factor t. + description: Linearly interpolates between start and end using factor t. ll.Abs: deprecated: message: Use 'math.abs' instead. Double precision; fastcall. @@ -6424,8 +6445,7 @@ globals: args: - type: number must_use: true - description: Returns an integer representing the absolute (positive) value of - val. + description: Returns the absolute (positive) integer value of val. ll.Acos: deprecated: message: Use 'math.acos' instead. Double precision; fastcall. @@ -6434,7 +6454,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the arc-cosine of val in radians. + description: Returns the arccosine of val in radians. ll.AddToLandBanList: args: - type: @@ -6484,8 +6504,8 @@ globals: - type: display: quaternion must_use: true - description: Returns a float representing the angle in radians between rotations - a and b. + description: Returns the angle, in radians, between rotations start_rot and and + end_rot. ll.ApplyImpulse: args: - type: @@ -6510,7 +6530,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the arc-sine of val in radians. + description: Returns the arcsine of val in radians. ll.Atan2: deprecated: message: Use 'math.atan2' instead. Double precision; fastcall. @@ -6520,7 +6540,9 @@ globals: - type: number - type: number must_use: true - description: Returns a float representing the arctangent2 of y and x. + description: 'Returns the arctangent of y/x in radians, using the signs to determine + the quadrant. Note the argument order: Y is the first parameter, X is the second + parameter.' ll.AttachToAvatar: args: - type: number @@ -6562,8 +6584,7 @@ globals: display: vector - type: number must_use: true - description: Returns the rotation representing a generated angle (in radians) - about the specified axis. + description: Returns the rotation that rotates angle radians around the axis vector. ll.Base64ToInteger: deprecated: message: Use 'llbase64.decode' and 'string.unpack' or 'buffer.readi32' instead. @@ -6621,8 +6642,8 @@ globals: args: - type: number must_use: true - description: Returns the smallest integer value greater than or equal to val (rounded - toward positive infinity). + description: Returns val rounded toward positive infinity. In other words, returns + the smallest integer greater than or equal to val. ll.Char: args: - type: number @@ -6705,7 +6726,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the cosine of theta. + description: Returns the cosine of theta. theta is in radians. ll.CreateCharacter: args: - type: table @@ -7000,7 +7021,8 @@ globals: - type: display: vector must_use: true - description: Returns the rotation representation of the Euler angles vector v. + description: Returns the quaternion representation of the Euler angles (in radians) + within vec. ll.Evade: args: - type: @@ -7024,7 +7046,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the absolute (positive) value of val. + description: Returns the absolute (positive) value of val. ll.FindNotecardTextCount: args: - type: string @@ -7060,8 +7082,8 @@ globals: args: - type: number must_use: true - description: Returns the largest integer value less than or equal to val (rounded - toward negative infinity). + description: Returns val rounded toward negative infinity. In other words, returns + the largest integer less than or equal to val. ll.ForceMouselook: args: - type: bool @@ -8150,8 +8172,8 @@ globals: - type: display: vector must_use: true - description: Returns a vector representing the conversion of color from the linear - RGB colorspace into the sRGB colorspace. + description: Returns the color vector converted from the linear RGB colorspace + into the sRGB colorspace. ll.LinkAdjustSoundVolume: args: - type: number @@ -8499,8 +8521,8 @@ globals: - type: number - type: table must_use: true - description: Returns a float representing the result of performing the statistical - aggregate function operation (a LIST_STAT_* constant) on the numeric list src. + description: Returns the numeric result of the statistical aggregate function + operation (a LIST_STAT_* constant) on the numeric list src. ll.Listen: args: - type: number @@ -8538,8 +8560,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the natural (base e) logarithm of the - positive value val (returns 0.0 if val <= 0). + description: Returns natural (base e) logarithm of val. If negative, return 0.0. ll.Log10: deprecated: message: Use 'math.log10' instead. Double precision; fastcall. @@ -8548,8 +8569,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the base-10 (common) logarithm of the - positive value val (returns 0.0 if val <= 0). + description: Returns base-10 (common) logarithm of val. If negative, return 0.0. ll.LookAt: args: - type: @@ -8690,8 +8710,10 @@ globals: - type: number - type: number must_use: true - description: Returns an integer representing a raised to the power b, modulo c - (i.e., (a**b)%c). The b value is capped at 0xFFFF (16 bits). + description: Returns base raised to the power exponent, modulo modulus (i.e., + (b^e)%m). All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. + Output is wrapped to signed 32-bit integer range [-2147483648..2147483647]. + Will never overflow, unlike (b^e), which can overflow to inf. ll.ModifyLand: args: - type: number @@ -8844,8 +8866,8 @@ globals: - type: number - type: number must_use: true - description: Returns a float representing base raised to the power exponent. Returns - 0 and triggers a Math Error for imaginary results. + description: Returns base raised to the power exponent. If result is imaginary, + returns NaN. ll.PreloadSound: args: - type: string @@ -9134,20 +9156,20 @@ globals: - type: display: quaternion must_use: true - description: Returns a float representing the rotation angle of rot. + description: Returns the angle, in radians, that q rotates. ll.Rot2Axis: args: - type: display: quaternion must_use: true - description: Returns a vector representing the rotation axis of rot. + description: Returns the unit vector axis that q rotates around. ll.Rot2Euler: args: - type: display: quaternion must_use: true - description: Returns a vector representing the Euler rotation (roll, pitch, yaw) - of quat, with each component expressed in radians. + description: Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles + will be in radians. ll.Rot2Fwd: deprecated: message: Use 'quaternion.tofwd' instead. @@ -9157,8 +9179,8 @@ globals: - type: display: quaternion must_use: true - description: Returns a unit vector pointing in the local positive X direction - (forward) relative to the parent (root prim or region) defined by rotation q. + description: Returns the unit vector pointing toward positive X (forward) in the + coordinate space of rotation q. Equivilant to <1, 0, 0> * q. ll.Rot2Left: deprecated: message: Use 'quaternion.toleft' instead. @@ -9168,8 +9190,8 @@ globals: - type: display: quaternion must_use: true - description: Returns a unit vector pointing in the local positive Y direction - (left) relative to the parent (root prim or region) defined by rotation q. + description: Returns the unit vector pointing toward positive Y (left) in the + coordinate space of rotation q. Equivilant to <0, 1, 0> * q. ll.Rot2Up: deprecated: message: Use 'quaternion.toup' instead. @@ -9179,8 +9201,8 @@ globals: - type: display: quaternion must_use: true - description: Returns a unit vector pointing in the local positive Z direction - (up) relative to the parent (root prim or region) defined by rotation q. + description: Returns the unit vector pointing toward positive Z (up) in the coordinate + space of rotation q. Equivilant to <0, 0, 1> * q. ll.RotBetween: args: - type: @@ -9188,8 +9210,8 @@ globals: - type: display: vector must_use: true - description: Returns a rotation representing the shortest path rotation from vector - start to vector end. + description: Returns the shortest-path quaternion that rotates start_vec onto + end_vec. ll.RotLookAt: args: - type: @@ -9226,7 +9248,8 @@ globals: args: - type: number must_use: true - description: Returns the integer that float val is closest to. + description: Returns val rounded to the nearest integer. Halfway values are rounded + toward infinity. ll.SHA1String: args: - type: string @@ -9789,7 +9812,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the sine of theta. + description: Returns the sine of theta. theta is in radians. ll.SitOnLink: args: - type: @@ -9843,8 +9866,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the square root of the positive value - val. Triggers a math runtime error if val is less than 0.0 (imaginary results). + description: Returns the square root of val. If negative, return Nan. ll.StartAnimation: args: - type: string @@ -9942,7 +9964,7 @@ globals: args: - type: number must_use: true - description: Returns a float representing the tangent of theta. + description: Returns the tangent of theta. theta is in radians. ll.Target: args: - type: @@ -10109,8 +10131,7 @@ globals: - type: display: vector must_use: true - description: Returns a float representing the magnitude (geometric length) of - the vector vec. + description: Returns the magnitude (geometric length) of vec. ll.VecNorm: deprecated: message: Use 'vector.normalize' instead. It's a fastcall. @@ -10120,7 +10141,8 @@ globals: - type: display: vector must_use: true - description: Returns a normalized unit vector sharing the same direction as vec. + description: Returns the normalized unit vector pointing the same direction as + vec. ll.VerifyRSA: args: - type: string @@ -10214,23 +10236,22 @@ globals: - type: display: vector must_use: true - description: Returns a vector representing the conversion of the color srgb from - the sRGB colorspace into the linear RGB colorspace. + description: Returns the color vector converted from the sRGB colorspace into + the linear RGB colorspace. llcompat.Abs: deprecated: - message: Returns an integer representing the absolute (positive) value of val. + message: Returns the absolute (positive) integer value of val. args: - type: number must_use: true - description: Returns an integer representing the absolute (positive) value of - val. + description: Returns the absolute (positive) integer value of val. llcompat.Acos: deprecated: - message: Returns a float representing the arc-cosine of val in radians. + message: Returns the arccosine of val in radians. args: - type: number must_use: true - description: Returns a float representing the arc-cosine of val in radians. + description: Returns the arccosine of val in radians. llcompat.AddToLandBanList: deprecated: message: Adds the avatar to the parcel ban list for the specified number of @@ -10296,16 +10317,16 @@ globals: users with modify permissions. llcompat.AngleBetween: deprecated: - message: Returns a float representing the angle in radians between rotations - a and b. + message: Returns the angle, in radians, between rotations start_rot and and + end_rot. args: - type: display: quaternion - type: display: quaternion must_use: true - description: Returns a float representing the angle in radians between rotations - a and b. + description: Returns the angle, in radians, between rotations start_rot and and + end_rot. llcompat.ApplyImpulse: deprecated: message: Applies a linear impulse (momentum) to a physical object. If local @@ -10332,19 +10353,23 @@ globals: it is applied in global region coordinates. llcompat.Asin: deprecated: - message: Returns a float representing the arc-sine of val in radians. + message: Returns the arcsine of val in radians. args: - type: number must_use: true - description: Returns a float representing the arc-sine of val in radians. + description: Returns the arcsine of val in radians. llcompat.Atan2: deprecated: - message: Returns a float representing the arctangent2 of y and x. + message: 'Returns the arctangent of y/x in radians, using the signs to determine + the quadrant. Note the argument order: Y is the first parameter, X is the + second parameter.' args: - type: number - type: number must_use: true - description: Returns a float representing the arctangent2 of y and x. + description: 'Returns the arctangent of y/x in radians, using the signs to determine + the quadrant. Note the argument order: Y is the first parameter, X is the second + parameter.' llcompat.AttachToAvatar: deprecated: message: Attaches the object to the avatar who has granted the PERMISSION_ATTACH @@ -10401,15 +10426,13 @@ globals: up. llcompat.AxisAngle2Rot: deprecated: - message: Returns the rotation representing a generated angle (in radians) about - the specified axis. + message: Returns the rotation that rotates angle radians around the axis vector. args: - type: display: vector - type: number must_use: true - description: Returns the rotation representing a generated angle (in radians) - about the specified axis. + description: Returns the rotation that rotates angle radians around the axis vector. llcompat.Base64ToInteger: deprecated: message: Returns an integer representing the Base64-decoded big-endian value @@ -10475,13 +10498,13 @@ globals: represents the number of hits. llcompat.Ceil: deprecated: - message: Returns the smallest integer value greater than or equal to val (rounded - toward positive infinity). + message: Returns val rounded toward positive infinity. In other words, returns + the smallest integer greater than or equal to val. args: - type: number must_use: true - description: Returns the smallest integer value greater than or equal to val (rounded - toward positive infinity). + description: Returns val rounded toward positive infinity. In other words, returns + the smallest integer greater than or equal to val. llcompat.Char: deprecated: message: Constructs and returns a single-character string from the given Unicode @@ -10584,11 +10607,11 @@ globals: cryptographic algorithm. llcompat.Cos: deprecated: - message: Returns a float representing the cosine of theta. + message: Returns the cosine of theta. theta is in radians. args: - type: number must_use: true - description: Returns a float representing the cosine of theta. + description: Returns the cosine of theta. theta is in radians. llcompat.CreateCharacter: deprecated: message: Converts the linkset containing the script into a pathfinding character @@ -10986,12 +11009,14 @@ globals: hexadecimal UTF-8 equivalent. llcompat.Euler2Rot: deprecated: - message: Returns the rotation representation of the Euler angles vector v. + message: Returns the quaternion representation of the Euler angles (in radians) + within vec. args: - type: display: vector must_use: true - description: Returns the rotation representation of the Euler angles vector v. + description: Returns the quaternion representation of the Euler angles (in radians) + within vec. llcompat.Evade: deprecated: message: Directs a pathfinding character to evade target, attempting to hide @@ -11016,11 +11041,11 @@ globals: jump. llcompat.Fabs: deprecated: - message: Returns a float representing the absolute (positive) value of val. + message: Returns the absolute (positive) value of val. args: - type: number must_use: true - description: Returns a float representing the absolute (positive) value of val. + description: Returns the absolute (positive) value of val. llcompat.FindNotecardTextCount: deprecated: message: Searches the text of a cached notecard for lines containing the given @@ -11062,13 +11087,13 @@ globals: the target position vector (within the region or adjacent regions). llcompat.Floor: deprecated: - message: Returns the largest integer value less than or equal to val (rounded - toward negative infinity). + message: Returns val rounded toward negative infinity. In other words, returns + the largest integer less than or equal to val. args: - type: number must_use: true - description: Returns the largest integer value less than or equal to val (rounded - toward negative infinity). + description: Returns val rounded toward negative infinity. In other words, returns + the largest integer less than or equal to val. llcompat.ForceMouselook: deprecated: message: Sets whether any avatar sitting on this prim is forced into mouselook @@ -12697,14 +12722,14 @@ globals: out of bounds. llcompat.Linear2sRGB: deprecated: - message: Returns a vector representing the conversion of color from the linear - RGB colorspace into the sRGB colorspace. + message: Returns the color vector converted from the linear RGB colorspace into + the sRGB colorspace. args: - type: display: vector must_use: true - description: Returns a vector representing the conversion of color from the linear - RGB colorspace into the sRGB colorspace. + description: Returns the color vector converted from the linear RGB colorspace + into the sRGB colorspace. llcompat.LinkAdjustSoundVolume: deprecated: message: Adjusts the volume of the currently playing sound attached to the linked @@ -13118,15 +13143,14 @@ globals: is TRUE) or descending order (if FALSE). llcompat.ListStatistics: deprecated: - message: Returns a float representing the result of performing the statistical - aggregate function operation (a LIST_STAT_* constant) on the numeric list - src. + message: Returns the numeric result of the statistical aggregate function operation + (a LIST_STAT_* constant) on the numeric list src. args: - type: number - type: table must_use: true - description: Returns a float representing the result of performing the statistical - aggregate function operation (a LIST_STAT_* constant) on the numeric list src. + description: Returns the numeric result of the statistical aggregate function + operation (a LIST_STAT_* constant) on the numeric list src. llcompat.Listen: deprecated: message: Creates a listener on channel from name and id for msg. Returns an @@ -13171,22 +13195,18 @@ globals: browser. llcompat.Log: deprecated: - message: Returns a float representing the natural (base e) logarithm of the - positive value val (returns 0.0 if val <= 0). + message: Returns natural (base e) logarithm of val. If negative, return 0.0. args: - type: number must_use: true - description: Returns a float representing the natural (base e) logarithm of the - positive value val (returns 0.0 if val <= 0). + description: Returns natural (base e) logarithm of val. If negative, return 0.0. llcompat.Log10: deprecated: - message: Returns a float representing the base-10 (common) logarithm of the - positive value val (returns 0.0 if val <= 0). + message: Returns base-10 (common) logarithm of val. If negative, return 0.0. args: - type: number must_use: true - description: Returns a float representing the base-10 (common) logarithm of the - positive value val (returns 0.0 if val <= 0). + description: Returns base-10 (common) logarithm of val. If negative, return 0.0. llcompat.LookAt: deprecated: message: Causes the object to orient its positive Z-axis (up axis) toward the @@ -13362,15 +13382,19 @@ globals: and defaults vary by event type). llcompat.ModPow: deprecated: - message: Returns an integer representing a raised to the power b, modulo c (i.e., - (a**b)%c). The b value is capped at 0xFFFF (16 bits). + message: Returns base raised to the power exponent, modulo modulus (i.e., (b^e)%m). + All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. Output + is wrapped to signed 32-bit integer range [-2147483648..2147483647]. Will + never overflow, unlike (b^e), which can overflow to inf. args: - type: number - type: number - type: number must_use: true - description: Returns an integer representing a raised to the power b, modulo c - (i.e., (a**b)%c). The b value is capped at 0xFFFF (16 bits). + description: Returns base raised to the power exponent, modulo modulus (i.e., + (b^e)%m). All inputs are wrapped to unsigned 32-bit integer range [0..4294967295]. + Output is wrapped to signed 32-bit integer range [-2147483648..2147483647]. + Will never overflow, unlike (b^e), which can overflow to inf. llcompat.ModifyLand: deprecated: message: Modifies the terrain using the specified land action and brush size @@ -13578,14 +13602,14 @@ globals: loop point of the most audible active Sync Master. llcompat.Pow: deprecated: - message: Returns a float representing base raised to the power exponent. Returns - 0 and triggers a Math Error for imaginary results. + message: Returns base raised to the power exponent. If result is imaginary, + returns NaN. args: - type: number - type: number must_use: true - description: Returns a float representing base raised to the power exponent. Returns - 0 and triggers a Math Error for imaginary results. + description: Returns base raised to the power exponent. If result is imaginary, + returns NaN. llcompat.PreloadSound: deprecated: message: Causes nearby viewers in range to preload the specified sound from @@ -14000,72 +14024,71 @@ globals: failure. llcompat.Rot2Angle: deprecated: - message: Returns a float representing the rotation angle of rot. + message: Returns the angle, in radians, that q rotates. args: - type: display: quaternion must_use: true - description: Returns a float representing the rotation angle of rot. + description: Returns the angle, in radians, that q rotates. llcompat.Rot2Axis: deprecated: - message: Returns a vector representing the rotation axis of rot. + message: Returns the unit vector axis that q rotates around. args: - type: display: quaternion must_use: true - description: Returns a vector representing the rotation axis of rot. + description: Returns the unit vector axis that q rotates around. llcompat.Rot2Euler: deprecated: - message: Returns a vector representing the Euler rotation (roll, pitch, yaw) - of quat, with each component expressed in radians. + message: Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles + will be in radians. args: - type: display: quaternion must_use: true - description: Returns a vector representing the Euler rotation (roll, pitch, yaw) - of quat, with each component expressed in radians. + description: Returns a vector of Euler angles (roll, pitch, yaw) of q. The angles + will be in radians. llcompat.Rot2Fwd: deprecated: - message: Returns a unit vector pointing in the local positive X direction (forward) - relative to the parent (root prim or region) defined by rotation q. + message: Returns the unit vector pointing toward positive X (forward) in the + coordinate space of rotation q. Equivilant to <1, 0, 0> * q. args: - type: display: quaternion must_use: true - description: Returns a unit vector pointing in the local positive X direction - (forward) relative to the parent (root prim or region) defined by rotation q. + description: Returns the unit vector pointing toward positive X (forward) in the + coordinate space of rotation q. Equivilant to <1, 0, 0> * q. llcompat.Rot2Left: deprecated: - message: Returns a unit vector pointing in the local positive Y direction (left) - relative to the parent (root prim or region) defined by rotation q. + message: Returns the unit vector pointing toward positive Y (left) in the coordinate + space of rotation q. Equivilant to <0, 1, 0> * q. args: - type: display: quaternion must_use: true - description: Returns a unit vector pointing in the local positive Y direction - (left) relative to the parent (root prim or region) defined by rotation q. + description: Returns the unit vector pointing toward positive Y (left) in the + coordinate space of rotation q. Equivilant to <0, 1, 0> * q. llcompat.Rot2Up: deprecated: - message: Returns a unit vector pointing in the local positive Z direction (up) - relative to the parent (root prim or region) defined by rotation q. + message: Returns the unit vector pointing toward positive Z (up) in the coordinate + space of rotation q. Equivilant to <0, 0, 1> * q. args: - type: display: quaternion must_use: true - description: Returns a unit vector pointing in the local positive Z direction - (up) relative to the parent (root prim or region) defined by rotation q. + description: Returns the unit vector pointing toward positive Z (up) in the coordinate + space of rotation q. Equivilant to <0, 0, 1> * q. llcompat.RotBetween: deprecated: - message: Returns a rotation representing the shortest path rotation from vector - start to vector end. + message: Returns the shortest-path quaternion that rotates start_vec onto end_vec. args: - type: display: vector - type: display: vector must_use: true - description: Returns a rotation representing the shortest path rotation from vector - start to vector end. + description: Returns the shortest-path quaternion that rotates start_vec onto + end_vec. llcompat.RotLookAt: deprecated: message: Causes the object to smoothly rotate to target_direction with a force @@ -14110,11 +14133,13 @@ globals: If face is ALL_SIDES, rotates the texture on all faces. llcompat.Round: deprecated: - message: Returns the integer that float val is closest to. + message: Returns val rounded to the nearest integer. Halfway values are rounded + toward infinity. args: - type: number must_use: true - description: Returns the integer that float val is closest to. + description: Returns val rounded to the nearest integer. Halfway values are rounded + toward infinity. llcompat.SHA1String: deprecated: message: Returns a string of 40 hex characters representing the SHA-1 security @@ -14935,11 +14960,11 @@ globals: or sha512). Can be paired with llVerifyRSA to pass verifiable messages. llcompat.Sin: deprecated: - message: Returns a float representing the sine of theta. + message: Returns the sine of theta. theta is in radians. args: - type: number must_use: true - description: Returns a float representing the sine of theta. + description: Returns the sine of theta. theta is in radians. llcompat.SitOnLink: deprecated: message: Forces the avatar specified by agent_id (who must be participating @@ -14996,13 +15021,11 @@ globals: on viewers within range. llcompat.Sqrt: deprecated: - message: Returns a float representing the square root of the positive value - val. Triggers a math runtime error if val is less than 0.0 (imaginary results). + message: Returns the square root of val. If negative, return Nan. args: - type: number must_use: true - description: Returns a float representing the square root of the positive value - val. Triggers a math runtime error if val is less than 0.0 (imaginary results). + description: Returns the square root of val. If negative, return Nan. llcompat.StartAnimation: deprecated: message: Starts the animation anim (inventory or built-in) on the avatar who @@ -15126,11 +15149,11 @@ globals: the PERMISSION_TAKE_CONTROLS runtime permission. llcompat.Tan: deprecated: - message: Returns a float representing the tangent of theta. + message: Returns the tangent of theta. theta is in radians. args: - type: number must_use: true - description: Returns a float representing the tangent of theta. + description: Returns the tangent of theta. theta is in radians. llcompat.Target: deprecated: message: Registers a positional target at position with a leeway radius range. @@ -15356,22 +15379,21 @@ globals: between vectors vec_a and vec_b. llcompat.VecMag: deprecated: - message: Returns a float representing the magnitude (geometric length) of the - vector vec. + message: Returns the magnitude (geometric length) of vec. args: - type: display: vector must_use: true - description: Returns a float representing the magnitude (geometric length) of - the vector vec. + description: Returns the magnitude (geometric length) of vec. llcompat.VecNorm: deprecated: - message: Returns a normalized unit vector sharing the same direction as vec. + message: Returns the normalized unit vector pointing the same direction as vec. args: - type: display: vector must_use: true - description: Returns a normalized unit vector sharing the same direction as vec. + description: Returns the normalized unit vector pointing the same direction as + vec. llcompat.VerifyRSA: deprecated: message: Returns TRUE if the Base64-formatted signature is verified as valid @@ -15493,14 +15515,14 @@ globals: nulls are present) a bitwise exclusive OR (XOR) on Base64 strings str1 and str2. llcompat.sRGB2Linear: deprecated: - message: Returns a vector representing the conversion of the color srgb from - the sRGB colorspace into the linear RGB colorspace. + message: Returns the color vector converted from the sRGB colorspace into the + linear RGB colorspace. args: - type: display: vector must_use: true - description: Returns a vector representing the conversion of the color srgb from - the sRGB colorspace into the linear RGB colorspace. + description: Returns the color vector converted from the sRGB colorspace into + the linear RGB colorspace. structs: quaternion: __add: diff --git a/slua_definitions.yaml b/slua_definitions.yaml index ab6a7a4a..b35054b5 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -2223,10 +2223,10 @@ modules: - name: slerp comment: Spherical linear interpolation from start to end using factor t. parameters: - - name: start + - name: start_q comment: Starting quaternion. type: quaternion - - name: end + - name: end_q comment: Ending quaternion. type: quaternion - name: t From 3c9078b28c6288f3a4f045b178da41726136dbe6 Mon Sep 17 00:00:00 2001 From: tapple Date: Wed, 8 Jul 2026 17:27:23 -0700 Subject: [PATCH 9/9] fix conversion functions --- generated/lua_keywords_pretty.xml | 12 ++++++------ generated/secondlife.docs.json | 8 ++++---- generated/secondlife_selene.yml | 8 ++++---- slua_definitions.yaml | 12 ++++++------ 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/generated/lua_keywords_pretty.xml b/generated/lua_keywords_pretty.xml index fe29ac72..cc99bf22 100644 --- a/generated/lua_keywords_pretty.xml +++ b/generated/lua_keywords_pretty.xml @@ -11158,7 +11158,7 @@ float falloff – ranges from 0.01 to 2.0 sleep 0.0 tooltip - Converts the input string to a number in the specified base. Returns nil if the conversion fails. + Converts the input string to a number in the specified base. Returns nil if invalid.
toquaternion @@ -11181,7 +11181,7 @@ float falloff – ranges from 0.01 to 2.0 sleep 0.0 tooltip - Converts a string to a quaternion, returns nil if invalid. + Converts a string to a quaternion. Returns nil if invalid. torotation @@ -11204,7 +11204,7 @@ float falloff – ranges from 0.01 to 2.0 sleep 0.0 tooltip - Converts a string to a rotation (quaternion), returns nil if invalid. + Converts a string to a rotation (quaternion). Returns nil if invalid. tostring @@ -11241,7 +11241,7 @@ float falloff – ranges from 0.01 to 2.0 val tooltip - String to convert to a uuid. + String or buffer to convert to a uuid. type string? | buffer | uuid @@ -11277,7 +11277,7 @@ float falloff – ranges from 0.01 to 2.0 sleep 0.0 tooltip - Converts a string to a vector, returns nil if invalid. + Converts a string to a vector. Returns nil if invalid. type @@ -11668,7 +11668,7 @@ Returns 0 if i < -31, or all sign bits if i > 31. field tooltip - Starting index. + Starting bit index, zero-based type number diff --git a/generated/secondlife.docs.json b/generated/secondlife.docs.json index 9ab16314..3a26bc36 100644 --- a/generated/secondlife.docs.json +++ b/generated/secondlife.docs.json @@ -54,13 +54,13 @@ "documentation": "Changes the metatable for the given table. Raises an error if the table already has a protected metatable (it has a '__metatable' field)." }, "@sl-slua/global/tonumber": { - "documentation": "Converts the input string to a number in the specified base. Returns nil if the conversion fails." + "documentation": "Converts the input string to a number in the specified base. Returns nil if invalid." }, "@sl-slua/global/toquaternion": { - "documentation": "Converts a string to a quaternion, returns nil if invalid." + "documentation": "Converts a string to a quaternion. Returns nil if invalid." }, "@sl-slua/global/torotation": { - "documentation": "Converts a string to a rotation (quaternion), returns nil if invalid." + "documentation": "Converts a string to a rotation (quaternion). Returns nil if invalid." }, "@sl-slua/global/tostring": { "documentation": "Converts the input object to a string. Calls the metatable's '__tostring' metamethod if present." @@ -69,7 +69,7 @@ "documentation": "Creates a new uuid from a string, buffer, or existing uuid. Returns nil if the string is not a valid UUID, or the buffer is shorter than 16 bytes." }, "@sl-slua/global/tovector": { - "documentation": "Converts a string to a vector, returns nil if invalid." + "documentation": "Converts a string to a vector. Returns nil if invalid." }, "@sl-slua/global/type": { "documentation": "Returns the type of the object as a string." diff --git a/generated/secondlife_selene.yml b/generated/secondlife_selene.yml index cf1af668..b72a58b2 100644 --- a/generated/secondlife_selene.yml +++ b/generated/secondlife_selene.yml @@ -5014,17 +5014,17 @@ globals: required: false must_use: true description: Converts the input string to a number in the specified base. Returns - nil if the conversion fails. + nil if invalid. toquaternion: args: - type: string must_use: true - description: Converts a string to a quaternion, returns nil if invalid. + description: Converts a string to a quaternion. Returns nil if invalid. torotation: args: - type: string must_use: true - description: Converts a string to a rotation (quaternion), returns nil if invalid. + description: Converts a string to a rotation (quaternion). Returns nil if invalid. tostring: args: - type: any @@ -5040,7 +5040,7 @@ globals: args: - type: string must_use: true - description: Converts a string to a vector, returns nil if invalid. + description: Converts a string to a vector. Returns nil if invalid. type: args: - type: any diff --git a/slua_definitions.yaml b/slua_definitions.yaml index b35054b5..472ea895 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -631,7 +631,7 @@ functions: fastcall: true typechecker: {builtin: true, magic: true} # builtin due to FFlag::LuauSolverV2 - name: tonumber - comment: Converts the input string to a number in the specified base. Returns nil if the conversion fails. + comment: Converts the input string to a number in the specified base. Returns nil if invalid. parameters: - name: value comment: String to convert to a number. @@ -645,7 +645,7 @@ functions: fastcall: true must-use: true - name: toquaternion - comment: Converts a string to a quaternion, returns nil if invalid. + comment: Converts a string to a quaternion. Returns nil if invalid. parameters: - name: value comment: String to convert to a quaternion. @@ -654,7 +654,7 @@ functions: return-type: quaternion? must-use: true - name: torotation - comment: Converts a string to a rotation (quaternion), returns nil if invalid. + comment: Converts a string to a rotation (quaternion). Returns nil if invalid. parameters: - name: value comment: String to convert to a rotation. @@ -677,13 +677,13 @@ functions: shorter than 16 bytes. parameters: - name: val - comment: String to convert to a uuid. + comment: String or buffer to convert to a uuid. type: string? | buffer | uuid selene-type: string return-type: uuid? must-use: true - name: tovector - comment: Converts a string to a vector, returns nil if invalid. + comment: Converts a string to a vector. Returns nil if invalid. parameters: - name: val comment: String to convert to a vector. @@ -820,7 +820,7 @@ modules: comment: Integer to extract from. type: number - name: field - comment: Starting index. + comment: Starting bit index, zero-based type: number - name: width comment: Number of bits to extract, or 1 if omitted.