/
GroundController.yaml
227 lines (227 loc) · 6.62 KB
/
GroundController.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
name: GroundController
type: class
category:
memory_category: Instances
summary: ''
description: ''
code_samples: []
inherits:
- ControllerBase
tags: []
deprecation_message: ''
properties:
- name: GroundController.AccelerationLean
summary: ''
description: ''
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Balance
serialization:
can_load: true
can_save: true
- name: GroundController.AccelerationTime
summary: |
Estimated time taken to reach the desired speed.
description: |
Estimated time (in seconds) taken to reach the desired speed after walking
input begins. The character will accelerate linearly at the computed rate,
impacted by friction, so a given time may be less accurate with lower
friction.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Movement
serialization:
can_load: true
can_save: true
- name: GroundController.BalanceMaxTorque
summary: |
The maximum torque used to keep the `Class.ControllerManager.RootPart`
aligned upright.
description: |
The maximum torque used to keep the `Class.ControllerManager.RootPart`
aligned upright. When misaligned, this amount of torque is applied to
reach the `Class.GroundController.BalanceSpeed|BalanceSpeed` and realign
the root part. A higher torque means more force is required to cause the
root part to tilt. A lower torque means it's easer for the root part to
get knocked over when running into things. This property is hidden and has
no effect when `Class.ControllerBase.BalanceRigidityEnabled` is true.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Balance
serialization:
can_load: true
can_save: true
- name: GroundController.BalanceSpeed
summary: |
The maximum angular speed used to align the
`Class.ControllerManager.RootPart` upright.
description: |
The maximum angular speed used to align the
`Class.ControllerManager.RootPart` upright. A lower value means it takes
longer for the root part to recover to the upright position when
misaligned. A higher value results in a quicker recovery.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Balance
serialization:
can_load: true
can_save: true
- name: GroundController.DecelerationTime
summary: |
Estimated time taken to reach a complete stop from full speed.
description: |
Estimated time (in seconds) taken to reach a complete stop from full speed
after walking input ends. The character will decelerate linearly at the
computed rate, impacted by friction, so a given time may be less accurate
with lower friction.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Movement
serialization:
can_load: true
can_save: true
- name: GroundController.Friction
summary: |
The coefficient of friction of the character on the ground.
description: |
The coefficient of friction for the character at the point between it and
the ground. Determines how much force is available for locomotion or to
keep the character stationary on slopes.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Movement
serialization:
can_load: true
can_save: true
- name: GroundController.FrictionWeight
summary: |
Amount the character's friction is weighed against the ground friction.
description: |
Amount the character's friction is weighed against the ground friction,
equal in behavior to the
`Datatype.PhysicalProperties.FrictionWeight|FrictionWeight` data type of
`Class.BasePart.CustomPhysicalProperties`. Higher values mean more of a
part's `Datatype.PhysicalProperties.Friction|Friction` will be used.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Movement
serialization:
can_load: true
can_save: true
- name: GroundController.GroundOffset
summary: |
The target distance above the ground to keep the
`Class.ControllerManager.RootPart` at.
description: |
The target distance above the
`Class.ControllerManager.GroundSensor.HitPosition` to keep the
`Class.ControllerManager.RootPart` at. If the root part is below this
offset from the ground, a force is applied to raise up to this height. If
it's above, nothing happens.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Movement
serialization:
can_load: true
can_save: true
- name: GroundController.StandForce
summary: ''
description: ''
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Movement
serialization:
can_load: true
can_save: true
- name: GroundController.StandSpeed
summary: ''
description: ''
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Movement
serialization:
can_load: true
can_save: true
- name: GroundController.TurnSpeedFactor
summary: |
The value multiplied by the `Class.ControllerManager.BaseTurnSpeed`.
description: |
The value multiplied by the `Class.ControllerManager.BaseTurnSpeed` to
determine the final target angular velocity while this controller is
active. The angular velocity is applied when turning towards the
`Class.ControllerManager.FacingDirection.`
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Movement
serialization:
can_load: true
can_save: true
methods: []
events: []
callbacks: []