Merge pull request #153 from tapple/wiki-text-attachments

Improve documentation for attachment functions

Author: monty-linden

generated/builtins.txt

@@ -1555,7 +1555,7 @@ const rotation ZERO_ROTATION = <0.0, 0.0, 0.0, 1.0>
 const vector ZERO_VECTOR = <0.0, 0.0, 0.0>
 event at_rot_target( integer handle, rotation targetrot, rotation ourrot )
 event at_target( integer tnum, vector targetpos, vector ourpos )
-event attach( key id )
+event attach( key avatar )
 event changed( integer changes )
 event collision( integer num_detected )
 event collision_end( integer num_detected )

generated/experimental/category_docs.yaml

@@ -25,9 +25,9 @@ asset_permissions:
     options: Extra options applied to the transfer (currently unused).
     tooltip: Transfers ownership of the object (or a copy of it, depending on Flags) to the specified agent. Returns an integer indicating the success or failure of the transfer.
 attachments:
-  attach( key id ):
-    id: UUID of the avatar the object is attached to, or NULL_KEY if detached.
-    tooltip: Triggered whenever the object is attached to or detached from an avatar. Passes the UUID key of the avatar (id) if attached, or NULL_KEY if detached.
+  attach( key avatar ):
+    avatar: UUID of the avatar the object is attached to, or NULL_KEY if detached.
+    tooltip: Triggered whenever the object is attached to or detached from an avatar. Passes the UUID key of the avatar if attached, or NULL_KEY if detached.
   llAttachToAvatar( integer attach_point ) -> void:
     attach_point: ATTACH_* constant or integer value representing the target attachment point.
     tooltip: Attaches the object to the avatar who has granted the PERMISSION_ATTACH permission. Takes the object into the user's inventory and attaches it at attach_point.
@@ -42,12 +42,12 @@ attachments:
     tooltip: Returns the integer attachment point (an ATTACH_* constant) that the object is attached to, or 0 if it is unattached or pending detachment.
   llGetAttachedList( key avatar ) -> list:
     avatar: UUID of the avatar in the same region.
-    tooltip: Returns a list of object keys (UUIDs) corresponding to public, visible (non-HUD) attachments worn by the specified avatar, in the order they were attached. Returns a list with an error message
-      string on failure.
+    tooltip: Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached. HUDs are not included because they are neither public nor visible. Returns a list containing
+      an error message string on failure.
   llGetAttachedListFiltered( key avatar, list options ) -> list:
     avatar: UUID of the avatar in the same region.
     options: A list of options to filter the returned attachments.
-    tooltip: Retrieves a list of attachment object keys worn by avatar in the order they were attached, filtered by options. Returns a list containing an error message string on failure.
+    tooltip: Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached, filtered by options. Returns a list containing an error message string on failure.
 avatar:
   control( key id, integer level, integer edge ):
     id: UUID of the avatar whose inputs are captured.
@@ -117,12 +117,12 @@ avatar:
     tooltip: Returns a string representing the name of the animation currently overriding the specified anim_state. Requires the PERMISSION_OVERRIDE_ANIMATIONS or PERMISSION_TRIGGER_ANIMATION runtime permission.
   llGetAttachedList( key avatar ) -> list:
     avatar: UUID of the avatar in the same region.
-    tooltip: Returns a list of object keys (UUIDs) corresponding to public, visible (non-HUD) attachments worn by the specified avatar, in the order they were attached. Returns a list with an error message
-      string on failure.
+    tooltip: Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached. HUDs are not included because they are neither public nor visible. Returns a list containing
+      an error message string on failure.
   llGetAttachedListFiltered( key avatar, list options ) -> list:
     avatar: UUID of the avatar in the same region.
     options: A list of options to filter the returned attachments.
-    tooltip: Retrieves a list of attachment object keys worn by avatar in the order they were attached, filtered by options. Returns a list containing an error message string on failure.
+    tooltip: Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached, filtered by options. Returns a list containing an error message string on failure.
   llGetCameraAspect(  ) -> float:
     tooltip: Returns a float representing the camera's current aspect ratio (width/height) of the agent who granted PERMISSION_TRACK_CAMERA. Returns 0.0 if permissions are not granted.
   llGetCameraFOV(  ) -> float:

generated/experimental/category_functions.yaml

@@ -7,7 +7,7 @@ asset_permissions:
 - llSetObjectPermMask( integer group, integer flags ) -> void
 - llTransferOwnership( key agent, integer flags, list options ) -> integer
 attachments:
-- attach( key id )
+- attach( key avatar )
 - llAttachToAvatar( integer attach_point ) -> void
 - llAttachToAvatarTemp( integer attach_point ) -> void
 - llDetachFromAvatar(  ) -> void

generated/lsl_keywords_pretty.xml

@@ -9374,7 +9374,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 the object is attached to, or NULL_KEY if detached.</string>
@@ -9384,7 +9384,7 @@ If another state is defined before the default state, the compiler will report a
                </map>
             </array>
             <key>tooltip</key>
