mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
82 lines
2.5 KiB
YAML
82 lines
2.5 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: Tween
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
The `Class.Tween` object controls the playback of an interpolation.
|
|
description: |
|
|
The `Class.Tween` object controls the playback of an interpolation. Creating
|
|
and configuring a `Class.Tween` is done with the `Class.TweenService:Create()`
|
|
function; `Datatype.Instance.new()` cannot be used for this particular object.
|
|
|
|
Note that while the configuration of a tween can be accessed after a tween has
|
|
been created, it can not be modified. If new goals are needed for an
|
|
interpolation, a new `Class.Tween` must be created.
|
|
|
|
Also note that multiple tweens can be played on the same object at the same
|
|
time, but they must not be interpolating the same property. If two tweens
|
|
attempt to modify the same property, the initial tween will be cancelled and
|
|
overwritten by the most recent tween.
|
|
code_samples:
|
|
- Tween-Creation
|
|
inherits:
|
|
- TweenBase
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: Tween.Instance
|
|
summary: |
|
|
Read-only property that points to the `Class.Instance` whose properties
|
|
are being interpolated by the tween.
|
|
description: |
|
|
This property of a `Class.Tween` (read-only) points to the
|
|
`Class.Instance` whose properties are being interpolated.
|
|
code_samples:
|
|
- Tween-Instance
|
|
type: Instance
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Basic
|
|
- name: Tween.TweenInfo
|
|
summary: |
|
|
Read-only property that includes information on how the interpolation of
|
|
the `Class.Tween` is to be carried out.
|
|
description: |
|
|
Read-only property that includes information on how the interpolation of
|
|
the `Class.Tween` is to be carried out, using the `Datatype.TweenInfo`
|
|
data type.
|
|
code_samples:
|
|
- TweenInfo
|
|
type: TweenInfo
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Basic
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|