rules

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

@@ -0,0 +1,67 @@
+# 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: NumberPose
+type: class
+memory_category: Animation
+summary: |
+  Holds the value applied to a specific FACS control.
+description: |
+  A **NumberPose** holds the value applied to a specific FACS control. The
+  control which is affected depends on its name.
+
+  **NumberPose** instances are the building blocks of facial animation and, with
+  `Class.Keyframe|Keyframes`, make up
+  `Class.KeyframeSequence|KeyframeSequences`.
+
+  #### NumberPoses and Facial Animation
+
+  Although a **NumberPose** is assigned to a single FACS control by name, that
+  control can in turn affect multiple bones of the face rig. FACS controls act
+  as an abstraction layer between facial muscle movements and how they are
+  defined in the rig.
+
+  #### NumberPose Hierarchy
+
+  Contrary to `Class.Pose` Instances, **NumberPose** instances cannot be
+  parented together. However, they all must be stored in a `Class.Folder` named
+  **FaceControls** that is a child of the **Head** `Class.Pose`.
+
+  #### NumberPose Value
+
+  The Roblox animation system applies **NumberPose** values to the corresponding
+  FACS controls. Because those controls only respond to values between 0 and 1,
+  the values calculated by the animation system are always clamped to that
+  range.
+code_samples: []
+inherits:
+  - PoseBase
+descendants: []
+tags: []
+deprecation_message: ''
+properties:
+  - name: NumberPose.Value
+    summary: |
+      The value that will be applied to the FACS control corresponding to the
+      `Class.NumberPose`.
+    description: |
+      The value that will be applied to the FACS control corresponding with the
+      `Class.NumberPose`.
+    code_samples: []
+    type: double
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Animation
+methods: []
+events: []
+callbacks: []