/
HingeConstraint.yaml
393 lines (385 loc) · 13.5 KB
/
HingeConstraint.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
name: HingeConstraint
type: class
category: Constraints
memory_category: PhysicsParts
summary: |
Constrains its attachments to rotate about a single axis.
description: |
A **HingeConstraint** allows two `Class.Attachment|Attachments` to rotate
about one axis, constraining the two `Class.Attachment|Attachments` so that
they both occupy the same position and that their **X** axes point in the same
direction.
Note that if this constraint attaches one part (**A**) to another part (**B**)
that is anchored or connected to an anchored part (**Z**), part **A** will not
be locally simulated when interacting with a player.
When configuring this constraint, it may be helpful to study
[Roblox Units](../../../physics/units.md) to understand how Roblox units
compare to metric units.
#### Angular Power
Hinges can be configured to actuate rotation. If a hinge's
`Class.HingeConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Motor`, it attempts to rotate the attachments with the goal
of reaching its `Class.HingeConstraint.AngularVelocity|AngularVelocity`. You
can further control this rotation through both
`Class.HingeConstraint.MotorMaxAcceleration|MotorMaxAcceleration` and
`Class.HingeConstraint.MotorMaxTorque|MotorMaxTorque`. If a hinge's
`Class.HingeConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo`, it attempts to rotate to an angle specified by
`Class.HingeConstraint.TargetAngle|TargetAngle`. This rotation is controlled
by both `Class.HingeConstraint.AngularSpeed|AngularSpeed` and
`Class.HingeConstraint.ServoMaxTorque|ServoMaxTorque`.
#### Limits
You can set limits to restrict the rotation of a hinge, useful for mechanisms
like doors which should only swing open or closed within a set range. Enabling
the `Class.HingeConstraint.LimitsEnabled|LimitsEnabled` property exposes the
`Class.HingeConstraint.LowerAngle|LowerAngle` and
`Class.HingeConstraint.UpperAngle|UpperAngle` limits, as well as
`Class.HingeConstraint.Restitution|Restitution` which defines the elasticity
of the attachments when they reach either limit.
code_samples:
inherits:
- Constraint
tags: []
deprecation_message: ''
properties:
- name: HingeConstraint.ActuatorType
summary: |
Sets whether the rotation of the `Class.HingeConstraint` is actuated and,
if so, what kind of actuation it uses.
description: |
Sets whether the rotation of the `Class.HingeConstraint` is actuated and,
if so, what kind of actuation.
- If `Class.HingeConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Motor`, the hinge will attempt to rotate the
attachments with the goal of reaching
`Class.HingeConstraint.AngularVelocity|AngularVelocity`. This rotation
is limited by both
`Class.HingeConstraint.MotorMaxAcceleration|MotorMaxAcceleration` and
`Class.HingeConstraint.MotorMaxTorque|MotorMaxTorque`.
- If `Class.HingeConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo`, the hinge will attempt to rotate to an angle
specified by `Class.HingeConstraint.TargetAngle|TargetAngle`. This
rotation is limited by both
`Class.HingeConstraint.AngularSpeed|AngularSpeed` and
`Class.HingeConstraint.ServoMaxTorque|ServoMaxTorque`.
Note that both actuated and free spinning rotation can be limited by
setting `Class.HingeConstraint.LimitsEnabled|LimitsEnabled` to true.
code_samples:
type: ActuatorType
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Hinge
serialization:
can_load: true
can_save: true
- name: HingeConstraint.AngularResponsiveness
summary: |
Specifies the sharpness of the servo motor in reaching the
`Class.HingeConstraint.TargetAngle|TargetAngle`.
description: |
This property specifies the sharpness of the servo motor in reaching the
`Class.HingeConstraint.TargetAngle|TargetAngle`, when
`Class.HingeConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo`. Larger values correspond to a faster response
and smaller values results in more damping and a slower response.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Servo
serialization:
can_load: true
can_save: true
- name: HingeConstraint.AngularSpeed
summary: |
The desired angular speed a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Servo` will attempt to maintain while rotating towards
its `Class.HingeConstraint.TargetAngle|TargetAngle`. Measured in
radians/second.
description: |
The desired angular speed a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Servo` will attempt to maintain while rotating towards
its `Class.HingeConstraint.TargetAngle|TargetAngle`. Measured in
radians/second.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Servo
serialization:
can_load: true
can_save: true
- name: HingeConstraint.AngularVelocity
summary: |
The angular velocity a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Motor` will attempt to achieve. Measured in
radians/second.
description: |
The angular velocity a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Motor` will attempt to achieve. Measured in
radians/second.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Motor
serialization:
can_load: true
can_save: true
- name: HingeConstraint.CurrentAngle
summary: |
The current angle of the `Class.HingeConstraint`.
description: |
The current angle of the `Class.HingeConstraint`. This angle is calculated
by measuring the angle separation of the **Y** axes of the
`Class.Attachment|Attachments`.
code_samples:
type: float
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Derived
serialization:
can_load: false
can_save: true
- name: HingeConstraint.LimitsEnabled
summary: |
Sets whether the `Class.HingeConstraint` will limit the range of rotation.
description: |
Sets whether the `Class.HingeConstraint` will limit the range of rotation.
If enabled, the constraint will only allow the
`Class.HingeConstraint.CurrentAngle|CurrentAngle` to be between
`Class.HingeConstraint.LowerAngle|LowerAngle` and
`Class.HingeConstraint.UpperAngle|UpperAngle`. If the `Class.Attachment`
reach the end of the limited range of rotation then they will stop
rotating. If `Class.HingeConstraint.Restitution|Restitution` is greater
than 0 then the attachments will bounce when they hit the ends of the
limited range.
code_samples:
type: bool
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Hinge
serialization:
can_load: true
can_save: true
- name: HingeConstraint.LowerAngle
summary: |
The minimum rotation angle the `Class.HingeConstraint` will allow if
`Class.HingeConstraint.LimitsEnabled|LimitsEnabled` is true.
description: |
The minimum rotation angle the `Class.HingeConstraint` will allow if
`Class.HingeConstraint.LimitsEnabled|LimitsEnabled` is true. Measured in
degrees.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Limits
serialization:
can_load: true
can_save: true
- name: HingeConstraint.MotorMaxAcceleration
summary: |
The maximum angular acceleration a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Motor` can apply to achieve its
`Class.HingeConstraint.AngularVelocity|AngularVelocity`. Measured in
radians/second².
description: |
The maximum angular acceleration a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Motor` can apply to achieve its
`Class.HingeConstraint.AngularVelocity|AngularVelocity`. Measured in
radians/second².
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Motor
serialization:
can_load: true
can_save: true
- name: HingeConstraint.MotorMaxTorque
summary: |
The maximum torque a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Motor` can apply when trying to reach its desired
`Class.HingeConstraint.AngularVelocity|AngularVelocity`.
description: |
The maximum torque a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Motor` can apply when trying to reach its desired
`Class.HingeConstraint.AngularVelocity|AngularVelocity`.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Motor
serialization:
can_load: true
can_save: true
- name: HingeConstraint.Radius
summary: |
The visualized radius of the `Class.HingeConstraint`.
description: |
The visualized radius of the `Class.HingeConstraint`.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Appearance
serialization:
can_load: true
can_save: true
- name: HingeConstraint.Restitution
summary: |
How elastic `Class.Attachment` connected by a `Class.HingeConstraint` will
be when they reach the end of the range when
`Class.HingeConstraint.LimitsEnabled|LimitsEnabled` is true. Constrained
between 0 and 1.
description: |
How elastic `Class.Attachment` connected by a `Class.HingeConstraint` will
be when they reach the end of the range when
`Class.HingeConstraint.LimitsEnabled|LimitsEnabled` is true. Constrained
between 0 and 1.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Limits
serialization:
can_load: true
can_save: true
- name: HingeConstraint.ServoMaxTorque
summary: |
The maximum torque a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Servo` can apply when trying to reach its desired
`Class.HingeConstraint.TargetAngle|TargetAngle`.
description: |
The maximum torque a `Class.HingeConstraint` with
`Class.HingeConstraint.ActuatorType|ActuatorType` set to
`Enum.ActuatorType|Servo` can apply when trying to reach its desired
`Class.HingeConstraint.TargetAngle|TargetAngle`.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Servo
serialization:
can_load: true
can_save: true
- name: HingeConstraint.SoftlockServoUponReachingTarget
summary: ''
description: ''
code_samples: []
type: bool
tags:
- Deprecated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Servo
serialization:
can_load: true
can_save: true
- name: HingeConstraint.TargetAngle
summary: |
The target angle a `Class.HingeConstraint` will attempt to rotate to if
its `Class.HingeConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo`. Measured in degrees.
description: |
The target angle a `Class.HingeConstraint` will attempt to rotate to if
its `Class.HingeConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo`. Measured in degrees.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Servo
serialization:
can_load: true
can_save: true
- name: HingeConstraint.UpperAngle
summary: |
The maximum rotation angle the `Class.HingeConstraint` will allow if
`Class.HingeConstraint.LimitsEnabled|LimitsEnabled` is true.
description: |
The maximum rotation angle the `Class.HingeConstraint` will allow if
`Class.HingeConstraint.LimitsEnabled|LimitsEnabled` is true. Measured in
degrees.
code_samples:
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Limits
serialization:
can_load: true
can_save: true
methods: []
events: []
callbacks: []