Skip to content

Commit 5bc80d1

Browse files
authored
Update TweenService.yaml
Added additional info for TweenService:SmoothDamp. Includes summaries for all variables and the return value, default values for maxSpeed and dt, and changing the term "value" to "tuple."
1 parent cd9d201 commit 5bc80d1

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

content/en-us/reference/engine/classes/TweenService.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -126,38 +126,38 @@ methods:
126126
summary: |
127127
Calculates a value simulating a critically damped spring.
128128
description: |
129-
Returns a value that allows smoothing a value towards a target simulating
129+
Returns a tuple that allows smoothing a value towards a target simulating
130130
a critically damped spring. Supports `Datatype.Vector2`,
131131
`Datatype.Vector3`, and `Datatype.CFrame`, and number.
132132
code_samples: []
133133
parameters:
134134
- name: current
135135
type: Variant
136136
default:
137-
summary: ''
137+
summary: 'The current position.'
138138
- name: target
139139
type: Variant
140140
default:
141-
summary: ''
141+
summary: 'The target position.'
142142
- name: velocity
143143
type: Variant
144144
default:
145-
summary: ''
145+
summary: 'The initial velocity at which the current position should approach the target position.'
146146
- name: smoothTime
147147
type: float
148148
default:
149-
summary: ''
149+
summary: 'The duration in which the total smoothing operation should take place.'
150150
- name: maxSpeed
151151
type: float?
152-
default:
153-
summary: ''
152+
default: '`Library.math.huge`'
153+
summary: 'The maximum speed at which the current position should approach the target position.'
154154
- name: dt
155155
type: float?
156-
default:
157-
summary: ''
156+
default: 'The current framerate'
157+
summary: 'The rate at which the smoothing operation should be applied.'
158158
returns:
159159
- type: Tuple
160-
summary: ''
160+
summary: 'The new position and velocity calculated from the smoothing operation.'
161161
tags: []
162162
deprecation_message: ''
163163
security: None

0 commit comments

Comments
 (0)