# Client

## toggleUI

```lua
exports.tk_dispatch:toggleUI(page)
```

Toggles a UI page

page: `'callManager'` `'sidebar'` `'map'`

## getPlayerData

```lua
exports.tk_dispatch:getPlayerData()
```

Returns a table of data that can be used for example for call message

#### return:

* data: `table`
  * gender: `string`
  * location: `string`
  * direction: `string`
  * vehicle?: `table` will only return if player is in a vehicle
    * model: `string`
    * color: `string`
    * plate: `string`
  * weapon?: `string` will only return if player is holding a weapon

## addCall

```lua
exports.tk_dispatch:addCall(data)
```

Adds a call with given data

* data: `table`
  * title: `string`
  * code?: `string`
  * priority?: `string`
  * coords: `vec3`
  * coordsOffset?: `number` will randomise call coords by given amount
  * image?: `string` image link
  * takePhoto?: `boolean` should the call data include a photo of player screen
  * message?: `string`
  * showLocation?: `boolean`
  * showDirection?: `boolean`
  * showGender?: `boolean`
  * showVehicle?: `boolean`
  * platePercentage?: `number` the percentage of plate characters to show (0-100), missing characters will be replaced with a "?"
  * showWeapon?: `boolean`
  * showPerson?: `boolean`
  * showNumber?: `boolean`
  * removeTime?: `number` time in milliseconds to remove call
  * showTime?: `number` time in milliseconds the call will show as a notification
  * color?: `string` color for notification left side ([https://yeun.github.io/open-color/](< https://yeun.github.io/open-color/>))
  * flash?: `boolean`
  * playSound?: `boolean`
  * playSoundAll?: `boolean` will play a sound that all players can hear
  * jobs: `string[]`
  * blip?: `table`
    * sprite: `number`
    * scale: `number`
    * color: `number`
    * flash?: `boolean`
    * display?: `number`
    * shortRange?: `boolean`
    * radius?: `number`

### Examples

{% tabs %}
{% tab title="Burglary" %}

```lua
exports.tk_dispatch:addCall({
    title = 'Burglary',
    code = '10-58',
    priority = 'Priority 3',
    coords = GetEntityCoords(PlayerPedId()),
    showLocation = true,
    showGender = true,
    playSound = true,
    blip = {
        color = 3,
        sprite = 357,
        scale = 1.0,
    },
    jobs = {'police'},
})
```

{% endtab %}

{% tab title="Shooting (with photo)" %}

```lua
exports.tk_dispatch:addCall({
    title = 'Shooting',
    code = '10-11',
    priority = 'Priority 2',
    coords = GetEntityCoords(PlayerPedId()),
    showLocation = true,
    showDirection = true,
    showGender = true,
    showVehicle = true,
    platePercentage = 50,
    showWeapon = true,
    takePhoto = true,
    coordsOffset = 20,
    removeTime = 1000 * 60 * 10, 
    showTime = 10000,
    blip = {
        color = 3,
        sprite = 110,
        scale = 1.0,
        radius = 40.0,
    },
    jobs = {'police', 'sheriff'},
})
```

{% endtab %}

{% tab title="getPlayerData" %}

```lua
local data = exports.tk_dispatch:getPlayerData()
exports.tk_dispatch:addCall({
    title = 'Shooting',
    code = '10-11',
    priority = 'Priority 2',
    message = 'A ' .. data.gender .. ' is shooting at ' .. data.location .. ' with a ' .. data.weapon,
    coords = GetEntityCoords(PlayerPedId()),
    coordsOffset = 20,
    removeTime = 1000 * 60 * 10,
    showTime = 10000,
    blip = {
        color = 3,
        sprite = 110,
        scale = 1.0,
        radius = 40.0,
    },
    jobs = {'police', 'sheriff'},
})
```

{% endtab %}
{% endtabs %}

{% code overflow="wrap" fullWidth="true" %}

```lua
```

{% endcode %}


---

# 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://tk-scripts.gitbook.io/docs/tk_dispatch/exports/client.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.