Client
Check if assets exist, such as models, and loads them into memory.
Throws errors for invalid assets and returns true if the asset is loaded.
lib.requestAnimDict
Remember to call RemoveAnimDict(dict) at the end of your code!
```lua
lib.requestAnimDict(dict, timeout)
```
```ts
import lib from '@overextended/ox_lib/client'
lib.requestAnimDict(dict, timeout)
```
- dict:
string - timeout?:
number- Number of ticks to wait for the asset to load.
- Default:
10000
lib.requestAnimSet
Remember to call RemoveAnimSet(set) at the end of you code!
```lua
lib.requestAnimSet(set, timeout)
```
```ts
import lib from '@overextended/ox_lib/client'
lib.requestAnimSet(set, timeout)
```
- set:
string - timeout?:
number- Number of ticks to wait for the asset to load.
- Default:
10000
lib.requestAudioBank
Remember to call ReleaseScriptAudioBank(set) at the end of you code!
lib.requestAudioBank(audioBank, timeout)
- audioBank:
string - timeout?:
number- Number of ticks to wait for the asset to load.
- Default:
30000
lib.requestModel
Remember to call SetModelAsNoLongerNeeded(model) at the end of you code!
```lua
lib.requestModel(model, timeout)
```
```ts
import lib from '@overextended/ox_lib/client'
lib.requestModel(model, timeout)
```
- model:
string - timeout?:
number- Number of ticks to wait for the asset to load.
- Default:
10000
lib.requestStreamedTextureDict
Remember to call SetStreamedTextureDictAsNoLongerNeeded(dict) at the end of you code!
```lua
lib.requestStreamedTextureDict(dict, timeout)
```
```ts
import lib from '@overextended/ox_lib/client'
lib.requestStreamedTextureDict(dict, timeout)
```
- dict:
string - timeout?:
number- Number of ticks to wait for the asset to load.
- Default:
10000
lib.requestNamedPtfxAsset
Remember to call RemoveNamedPtfxAsset(dict) at the end of you code!
```lua
lib.requestNamedPtfxAsset(ptFxName, timeout)
```
```ts
import lib from '@overextended/ox_lib/client'
lib.requestNamedPtfxAsset(ptFxName, timeout)
```
- ptFxName:
string - timeout?:
number- Number of ticks to wait for the asset to load.
- Default:
10000
lib.requestScaleformMovie
Remember to call SetScaleformMovieAsNoLongerNeeded(scaleformName) at the end of you code!
```lua
lib.requestScaleformMovie(scaleformName, timeout)
```
```ts
import lib from '@overextended/ox_lib/client'
lib.requestScaleformMovie(scaleformName, timeout)
```
- scaleformName:
string - timeout?:
number- Number of ticks to wait for the asset to load.
- Default:
1000
lib.requestWeaponAsset
Remember to call RemoveWeaponAsset(weaponType) at the end of you code!
```lua
lib.requestWeaponAsset(weaponType, timeout, weaponResourceFlags, extraWeaponComponentFlags)
```
```ts
import lib from '@overextended/ox_lib/client'
lib.requestWeaponAsset(weaponType, timeout, weaponResourceFlags, extraWeaponComponentFlags)
```
- weaponType:
string | number - timeout?:
number- Number of ticks to wait for the asset to load.
- Default:
10000
- weaponResourceFlags?:
WeaponResourceFlags- Default:
31
- Default:
- extraWeaponComponentFlags?:
ExtraWeaponComponentFlags- Default:
0
- Default:
lib.requestWeaponAsset > WeaponResourceFlags
1 WRF_REQUEST_BASE_ANIMS
2 WRF_REQUEST_COVER_ANIMS
4 WRF_REQUEST_MELEE_ANIMS
8 WRF_REQUEST_MOTION_ANIMS
16 WRF_REQUEST_STEALTH_ANIMS
32 WRF_REQUEST_ALL_MOVEMENT_VARIATION_ANIMS
31 WRF_REQUEST_ALL_ANIMS
lib.requestWeaponAsset > ExtraWeaponComponentFlags
0 WEAPON_COMPONENT_NONE
1 WEAPON_COMPONENT_FLASH
2 WEAPON_COMPONENT_SCOPE
4 WEAPON_COMPONENT_SUPP
8 WEAPON_COMPONENT_SCLIP2
16 WEAPON_COMPONENT_GRIP