> For the complete documentation index, see [llms.txt](https://highqez.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://highqez.gitbook.io/docs/resources/afk-safe-zone/api/client.md).

# Client

Guide to use the script more advanced

{% hint style="success" %}
Exports are used to sync the zone script with the addon script
{% endhint %}

## **IsInZone**

Check if the player is inside the zone

Return:

* Boolean:
  * `true`: the player inside the zone
  * `false`: the player outside the zone

{% code title="Usage" %}

```lua
exports["highqez_AFKzone"]:IsInZone()
```

{% endcode %}

***

## **IsInSafeZone** 

{% hint style="warning" %}
Works if **EnableSafeZoneUI= true**
{% endhint %}

Check if the player is inside the Safe zone

Return:

* Boolean:
  * `true`: the player is inside the Safe zone
  * `false`: the player is outside the Safe zone

{% code title="Usage" %}

```lua
exports["highqez_AFKzone"]:IsInSafeZone()
```

{% endcode %}

***

## **IsInAFKZone**

{% hint style="warning" %}
Works if **EnableAFKZoneUI = true**
{% endhint %}

Check if the player is inside the AFK zone

Return:

* Boolean:
  * `true`: the player is inside the AFK zone
  * `false`: the player is outside the AFK zone

{% code title="Usage" %}

```lua
exports["highqez_AFKzone"]:IsInAFKZone()
```

{% endcode %}

***

## **GetZoneName** 

Obtain the current zone name

Return:

* String:
  * `zonename`: the name of the zone player is inside
* Boolean:
  * `false`: the player is outside the zone

{% code title="Usage" %}

```lua
exports["highqez_AFKzone"]:GetZoneName()
```

{% endcode %}