# Entities

{% hint style="warning" %}
**CLIENT FUNCTIONS**
{% endhint %}

## get\_nearby\_entities

Finds nearby entities based on pool and position.

#### Parameters

* pool: `string`
* coords: `vector3`
* max\_distance: `number`
* filter: `function|nil`

#### Returns

* `table`

```lua
bdtk.get_nearby_entities(pool, coords, max_distance, filter)
```

***

## get\_nearby\_objects

Returns nearby object entities.

#### Parameters

* coords: `vector3`
* max\_distance: `number`

#### Returns

* `table`

```lua
bdtk.get_nearby_objects(coords, max_distance)
```

***

## get\_nearby\_peds

Returns nearby peds, excluding players.

#### Parameters

* coords: `vector3`
* max\_distance: `number`

#### Returns

* `table`

```lua
bdtk.get_nearby_peds(coords, max_distance)
```

***

## get\_nearby\_players

Returns nearby players.

#### Parameters

* coords: `vector3`
* max\_distance: `number`
* include\_player: `boolean`

#### Returns

* `table`

```lua
bdtk.get_nearby_players(coords, max_distance, include_player)
```

***

## get\_nearby\_vehicles

Returns nearby vehicles.

#### Parameters

* coords: `vector3`
* max\_distance: `number`
* include\_player\_vehicle: `boolean`

#### Returns

* `table`

```lua
bdtk.get_nearby_vehicles(coords, max_distance, include_player_vehicle)
```

***

## get\_closest\_object

Gets the closest object entity.

#### Parameters

* coords: `vector3`
* max\_distance: `number`

#### Returns

* `number`, `vector3`

```lua
bdtkbdtk.get_closest_object(coords, max_distance)
```

***

## get\_closest\_ped

Gets the closest ped entity.

#### Parameters

* coords: `vector3`
* max\_distance: `number`

#### Returns

* `number`, `vector3`

```lua
bdtk.get_closest_ped(coords, max_distance)
```

***

## get\_closest\_player

Gets the closest player entity.

#### Parameters

* coords: `vector3`
* max\_distance: `number`
* include\_player: `boolean`

#### Returns

* `number`, `vector3`

```lua
bdtk.get_closest_player(coords, max_distance, include_player)
```

***

## get\_closest\_vehicle

Gets the closest vehicle entity.

#### Parameters

* coords: `vector3`
* max\_distance: `number`
* include\_player\_vehicle: `boolean`

#### Returns

* `number`, `vector3`

```lua
bdtk.get_closest_vehicle(coords, max_distance, include_player_vehicle)
```

***

## get\_entities\_in\_front\_of\_player

Returns the entity directly in front of the player.

#### Parameters

* fov: `number`
* distance: `number`

#### Returns

* `number|nil`

```lua
bdtk.get_entities_in_front_of_player(fov, distance)
```

***

## get\_target\_ped

Gets the ped in front of the player or the closest.

#### Parameters

* player\_ped: `number`
* fov: `number`
* distance: `number`

#### Returns

* `number`, `vector3`

```lua
bdtk.get_target_ped(player_ped, fov, distance)
```


---

# 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://docs.boii.dev/fivem-free-resources/bdtk/api/modules/entities.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.
