Request
âšī¸ Client Module - This can only be used on the client
All request functions accept a single value or a table of values. Default timeout is 20 seconds. Assets are automatically released when the resource stops.
#lib.request.model
Load a model
lua
local success = lib.request.model(model, timeout)
| Parameter | Type | Required | Description |
|---|
| model | string | table | yes | Model(s) to load |
| timeout | number | no | Timeout in seconds (default 20) |
#lib.request.animDict
Load an animation dictionary
lua
local success = lib.request.animDict(dict, timeout)
| Parameter | Type | Required | Description |
|---|
| dict | string | table | yes | Animation dictionary(s) to load |
| timeout | number | no | Timeout in seconds (default 20) |
#lib.request.animSet
Load an animation set (movement clipset)
lua
local success = lib.request.animSet(set, timeout)
| Parameter | Type | Required | Description |
|---|
| set | string | table | yes | Animation set(s) to load |
| timeout | number | no | Timeout in seconds (default 20) |
#lib.request.streamedTextureDict
Load a streamed texture dictionary
lua
local success = lib.request.streamedTextureDict(txd, timeout)
| Parameter | Type | Required | Description |
|---|
| txd | string | table | yes | Texture dictionary(s) to load |
| timeout | number | no | Timeout in seconds (default 20) |
#lib.request.ptfxAsset
Load a particle effect asset
lua
local success = lib.request.ptfxAsset(asset, timeout)
| Parameter | Type | Required | Description |
|---|
| asset | string | table | yes | PTFX asset(s) to load |
| timeout | number | no | Timeout in seconds (default 20) |
#lib.request.audioBank
Load an audio bank
lua
local success = lib.request.audioBank(bank, timeout)
| Parameter | Type | Required | Description |
|---|
| bank | string | table | yes | Audio bank(s) to load |
| timeout | number | no | Timeout in seconds (default 20) |
Load a scaleform movie
lua
local success = lib.request.scaleFormMovie(movie, timeout)
| Parameter | Type | Required | Description |
|---|
| movie | string | table | yes | Scaleform movie(s) to load |
| timeout | number | no | Timeout in seconds (default 20) |
#lib.request.weaponAsset
Load a weapon asset
lua
local success = lib.request.weaponAsset(asset, timeout)
| Parameter | Type | Required | Description |
|---|
| asset | string | table | yes | Weapon asset(s) to load |
| timeout | number | no | Timeout in seconds (default 20) |
#lib.request.entity
Wait for an entity to exist in the game world
lua
local success = lib.request.entity(entity, timeout)
| Parameter | Type | Required | Description |
|---|
| entity | number | yes | Entity handle to wait for |
| timeout | number | no | Timeout in seconds (default 20) |
