Client Exports

getSkill

Checking how much a player currently has skill

---@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

---@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

---@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.

---@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)

Example Usage

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)

---

openStatisticsMenu

Export to open the player statistics menu

exports["vms_gym"]:openStatisticsMenu()