> For the complete documentation index, see [llms.txt](https://documentation.rcore.cz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.rcore.cz/paid-resources/rcore_prison/api/api-client.md).

# Client

## Exports (General)

List of general exports.

### Jail

{% hint style="info" %}
**CLIENT**
{% endhint %}

This export is used when you want to jail target citizen.

{% hint style="info" %}
**The initiator player needs to be in Police job to make it work!**
{% endhint %}

#### Example code

{% code title="client.lua" overflow="wrap" lineNumbers="true" %}

```lua

local targetPlayerId = 1
local jailTime = 5 -- 5 minutes

exports['rcore_prison']:Jail(targetPlayerId, jailTime)
```

{% endcode %}

### IsPrisoner

{% hint style="info" %}
**CLIENT**
{% endhint %}

This export is used when you want to check if target player is in Prison

#### Example code

{% code title="client.lua" overflow="wrap" lineNumbers="true" %}

```lua
exports['rcore_prison']:IsPrisoner()
```

{% endcode %}

### Open dashboard

{% hint style="info" %}
**CLIENT**
{% endhint %}

This export is used when you want to open included dashboard

#### Example code

{% code title="client.lua" overflow="wrap" lineNumbers="true" %}

```lua
exports['rcore_prison']:OpenDashboard()
```

{% endcode %}

### Unjail

{% hint style="info" %}
**CLIENT**
{% endhint %}

This export is used when you want to jail target citizen.

{% hint style="info" %}
**The initiator player needs to be in Police job to make it work!**
{% endhint %}

#### Example code

{% code title="client.lua" overflow="wrap" lineNumbers="true" %}

```lua

local targetPlayerId = 1

exports['rcore_prison']:Unjail(targetPlayerId)
```

{% endcode %}

### IsPlayerInCutScene

{% hint style="info" %}
**CLIENT**
{% endhint %}

This export is used when you want know if player is cutscene (Prolog)

#### Example code

{% code title="client.lua" overflow="wrap" lineNumbers="true" %}

```
```

{% endcode %}

```lua
exports['rcore_prison']:IsPlayerInCutScene()
```

### JailByIdentifier

{% hint style="info" %}
**CLIENT**
{% endhint %}

This export is used to jail player by identifier

#### Example code

{% code title="client.lua" overflow="wrap" lineNumbers="true" %}

```lua
exports['rcore_prison']:JailByIdentifier(identifier, jailTime)
```

{% endcode %}

### rcore\_prison:server:StartComs

{% hint style="info" %}
**CLIENT**
{% endhint %}

This event is used to sent player to coms

#### Example code

{% code title="client.lua" overflow="wrap" lineNumbers="true" %}

```lua
TriggerServerEvent('rcore_prison:server:StartComs', target, perollCount)
```

{% endcode %}

### JailPlayerByNPC

{% hint style="info" %}
**SERVER**
{% endhint %}

This export is used when you want to jail player by NPC

#### Example code

{% code title="server.lua" overflow="wrap" lineNumbers="true" %}

```lua
local targetPlayerId = 1
local pedId = 321321

-- The peds needs to be networked to make this -> see: modules\base\server\api\sv-jailPlayer.lua

TriggerServerEvent('rcore_prison:server:JailPlayerByNPC', targetPlayerId, PedToNet(pedId))
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://documentation.rcore.cz/paid-resources/rcore_prison/api/api-client.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.