Exports

This page lists all cd_vipshop exports, along with their purpose, parameters, and usage examples. All events are located in the [cd_vipshop/integrations] folder.

Note

These exports are entirely optional and can be used as needed within your own scripts or integrations.

---

Server

Get Balance

Returns a player’s VIP balance.

@parameters

--- @param number source The player source.
--- @return number balance The player’s VIP balance.

--- @example
local balance = exports['cd_vipshop']:GetVipBalance(source)
print('VIP Balance:', balance)

local balance = exports['cd_vipshop']:GetVipBalance(source)

---

Add Balance

Adds VIP tokens to a player.

@parameters

--- @param number source The player source.
--- @param number amount The amount of VIP tokens to add.

--- @example
exports['cd_vipshop']:AddVipBalance(source, 5)

exports['cd_vipshop']:AddVipBalance(source, amount)

---

Remove Balance

Removes VIP tokens from a player.

@parameters

--- @param number source The player source.
--- @param number amount The amount of VIP tokens to remove.

--- @example
exports['cd_vipshop']:RemoveVipBalance(source, 5)

exports['cd_vipshop']:RemoveVipBalance(source, amount)

---

Can Purchase Check

Checks whether a player can afford a purchase.

@parameters

--- @param number source The player source.
--- @param number cost The cost of the purchase.
--- @return boolean canPurchase Whether the player can afford the purchase.

--- @example
local canPurchase = exports['cd_vipshop']:CanPurchaseCheck(source, 50)
print('Can purchase:', canPurchase)

local canPurchase = exports['cd_vipshop']:CanPurchaseCheck(source, cost)