Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update TweenService.yaml #1000

Merged
merged 5 commits into from
Jan 27, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions content/en-us/reference/engine/classes/TweenService.yaml
sammygrey marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -126,38 +126,45 @@ methods:
summary: |
Calculates a value simulating a critically damped spring.
description: |
Returns a value that allows smoothing a value towards a target simulating
Returns a tuple that allows smoothing a value towards a target, simulating
a critically damped spring. Supports `Datatype.Vector2`,
`Datatype.Vector3`, and `Datatype.CFrame`, and number.
`Datatype.Vector3`, `Datatype.CFrame`, and number.
code_samples: []
parameters:
- name: current
type: Variant
default:
summary: ''
summary:
The current position.
- name: target
type: Variant
default:
summary: ''
summary:
The target position.
- name: velocity
type: Variant
default:
summary: ''
summary:
The initial velocity at which the current position should approach the target position.
- name: smoothTime
type: float
default:
summary: ''
summary:
The duration in which the total smoothing operation should take place.
- name: maxSpeed
type: float?
default:
summary: ''
summary:
The maximum speed at which the current position should approach the target position.
- name: dt
type: float?
default:
summary: ''
summary:
The rate at which the smoothing operation should be applied.
returns:
- type: Tuple
summary: ''
summary:
The new position and velocity calculated from the smoothing operation.
tags: []
deprecation_message: ''
security: None
Expand Down
Loading