# Tween

A pretty useful tweening library. This is mainly used for UI, but can also be used for things like visuals.

```lua
lib["tween"](fov_circle, {["Transparency"] = transparency}, circular, out, 0) -- non functional example
```

| Argument         | Type            | Description                                    |
| ---------------- | --------------- | ---------------------------------------------- |
| object           | Instance        | What you want to tween                         |
| properties       | Table           | The properties of the instance to tween        |
| easing style     | EasingStyle     | The easing style you want to use on your tween |
| easing direction | EasingDirection | The direction you want to tween, exp: out      |
| duration         | Number          | How long the tween should last                 |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://panduh.gitbook.io/panduh-docs/getting-started/tween.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.