rules

.cursor/rules/roblox/reference/engine/classes/BodyPartDescription.yaml

@@ -0,0 +1,126 @@
+# This file is automatically generated. Please don't edit it manually.
+# To submit a bug report on the content, see
+# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
+
+name: BodyPartDescription
+type: class
+memory_category: Instances
+summary: |
+  Describes the appearance of an avatar body part for the
+  `Class.HumanoidDescription`.
+description: |
+  **BodyPartDescription** is an object that stores the description for an
+  avatar's body parts, such as the `Class.BodyPartDescription.Color|Color`. It
+  is meant to be placed underneath a `Class.HumanoidDescription` in order to
+  work with `Class.Humanoid:ApplyDescriptionAsync()`.
+code_samples: []
+inherits:
+  - Instance
+descendants: []
+tags: []
+deprecation_message: ''
+properties:
+  - name: BodyPartDescription.AssetId
+    summary: |
+      The asset ID that should be applied when applying this
+      `Class.BodyPartDescription`.
+    description: |
+      The asset ID that should be applied when applying this
+      `Class.BodyPartDescription`.
+    code_samples: []
+    type: int64
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Avatar
+  - name: BodyPartDescription.BodyPart
+    summary: |
+      The type of body part.
+    description: |
+      The type of body part.
+    code_samples: []
+    type: BodyPart
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Avatar
+  - name: BodyPartDescription.Color
+    summary: |
+      The `Datatype.Color3` for this body part.
+    description: |
+      The `Datatype.Color3` for this body part.
+    code_samples: []
+    type: Color3
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Avatar
+  - name: BodyPartDescription.HeadShape
+    summary: ''
+    description: ''
+    code_samples: []
+    type: string
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Avatar
+  - name: BodyPartDescription.Instance
+    summary: |
+      A reference to the `Class.Instance` that should be applied when applying
+      this `Class.BodyPartDescription`.
+    description: |
+      A reference to the `Class.Instance` that should be applied when applying
+      this `Class.BodyPartDescription`. This property can be used instead of
+      `Class.BodyPartDescription.AssetId|AssetId` to apply accessories without
+      uploading them to the platform. This can reference either a body part with
+      R15, **R15ArtistIntent** and **R6** folders, or only reference a single
+      subfolder.
+    code_samples: []
+    type: Instance
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Avatar
+methods: []
+events: []
+callbacks: []