-            <string>Triggered whenever the object is attached to or detached from an avatar. Passes the UUID key of the avatar (id) if attached, or NULL_KEY if detached.</string>
+            <string>Triggered whenever the object is attached to or detached from an avatar. Passes the UUID key of the avatar if attached, or NULL_KEY if detached.</string>
          </map>
          <key>changed</key>
          <map>
@@ -12795,7 +12795,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 object keys (UUIDs) corresponding to public, visible (non-HUD) attachments worn by the specified avatar, in the order they were attached. Returns a list with an error message string on failure.</string>
+            <string>Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached. HUDs are not included because they are neither public nor visible. Returns a list containing an error message string on failure.</string>
          </map>
          <key>llGetAttachedListFiltered</key>
          <map>
@@ -12827,7 +12827,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>Retrieves a list of attachment object keys worn by avatar in the order they were attached, filtered by options. Returns a list containing an error message string on failure.</string>
+            <string>Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached, filtered by options. Returns a list containing an error message string on failure.</string>
          </map>
          <key>llGetBoundingBox</key>
          <map>

generated/lua_keywords_pretty.xml

@@ -9679,7 +9679,7 @@ float falloff – ranges from 0.01 to 2.0
             <key>arguments</key>
             <array>
                <map>
-                  <key>id</key>
+                  <key>avatar</key>
                   <map>
                      <key>tooltip</key>
                      <string>UUID of the avatar the object is attached to, or NULL_KEY if detached.</string>
@@ -9689,7 +9689,7 @@ float falloff – ranges from 0.01 to 2.0
                </map>
             </array>
             <key>tooltip</key>
-            <string>Triggered whenever the object is attached to or detached from an avatar. Passes the UUID key of the avatar (id) if attached, or NULL_KEY if detached.</string>
+            <string>Triggered whenever the object is attached to or detached from an avatar. Passes the UUID key of the avatar if attached, or NULL_KEY if detached.</string>
          </map>
          <key>changed</key>
          <map>
@@ -19492,7 +19492,7 @@ Returns true if result is non-zero.</string>
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Returns a list of object keys (UUIDs) corresponding to public, visible (non-HUD) attachments worn by the specified avatar, in the order they were attached. Returns a list with an error message string on failure.</string>
+            <string>Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached. HUDs are not included because they are neither public nor visible. Returns a list containing an error message string on failure.</string>
          </map>
          <key>ll.GetAttachedListFiltered</key>
          <map>
@@ -19524,7 +19524,7 @@ Returns true if result is non-zero.</string>
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Retrieves a list of attachment object keys worn by avatar in the order they were attached, filtered by options. Returns a list containing an error message string on failure.</string>
+            <string>Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached, filtered by options. Returns a list containing an error message string on failure.</string>
          </map>
          <key>ll.GetBoundingBox</key>
          <map>

generated/secondlife.d.luau

@@ -182,7 +182,7 @@ end
 declare extern type LLEvents with
   at_rot_target: ((handle: number, targetrot: quaternion, ourrot: quaternion) -> ())?
   at_target: ((tnum: number, targetpos: vector, ourpos: vector) -> ())?
-  attach: ((id: uuid) -> ())?
+  attach: ((avatar: uuid) -> ())?
   changed: ((changes: number) -> ())?
   collision: LLDetectedEventHandler?
   collision_end: LLDetectedEventHandler?

generated/secondlife.docs.json

