# Tween

Tween : `TweenBase`

## Overview

트윈 객체는 속성 값을 일정 시간 동안 서서히 변화시키는 애니메이션 연출에 사용할 수 있습니다.

한 번 설정된 트윈의 목표 값(goal)은 수정할 수 없으며, 같은 속성에 대해 여러 개의 트윈을 동시에 적용할 수 없습니다. 만약 동일한 속성을 보간하려는 트윈이 여러 개 존재할 경우, 기존 트윈은 취소되고 마지막 트윈이 우선 적용됩니다.

## Properties

### Instance

`Instance`

트윈 객체에 설정된 Instance를 가져옵니다. (읽기 전용)

#### Code Samples

```lua
print(Tween.Instance)
```

### TweenInfo

`TweenInfo`

트윈 객체에 설정된 TweenInfo를 가져옵니다. (읽기 전용)

#### Code Samples

```lua
local tweenInfo = Tween.TweenInfo
print(tweenInfo.Time)
print(tweenInfo.EasingStyle)
print(tweenInfo.EasingDirection)
print(tweenInfo.RepeatCount)
print(tweenInfo.Reverses)
print(tweenInfo.DelayTime)
```

## Methods

### Cancel

트윈의 재생을 중단하고 내부 상태를 초기화합니다.

트윈이 중단되더라도 트윈에 의해 변경된 속성 값은 초기값으로 복구되지 않습니다.

#### Parameters

#### Return

| `void` |   |
| ------ | - |

#### Code Samples

```lua
Tween:Cancel()
```

### Pause

트윈의 상태가 Playing일 때, 재생중인 트윈을 일시 정지합니다. 이때 트윈의 진행 등 내부 상태는 초기화되지 않으므로, Play() 메서드를 다시 호출하면 정지된 지점부터 이어서 재생됩니다.

#### Parameters

#### Return

| `void` |   |
| ------ | - |

#### Code Samples

```lua
Tween:Pause() -- Pause
wait(2)

Tween:Play()  -- Resume
```

### Play

트윈의 재생을 시작합니다.

이미 재생 중인 경우 Play() 메서드를 호출해도 동작하지 않으며, 재생이 완료되거나 Cancel() 또는 Pause() 메서드를 통해 중지된 경우, 이 메서드를 통해 다시 재생시킬 수 있습니다.

동일한 객체에 각각 다른 속성의 트윈을 여러개 설정한 다음, 동시에 실행하는 것은 가능합니다. 하지만 두 개의 트윈이 동일한 속성을 변경하려고 하면 기존 트윈은 취소되고 최신 트윈만 실행됩니다.

#### Parameters

#### Return

| `void` |   |
| ------ | - |

#### Code Samples

```lua
Tween:Play()
```

## Events

## See also

{% content-ref url="../../../manual/script-manual/advanced-gameplay-systems/tween" %}
[tween](https://docs.overdare.com/korean/manual/script-manual/advanced-gameplay-systems/tween)
{% endcontent-ref %}