Remove Player Kcoins

💸 RemovePlayerKCoins

Description

Removes KCoins from a player’s balance. Commonly used for purchases, penalties, or transfers.

Usage

exports['kartik-laptop']:RemovePlayerKCoins(citizenId, amount, reason, to)

Parameters

Name	Type	Description
citizenId	string	The target player’s Citizen ID.
amount	number	Amount of KCoins to deduct.
reason (optional)	string	Description for the transaction (e.g. “Store Purchase”).
to (optional)	string	Address or receiver (defaults to “SYSTEM”).

Returns

Type	Description
boolean	Returns true if the player had sufficient balance and the transaction was completed.

Example

exports['kartik-laptop']:RemovePlayerKCoins('CIT12345', 200, 'Shop Purchase', 'Vendor123')