@@ -1283,11 +1283,11 @@
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAttached"
     },
     "@sl-slua/global/ll.GetAttachedList": {
-        "documentation": "Returns a list of object keys (UUIDs) corresponding to public, visible (non-HUD) attachments worn by the specified avatar, in the order they were attached. Returns a list with an error message string on failure.",
+        "documentation": "Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached. HUDs are not included because they are neither public nor visible. Returns a list containing an error message string on failure.",
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAttachedList"
     },
     "@sl-slua/global/ll.GetAttachedListFiltered": {
-        "documentation": "Retrieves a list of attachment object keys worn by avatar in the order they were attached, filtered by options. Returns a list containing an error message string on failure.",
+        "documentation": "Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached, filtered by options. Returns a list containing an error message string on failure.",
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAttachedListFiltered"
     },
     "@sl-slua/global/ll.GetBoundingBox": {
@@ -3350,11 +3350,11 @@
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAttached"
     },
     "@sl-slua/global/llcompat.GetAttachedList": {
-        "documentation": "Returns a list of object keys (UUIDs) corresponding to public, visible (non-HUD) attachments worn by the specified avatar, in the order they were attached. Returns a list with an error message string on failure.",
+        "documentation": "Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached. HUDs are not included because they are neither public nor visible. Returns a list containing an error message string on failure.",
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAttachedList"
     },
     "@sl-slua/global/llcompat.GetAttachedListFiltered": {
-        "documentation": "Retrieves a list of attachment object keys worn by avatar in the order they were attached, filtered by options. Returns a list containing an error message string on failure.",
+        "documentation": "Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were attached, filtered by options. Returns a list containing an error message string on failure.",
         "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetAttachedListFiltered"
     },
     "@sl-slua/global/llcompat.GetBoundingBox": {

generated/secondlife_selene.yml

@@ -7153,18 +7153,18 @@ globals:
     - type:
         display: uuid
     must_use: true
-    description: Returns a list of object keys (UUIDs) corresponding to public, visible
-      (non-HUD) attachments worn by the specified avatar, in the order they were attached.
-      Returns a list with an error message string on failure.
+    description: Returns a list of object keys (UUIDs) worn by the specified avatar,
+      in the order they were attached. HUDs are not included because they are neither
+      public nor visible. Returns a list containing an error message string on failure.
   ll.GetAttachedListFiltered:
     args:
     - type:
         display: uuid
     - type: table
     must_use: true
-    description: Retrieves a list of attachment object keys worn by avatar in the
-      order they were attached, filtered by options. Returns a list containing an
-      error message string on failure.
+    description: Returns a list of object keys (UUIDs) worn by the specified avatar,
+      in the order they were attached, filtered by options. Returns a list containing
+      an error message string on failure.
   ll.GetBoundingBox:
     args:
     - type:
@@ -11209,29 +11209,29 @@ globals:
       the object is attached to, or 0 if it is unattached or pending detachment.
   llcompat.GetAttachedList:
     deprecated:
-      message: Returns a list of object keys (UUIDs) corresponding to public, visible
-        (non-HUD) attachments worn by the specified avatar, in the order they were
-        attached. Returns a list with an error message string on failure.
+      message: Returns a list of object keys (UUIDs) worn by the specified avatar,
+        in the order they were attached. HUDs are not included because they are neither
+        public nor visible. Returns a list containing an error message string on failure.
     args:
     - type:
         display: uuid
     must_use: true
-    description: Returns a list of object keys (UUIDs) corresponding to public, visible
-      (non-HUD) attachments worn by the specified avatar, in the order they were attached.
-      Returns a list with an error message string on failure.
+    description: Returns a list of object keys (UUIDs) worn by the specified avatar,
+      in the order they were attached. HUDs are not included because they are neither
+      public nor visible. Returns a list containing an error message string on failure.
   llcompat.GetAttachedListFiltered:
     deprecated:
-      message: Retrieves a list of attachment object keys worn by avatar in the order
-        they were attached, filtered by options. Returns a list containing an error
-        message string on failure.
+      message: Returns a list of object keys (UUIDs) worn by the specified avatar,
+        in the order they were attached, filtered by options. Returns a list containing
+        an error message string on failure.
     args:
     - type:
         display: uuid
     - type: table
     must_use: true
-    description: Retrieves a list of attachment object keys worn by avatar in the
-      order they were attached, filtered by options. Returns a list containing an
-      error message string on failure.
+    description: Returns a list of object keys (UUIDs) worn by the specified avatar,
+      in the order they were attached, filtered by options. Returns a list containing
+      an error message string on failure.
   llcompat.GetBoundingBox:
     deprecated:
       message: Returns the bounding box of object (including any linked prims) relative
@@ -15980,8 +15980,7 @@ structs:
       property: override-fields
       type: function
       description: Triggered whenever the object is attached to or detached from an
-        avatar. Passes the UUID key of the avatar (id) if attached, or NULL_KEY if
-        detached.
+        avatar. Passes the UUID key of the avatar if attached, or NULL_KEY if detached.
     changed:
       property: override-fields
       type: function

lsl_definitions.yaml

@@ -6804,12 +6804,12 @@ events:
       - movement
   attach:
     arguments:
-    - id:
+    - avatar:
         tooltip: UUID of the avatar the object is attached to, or NULL_KEY if
           detached.
         type: key
     tooltip: Triggered whenever the object is attached to or detached from an
-      avatar. Passes the UUID key of the avatar (id) if attached, or NULL_KEY if
+      avatar. Passes the UUID key of the avatar if attached, or NULL_KEY if
       detached.
     categories:
       - attachments
@@ -9140,9 +9140,9 @@ functions:
     return: list
     slua-return: '{uuid} | {string}'
     sleep: 0.0
-    tooltip: Returns a list of object keys (UUIDs) corresponding to public, visible
-      (non-HUD) attachments worn by the specified avatar, in the order they were
-      attached. Returns a list with an error message string on failure.
+    tooltip: Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were
+      attached. HUDs are not included because they are neither public nor visible.
+      Returns a list containing an error message string on failure.
     categories:
       - attachments
       - avatar
@@ -9161,9 +9161,8 @@ functions:
     return: list
     slua-return: '{uuid} | {string}'
     sleep: 0.0
-    tooltip: Retrieves a list of attachment object keys worn by avatar in the order
-      they were attached, filtered by options. Returns a list containing an
-      error message string on failure.
+    tooltip: Returns a list of object keys (UUIDs) worn by the specified avatar, in the order they were
+      attached, filtered by options. Returns a list containing an error message string on failure.
     categories:
       - attachments
       - avatar