/
BodyThrust.yaml
105 lines (105 loc) · 3.07 KB
/
BodyThrust.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
name: BodyThrust
type: class
category: Body Movers
memory_category: Instances
summary: |
Applies a constant force to an object at a specific point.
description: |
The BodyThrust object applies (or exerts) a force relative to the part to
which it is parented at a specific location. It behaves similar to a
`Class.BodyForce`, except that this object's force applies at a specific point
(`Class.BodyThrust.Location`), allowing you to exert a [torque][1] (rotational
force). To apply a force dynamically so that a part maintains a constant
angular velocity, use a `Class.BodyAngularVelocity` instead. To apply a force
dynamically so that a part maintains a constant orientation (angular
position), use a `Class.BodyGyro`.
code_samples:
inherits:
- BodyMover
tags:
- Deprecated
deprecation_message: |
This object is deprecated and should not be used for new work. Use
`Class.VectorForce` instead.
properties:
- name: BodyThrust.Force
summary: |
Determines the amount of force exerted on each axis relative to the part.
description: |
The Force property determines the amount of force exerted on each axis
relative to the part. Unlike `Class.BodyForce.Force`, this property is
relative to the part and not the world. The force is exerted at the
`Class.BodyThrust.Location|Location`, which is also relative to the part.
code_samples:
type: Vector3
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Goals
serialization:
can_load: true
can_save: true
- name: BodyThrust.Location
summary: |
Determines the relative position where the `Class.BodyThrust.Force|Force`
is exerted.
description: |
The Location property determines the relative offset from the center part
at which the `Class.BodyThrust.Force` is exerted. This is the primary
means for turning force into torque.
code_samples:
type: Vector3
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Goals
serialization:
can_load: true
can_save: true
- name: BodyThrust.force
summary: ''
description: ''
code_samples:
type: Vector3
tags:
- NotReplicated
- Deprecated
deprecation_message: |
This property is a deprecated variant of `Class.BodyThrust.Force` which
should be used instead.
security:
read: None
write: None
thread_safety: ReadSafe
category: Goals
serialization:
can_load: true
can_save: false
- name: BodyThrust.location
summary: ''
description: ''
code_samples:
type: Vector3
tags:
- NotReplicated
- Deprecated
deprecation_message: |
This property is a deprecated variant of `Class.BodyThrust.Location` which
should be used instead.
security:
read: None
write: None
thread_safety: ReadSafe
category: Goals
serialization:
can_load: true
can_save: false
methods: []
events: []
callbacks: []