# Utils functions `[Client]`

A library with util functions to create a script

## JO Functions

### jo.utils.loadGameData()

A function to load a game file <br>

#### Syntax

```lua
jo.utils.loadGameData(name, waiter)
```

#### Parameters

`name` : _string|integer_
> The name of the file <br> Compatible with animation dictionaries, models (hashed or string), and texture dictionaries
>

`waiter` : _boolean_ `[Optional]`
> If the function has to wait after the loading to be completed
>

---

### jo.utils.releaseGameData()

A function to release a game file <br>

#### Syntax

```lua
jo.utils.releaseGameData(name)
```

#### Parameters

`name` : _string|integer_
> The name of the file
>

---

### jo.utils.screenToWorld()

Converts screen coordinates to world coordinates using camera raycasting <br>
This function casts a ray from the camera through the specified screen position and returns information about what it hits in the 3D world <br>

#### Syntax

```lua
jo.utils.screenToWorld(distance, flags, toIgnore, mouseX, mouseY)
```

#### Parameters

`distance` : _number_ `[Optional]`
> Maximum raycast distance in game units <br> default:`100`
>

`flags` : _integer_ `[Optional]`
> [Flags](https://docs.fivem.net/natives/?_0x7EE9F5D83DD4F90E) for the raycast <br> default:`1|2|8|16`
>

`toIgnore` : _integer_ `[Optional]`
> Entity to ignore in the raycast <br> default:`PlayerPedId()`
>

`mouseX` : _number_ `[Optional]`
> X screen coordinate normalized between 0-1 <br> default:`0.5` screen center
>

`mouseY` : _number_ `[Optional]`
> Y screen coordinate normalized between 0-1 <br> default:`0.5` screen center
>

#### Return Value

Type : _boolean,vector3,vector3,integer_

> hit, endCoords, surfaceNormal, entityHit

---

### jo.utils.waiter()

A function to wait after a satisfying condition with a waiting duration <br>

#### Syntax

```lua
jo.utils.waiter(cb, maxDuration, loopTimer)
```

#### Parameters

`cb` : _function_
> If the function returns `true` a new timer value is waited
>

`maxDuration` : _integer_ `[Optional]`
> The maximum duration the function will wait <br> default: 1000
>

`loopTimer` : _integer_ `[Optional]`
> The delay between tests of cb function in ms <br> default: 0
>

#### Return Value

Type : _boolean_

> Returns `true` if the function is satisfied, `false` if the waiter was killed by the maxDuration value