From ea4997478bca1d56e4a958eb39e61701adb7cb2c Mon Sep 17 00:00:00 2001 From: Joseph Brosnihan <57467328+jbrosnihan-roblox@users.noreply.github.com> Date: Tue, 5 Nov 2024 08:14:09 -0800 Subject: [PATCH] Create AnimationConstraint.yaml Adding the base API documentation for AnimationConstraints. I will add more properties in a follow up PR once I get the hang of this. --- .../engine/classes/AnimationConstraint.yaml | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 content/en-us/reference/engine/classes/AnimationConstraint.yaml diff --git a/content/en-us/reference/engine/classes/AnimationConstraint.yaml b/content/en-us/reference/engine/classes/AnimationConstraint.yaml new file mode 100644 index 000000000..c0bae72bb --- /dev/null +++ b/content/en-us/reference/engine/classes/AnimationConstraint.yaml @@ -0,0 +1,40 @@ +name: AnimationConstraint +type: class +category: Constraints +memory_category: PhysicsParts +summary: | + F +description: | + An **AnimationConstraint** constrains its `Class.Attachment|Attachments` so + that they occupy the same CFrame, offset by the `Class.AnimationConstraint.Transform|Transform`. + `Class.Animator|Animators` can update the `Class.AnimationConstraint.Transform|Transform`. + +code_samples: +inherits: + - Constraint +tags: [] +deprecation_message: '' +properties: + - name: AnimationConstraint.IsKinematic + summary: | + Sets whether the `Class.AnimationConstraint` is kinematic or physically simulated. + description: | + When the **IsKinematic** is true, the **AnimationConstraint** will reach its target pose perfectly without participating in physics simulation. When false, it will + code_samples: + type: bool + tags: [] + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Animation + serialization: + can_load: true + can_save: true + capabilities: + - Physics + writeCapabilities: [] +methods: [] +events: [] +callbacks: []