> For the complete documentation index, see [llms.txt](https://laot7490.gitbook.io/ltbridge/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://laot7490.gitbook.io/ltbridge/utilities/streaming.md).

# Streaming

## Streaming

Request and load GTA assets (models, animations, textures) before using them.

### Functions

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>RequestAnimDict</strong></td><td>Request and await an animation dictionary load.</td><td><a href="#requestanimdict">#requestanimdict</a></td></tr><tr><td><strong>RequestAnimSet</strong></td><td>Request and await an animation set load.</td><td><a href="#requestanimset">#requestanimset</a></td></tr><tr><td><strong>RequestClipSet</strong></td><td>Request and await a clip set load.</td><td><a href="#requestclipset">#requestclipset</a></td></tr><tr><td><strong>RequestModel</strong></td><td>Request and await a model load.</td><td><a href="#requestmodel">#requestmodel</a></td></tr><tr><td><strong>RequestPtfxAsset</strong></td><td>Request and await a named PTFX asset load.</td><td><a href="#requestptfxasset">#requestptfxasset</a></td></tr><tr><td><strong>RequestTexture</strong></td><td>Request and await a texture dictionary load.</td><td><a href="#requesttexture">#requesttexture</a></td></tr><tr><td><strong>RequestWeaponAsset</strong></td><td>Request and await a weapon asset load.</td><td><a href="#requestweaponasset">#requestweaponasset</a></td></tr></tbody></table>

***

## RequestAnimDict

Request and await an animation dictionary load.

{% hint style="info" %}
**Side:** Client · **Category:** Streaming · **API:** `LT.Streaming.RequestAnimDict`
{% endhint %}

### Example

```lua
local result = LT.Streaming.RequestAnimDict('dict', 1)
```

### Parameters

| Name      | Required | Description                   |
| --------- | -------- | ----------------------------- |
| `dict`    | Yes      | Animation dictionary name     |
| `timeout` | No       | Timeout in ms (default: 5000) |

### Returns

* `boolean`

***

## RequestAnimSet

Request and await an animation set load.

{% hint style="info" %}
**Side:** Client · **Category:** Streaming · **API:** `LT.Streaming.RequestAnimSet`
{% endhint %}

### Example

```lua
local result = LT.Streaming.RequestAnimSet('set', 1)
```

### Parameters

| Name      | Required | Description                   |
| --------- | -------- | ----------------------------- |
| `set`     | Yes      | Animation set name            |
| `timeout` | No       | Timeout in ms (default: 5000) |

### Returns

* `boolean`

***

## RequestClipSet

Request and await a clip set load.

{% hint style="info" %}
**Side:** Client · **Category:** Streaming · **API:** `LT.Streaming.RequestClipSet`
{% endhint %}

### Example

```lua
local result = LT.Streaming.RequestClipSet('set', 1)
```

### Parameters

| Name      | Required | Description                   |
| --------- | -------- | ----------------------------- |
| `set`     | Yes      | Clip set name                 |
| `timeout` | No       | Timeout in ms (default: 5000) |

### Returns

* `boolean`

***

## RequestModel

Request and await a model load.

{% hint style="info" %}
**Side:** Client · **Category:** Streaming · **API:** `LT.Streaming.RequestModel`
{% endhint %}

### Example

```lua
if LT.Streaming.RequestModel('prop_cs_cardbox_01') then
    -- model loaded
end
```

### Parameters

| Name      | Required | Description                   |
| --------- | -------- | ----------------------------- |
| `model`   | Yes      | string                        |
| `timeout` | No       | Timeout in ms (default: 5000) |

### Returns

* `boolean`

***

## RequestPtfxAsset

Request and await a named PTFX asset load.

{% hint style="info" %}
**Side:** Client · **Category:** Streaming · **API:** `LT.Streaming.RequestPtfxAsset`
{% endhint %}

### Example

```lua
local result = LT.Streaming.RequestPtfxAsset('asset', 1)
```

### Parameters

| Name      | Required | Description                   |
| --------- | -------- | ----------------------------- |
| `asset`   | Yes      | PTFX asset name               |
| `timeout` | No       | Timeout in ms (default: 5000) |

### Returns

* `boolean`

***

## RequestTexture

Request and await a texture dictionary load.

{% hint style="info" %}
**Side:** Client · **Category:** Streaming · **API:** `LT.Streaming.RequestTexture`
{% endhint %}

### Example

```lua
local result = LT.Streaming.RequestTexture('dict', 1)
```

### Parameters

| Name      | Required | Description                   |
| --------- | -------- | ----------------------------- |
| `dict`    | Yes      | Texture dictionary name       |
| `timeout` | No       | Timeout in ms (default: 5000) |

### Returns

* `boolean`

***

## RequestWeaponAsset

Request and await a weapon asset load.

{% hint style="info" %}
**Side:** Client · **Category:** Streaming · **API:** `LT.Streaming.RequestWeaponAsset`
{% endhint %}

### Example

```lua
local result = LT.Streaming.RequestWeaponAsset(1, 1)
```

### Parameters

| Name      | Required | Description                   |
| --------- | -------- | ----------------------------- |
| `hash`    | Yes      | number                        |
| `timeout` | No       | Timeout in ms (default: 5000) |

### Returns

* `boolean`