Improve documentation for animation functions

generated/builtins.txt

@@ -92,7 +92,7 @@ list llGetAgentList( integer scope, list options )
 vector llGetAgentSize( key avatar )
 float llGetAlpha( integer face )
 float llGetAndResetTime(  )
-string llGetAnimation( key id )
+string llGetAnimation( key avatar )
 list llGetAnimationList( key avatar )
 string llGetAnimationOverride( string anim_state )
 integer llGetAttached(  )

generated/experimental/category_docs.yaml

@@ -106,9 +106,9 @@ avatar:
   llGetAgentSize( key avatar ) -> vector:
     avatar: UUID of the avatar in the same region.
     tooltip: Returns a vector representing the estimated bounding box size of the specified avatar, or ZERO_VECTOR if they are not in the same region.
-  llGetAnimation( key id ) -> string:
-    id: UUID of the avatar in the same region.
-    tooltip: Returns a string representing the name of the currently playing locomotion animation for the avatar specified by id.
+  llGetAnimation( key avatar ) -> string:
+    avatar: UUID of the avatar in the same region.
+    tooltip: Returns a string representing the name of the currently playing locomotion animation for the specified avatar.
   llGetAnimationList( key avatar ) -> list:
     avatar: UUID of the avatar in the same region.
     tooltip: Returns a list of keys (UUIDs) representing all active animations currently playing on the specified avatar.
@@ -202,10 +202,10 @@ avatar:
     rules: A strided list of rules and data pairs configuring the camera.
     tooltip: Sets multiple camera parameters simultaneously using the list of rules. Requires the PERMISSION_CONTROL_CAMERA runtime permission.
   llStartAnimation( string anim ) -> void:
-    anim: Name of an animation in the prim's inventory, or a built-in animation.
+    anim: Name of the animation in the prim's inventory, or the built-in animation name.
     tooltip: Starts the animation anim (inventory or built-in) on the avatar who granted the script the PERMISSION_TRIGGER_ANIMATION permission (automatically granted for attached or sat-on objects).
   llStopAnimation( string anim ) -> void:
-    anim: Name of an animation in the prim's inventory, a UUID of an animation, or a built-in animation name.
+    anim: Name of the animation in the prim's inventory, the UUID of the animation, or the built-in animation name.
     tooltip: Stops the specified animation anim (inventory, built-in, or UUID) on the avatar who granted the script the PERMISSION_TRIGGER_ANIMATION permission (automatically granted for attached or sat-on
       objects).
   llTakeCamera( key avatar ) -> void // deprecated:
@@ -242,9 +242,9 @@ avatar:
     tooltip: Returns the local position vector that places the center of the HUD object directly over the world coordinate world_pos as viewed by the current camera. Requires the PERMISSION_TRACK_CAMERA
       runtime permission.
 avatar_animation:
-  llGetAnimation( key id ) -> string:
-    id: UUID of the avatar in the same region.
-    tooltip: Returns a string representing the name of the currently playing locomotion animation for the avatar specified by id.
+  llGetAnimation( key avatar ) -> string:
+    avatar: UUID of the avatar in the same region.
+    tooltip: Returns a string representing the name of the currently playing locomotion animation for the specified avatar.
   llGetAnimationList( key avatar ) -> list:
     avatar: UUID of the avatar in the same region.
     tooltip: Returns a list of keys (UUIDs) representing all active animations currently playing on the specified avatar.
