Skip to content

Commit ea49974

Browse files
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.
1 parent dd4ffec commit ea49974

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: AnimationConstraint
2+
type: class
3+
category: Constraints
4+
memory_category: PhysicsParts
5+
summary: |
6+
F
7+
description: |
8+
An **AnimationConstraint** constrains its `Class.Attachment|Attachments` so
9+
that they occupy the same CFrame, offset by the `Class.AnimationConstraint.Transform|Transform`.
10+
`Class.Animator|Animators` can update the `Class.AnimationConstraint.Transform|Transform`.
11+
12+
code_samples:
13+
inherits:
14+
- Constraint
15+
tags: []
16+
deprecation_message: ''
17+
properties:
18+
- name: AnimationConstraint.IsKinematic
19+
summary: |
20+
Sets whether the `Class.AnimationConstraint` is kinematic or physically simulated.
21+
description: |
22+
When the **IsKinematic** is true, the **AnimationConstraint** will reach its target pose perfectly without participating in physics simulation. When false, it will
23+
code_samples:
24+
type: bool
25+
tags: []
26+
deprecation_message: ''
27+
security:
28+
read: None
29+
write: None
30+
thread_safety: ReadSafe
31+
category: Animation
32+
serialization:
33+
can_load: true
34+
can_save: true
35+
capabilities:
36+
- Physics
37+
writeCapabilities: []
38+
methods: []
39+
events: []
40+
callbacks: []

0 commit comments

Comments
 (0)