> For the complete documentation index, see [llms.txt](https://docs.vames-store.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vames-store.com/assets/vms_gym/developer-api/client-exports.md).

# Client Exports

### getSkill

Checking how much a player currently has skill

```lua
---@param {skill_name: string}: Registered skill name for example 'condition'
local skill = exports["vms_gym"]:getSkill(skill_name)
```

***

### addSkill

Add a skill value to a player by specifying the skill name and value

```lua
---@param {skill_name: string}: Registered skill name for example 'condition'
---@param {value: number}: Value to add for example 10.0
exports["vms_gym"]:addSkill(skill_name, value)
```

***

### removeSkill

Remove the skill value to a player by specifying the skill name and value

```lua
---@param {skill_name: string}: Registered skill name for example 'condition'
---@param {value: number}: Value to remove for example 10.0
exports["vms_gym"]:removeSkill(skill_name, value)
```

***

### UseEquipment

**Allows external resources to start an interaction with a specific gym equipment model.**

The equipment model must be configured in `Config.EquipmentModels`. The callback is triggered when the training starts or stops, allowing you to execute custom logic based on the player's training state.

```lua
---@param {model: string}: Model name from Config.EquipmentModels
---@param {cb: function}: Callback triggered when the training starts or stops
exports['vms_gym']:UseEquipment(model, cb)
```

<details>

<summary><strong>Example Usage</strong></summary>

```lua
exports['vms_gym']:UseEquipment('prop_curl_bar_01', function(action)
    if action == 'started' then
        print('The player started training with a barbell.')
    elseif action == 'stopped' then
        print('The player finished the barbell exercise.')
    end
end)
```

</details>

***

### openStatisticsMenu

Export to open the player statistics menu

```lua
exports["vms_gym"]:openStatisticsMenu()
```