@@ -259,10 +259,10 @@ avatar_animation:
     anim: Name of an animation in the prim's inventory, or a built-in animation name.
     tooltip: Overrides the default animation for anim_state with anim (which must be in the object's inventory or a built-in animation). Requires the PERMISSION_OVERRIDE_ANIMATIONS permission.
   llStartAnimation( string anim ) -> void:
-    anim: Name of an animation in the prim's inventory, or a built-in animation.
+    anim: Name of the animation in the prim's inventory, or the built-in animation name.
     tooltip: Starts the animation anim (inventory or built-in) on the avatar who granted the script the PERMISSION_TRIGGER_ANIMATION permission (automatically granted for attached or sat-on objects).
   llStopAnimation( string anim ) -> void:
-    anim: Name of an animation in the prim's inventory, a UUID of an animation, or a built-in animation name.
+    anim: Name of the animation in the prim's inventory, the UUID of the animation, or the built-in animation name.
     tooltip: Stops the specified animation anim (inventory, built-in, or UUID) on the avatar who granted the script the PERMISSION_TRIGGER_ANIMATION permission (automatically granted for attached or sat-on
       objects).
 avatar_communication:
@@ -2027,12 +2027,12 @@ object:
     tooltip: Returns TRUE if the agent or object specified by uuid is in the same region (simulator) and shares the same active group as the prim containing the script; returns FALSE otherwise.
 object_animation:
   llGetObjectAnimationNames(  ) -> list:
-    tooltip: Returns a list of strings representing the names of all active animations currently playing on the object.
+    tooltip: Returns a list of strings representing the names or UUIDs of all active animations currently playing on the object.
   llStartObjectAnimation( string anim ) -> void:
-    anim: Name of an animation in the current object's inventory.
+    anim: Name of the animation in the prim's inventory, or the built-in animation name.
     tooltip: Starts the specified animation anim (inventory or built-in) on the rigged mesh object associated with the current script.
   llStopObjectAnimation( string anim ) -> void:
-    anim: Name of an animation in the current object's inventory, or an animation UUID.
+    anim: Name of the animation in the prim's inventory, the UUID of the animation, or the built-in animation name.
     tooltip: Stops the specified animation anim (inventory, built-in, or UUID) on the rigged mesh object associated with the current script.
 parcel:
   llAddToLandBanList( key avatar, float hours ) -> void:
@@ -2270,9 +2270,9 @@ permissions:
   llForceMouselook( integer mouselook ) -> void:
     mouselook: Boolean. If TRUE, forces a sitting avatar into mouselook; if FALSE, allows them to keep their current camera mode.
     tooltip: Sets whether any avatar sitting on this prim is forced into mouselook mode. Setting mouselook to TRUE forces the mode; FALSE (default) allows the avatar to keep their current camera mode.
-  llGetAnimation( key id ) -> string:
-    id: UUID of the avatar in the same region.
-    tooltip: Returns a string representing the name of the currently playing locomotion animation for the avatar specified by id.
+  llGetAnimation( key avatar ) -> string:
+    avatar: UUID of the avatar in the same region.
+    tooltip: Returns a string representing the name of the currently playing locomotion animation for the specified avatar.
   llGetAnimationList( key avatar ) -> list:
     avatar: UUID of the avatar in the same region.
     tooltip: Returns a list of keys (UUIDs) representing all active animations currently playing on the specified avatar.
@@ -2321,10 +2321,10 @@ permissions:
     rules: A strided list of rules and data pairs configuring the camera.
     tooltip: Sets multiple camera parameters simultaneously using the list of rules. Requires the PERMISSION_CONTROL_CAMERA runtime permission.
   llStartAnimation( string anim ) -> void:
-    anim: Name of an animation in the prim's inventory, or a built-in animation.
+    anim: Name of the animation in the prim's inventory, or the built-in animation name.
     tooltip: Starts the animation anim (inventory or built-in) on the avatar who granted the script the PERMISSION_TRIGGER_ANIMATION permission (automatically granted for attached or sat-on objects).
   llStopAnimation( string anim ) -> void:
-    anim: Name of an animation in the prim's inventory, a UUID of an animation, or a built-in animation name.
+    anim: Name of the animation in the prim's inventory, the UUID of the animation, or the built-in animation name.
     tooltip: Stops the specified animation anim (inventory, built-in, or UUID) on the avatar who granted the script the PERMISSION_TRIGGER_ANIMATION permission (automatically granted for attached or sat-on
       objects).
   llTakeCamera( key avatar ) -> void // deprecated:

generated/experimental/category_functions.yaml

@@ -32,7 +32,7 @@ avatar:
 - llGetAgentLanguage( key avatar ) -> string
 - llGetAgentList( integer scope, list options ) -> list
 - llGetAgentSize( key avatar ) -> vector
-- llGetAnimation( key id ) -> string
+- llGetAnimation( key avatar ) -> string
 - llGetAnimationList( key avatar ) -> list
 - llGetAnimationOverride( string anim_state ) -> string
 - llGetAttachedList( key avatar ) -> list
@@ -69,7 +69,7 @@ avatar:
 - llUnSit( key id ) -> void
 - llWorldPosToHUD( vector world_pos ) -> vector
 avatar_animation:
-- llGetAnimation( key id ) -> string
+- llGetAnimation( key avatar ) -> string
 - llGetAnimationList( key avatar ) -> list
 - llGetAnimationOverride( string anim_state ) -> string
 - llResetAnimationOverride( string anim_state ) -> void
@@ -618,7 +618,7 @@ permissions:
 - run_time_permissions( integer perm )
 - llClearCameraParams(  ) -> void
 - llForceMouselook( integer mouselook ) -> void
-- llGetAnimation( key id ) -> string
+- llGetAnimation( key avatar ) -> string
 - llGetAnimationList( key avatar ) -> list
 - llGetAnimationOverride( string anim_state ) -> string
 - llGetCameraAspect(  ) -> float

generated/lsl_keywords_pretty.xml

@@ -12696,7 +12696,7 @@ If another state is defined before the default state, the compiler will report a
             <key>arguments</key>
             <array>
                <map>
-                  <key>id</key>
+                  <key>avatar</key>
                   <map>
                      <key>tooltip</key>
                      <string>UUID of the avatar in the same region.</string>
@@ -12712,7 +12712,7 @@ If another state is defined before the default state, the compiler will report a
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Returns a string representing the name of the currently playing locomotion animation for the avatar specified by id.</string>
+            <string>Returns a string representing the name of the currently playing locomotion animation for the specified avatar.</string>
          </map>
          <key>llGetAnimationList</key>
          <map>
@@ -14060,7 +14060,7 @@ If another state is defined before the default state, the compiler will report a
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Returns a list of strings representing the names of all active animations currently playing on the object.</string>
+            <string>Returns a list of strings representing the names or UUIDs of all active animations currently playing on the object.</string>
          </map>
          <key>llGetObjectDesc</key>
          <map>
@@ -23453,7 +23453,7 @@ If another state is defined before the default state, the compiler will report a
                   <key>anim</key>
                   <map>
                      <key>tooltip</key>
-                     <string>Name of an animation in the prim's inventory, or a built-in animation.</string>
+                     <string>Name of the animation in the prim's inventory, or the built-in animation name.</string>
                      <key>type</key>
                      <string>string</string>
                   </map>
@@ -23476,7 +23476,7 @@ If another state is defined before the default state, the compiler will report a
                   <key>anim</key>
                   <map>
                      <key>tooltip</key>
-                     <string>Name of an animation in the current object's inventory.</string>
+                     <string>Name of the animation in the prim's inventory, or the built-in animation name.</string>
                      <key>type</key>
                      <string>string</string>
                   </map>
@@ -23499,7 +23499,7 @@ If another state is defined before the default state, the compiler will report a
                   <key>anim</key>
                   <map>
                      <key>tooltip</key>
-                     <string>Name of an animation in the prim's inventory, a UUID of an animation, or a built-in animation name.</string>
+                     <string>Name of the animation in the prim's inventory, the UUID of the animation, or the built-in animation name.</string>
                      <key>type</key>
                      <string>string</string>
                   </map>
@@ -23564,7 +23564,7 @@ If another state is defined before the default state, the compiler will report a
                   <key>anim</key>
                   <map>
                      <key>tooltip</key>
-                     <string>Name of an animation in the current object's inventory, or an animation UUID.</string>
+                     <string>Name of the animation in the prim's inventory, the UUID of the animation, or the built-in animation name.</string>
                      <key>type</key>
                      <string>string</string>
                   </map>

generated/lua_keywords_pretty.xml

@@ -19256,7 +19256,7 @@ Returns true if result is non-zero.</string>
             <key>arguments</key>
             <array>
                <map>
-                  <key>id</key>
+                  <key>avatar</key>
                   <map>
                      <key>tooltip</key>
                      <string>UUID of the avatar in the same region.</string>
@@ -19272,7 +19272,7 @@ Returns true if result is non-zero.</string>
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Returns a string representing the name of the currently playing locomotion animation for the avatar specified by id.</string>
+            <string>Returns a string representing the name of the currently playing locomotion animation for the specified avatar.</string>
          </map>
          <key>ll.GetAnimationList</key>
          <map>
@@ -20618,7 +20618,7 @@ Returns true if result is non-zero.</string>
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Returns a list of strings representing the names of all active animations currently playing on the object.</string>
+            <string>Returns a list of strings representing the names or UUIDs of all active animations currently playing on the object.</string>
          </map>
          <key>ll.GetObjectDesc</key>
          <map>
@@ -30013,7 +30013,7 @@ Returns true if result is non-zero.</string>
                   <key>anim</key>
                   <map>
                      <key>tooltip</key>
-                     <string>Name of an animation in the prim's inventory, or a built-in animation.</string>
+                     <string>Name of the animation in the prim's inventory, or the built-in animation name.</string>
                      <key>type</key>
                      <string>string</string>
                   </map>
@@ -30036,7 +30036,7 @@ Returns true if result is non-zero.</string>
                   <key>anim</key>
                   <map>
                      <key>tooltip</key>
-                     <string>Name of an animation in the current object's inventory.</string>
+                     <string>Name of the animation in the prim's inventory, or the built-in animation name.</string>
                      <key>type</key>
                      <string>string</string>
                   </map>
@@ -30059,7 +30059,7 @@ Returns true if result is non-zero.</string>
                   <key>anim</key>
                   <map>
                      <key>tooltip</key>
-                     <string>Name of an animation in the prim's inventory, a UUID of an animation, or a built-in animation name.</string>
+                     <string>Name of the animation in the prim's inventory, the UUID of the animation, or the built-in animation name.</string>
                      <key>type</key>
                      <string>string | uuid</string>
                   </map>
@@ -30124,7 +30124,7 @@ Returns true if result is non-zero.</string>
                   <key>anim</key>
                   <map>
                      <key>tooltip</key>
-                     <string>Name of an animation in the current object's inventory, or an animation UUID.</string>
+                     <string>Name of the animation in the prim's inventory, the UUID of the animation, or the built-in animation name.</string>
                      <key>type</key>
                      <string>string | uuid</string>
                   </map>

generated/secondlife.d.luau

@@ -668,7 +668,7 @@ declare ll: {
   GetAgentList: (scope: number, options: list) -> {uuid},
   GetAgentSize: (avatar: uuid) -> vector,
   GetAlpha: (face: number) -> number,
-  GetAnimation: (id: uuid) -> string,
+  GetAnimation: (avatar: uuid) -> string,
   GetAnimationList: (avatar: uuid) -> {uuid},
   GetAnimationOverride: (anim_state: string) -> string,
   GetAttached: () -> number,
@@ -1192,7 +1192,7 @@ declare llcompat: {
   GetAgentSize: @deprecated (avatar: uuid) -> vector,
   GetAlpha: @deprecated (face: number) -> number,
   GetAndResetTime: @deprecated () -> number,
-  GetAnimation: @deprecated (id: uuid) -> string,
+  GetAnimation: @deprecated (avatar: uuid) -> string,
   GetAnimationList: @deprecated (avatar: uuid) -> {uuid},
   GetAnimationOverride: @deprecated (anim_state: string) -> string,
   GetAttached: @deprecated () -> number,

generated/secondlife.docs.json

@@ -1255,7 +1255,7 @@
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAlpha"
     },
     "@sl-slua/global/ll.GetAnimation": {
-        "documentation": "Returns a string representing the name of the currently playing locomotion animation for the avatar specified by id.",
+        "documentation": "Returns a string representing the name of the currently playing locomotion animation for the specified avatar.",
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAnimation"
     },
     "@sl-slua/global/ll.GetAnimationList": {
@@ -1515,7 +1515,7 @@
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetNumberOfSides"
     },
     "@sl-slua/global/ll.GetObjectAnimationNames": {
-        "documentation": "Returns a list of strings representing the names of all active animations currently playing on the object.",
+        "documentation": "Returns a list of strings representing the names or UUIDs of all active animations currently playing on the object.",
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetObjectAnimationNames"
     },
     "@sl-slua/global/ll.GetObjectDesc": {
@@ -3322,7 +3322,7 @@
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAndResetTime"
     },
     "@sl-slua/global/llcompat.GetAnimation": {
-        "documentation": "Returns a string representing the name of the currently playing locomotion animation for the avatar specified by id.",
+        "documentation": "Returns a string representing the name of the currently playing locomotion animation for the specified avatar.",
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAnimation"
     },
     "@sl-slua/global/llcompat.GetAnimationList": {
@@ -3582,7 +3582,7 @@
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetNumberOfSides"
     },
     "@sl-slua/global/llcompat.GetObjectAnimationNames": {
-        "documentation": "Returns a list of strings representing the names of all active animations currently playing on the object.",
+        "documentation": "Returns a list of strings representing the names or UUIDs of all active animations currently playing on the object.",
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetObjectAnimationNames"
     },
     "@sl-slua/global/llcompat.GetObjectDesc": {