Comment on page

ItemPurchase

Fires when an item is purchased in the Item Shop.
Example usage:
-- Refund 50% of all Iron purchases in the shop
Events.ItemPurchase(function(event)
-- Only refund the player if the resource used to purchase the item is Iron
if (event.costItem == ItemType.IRON) then
-- Round 50% of the price to the closest smaller integer
local refund = math.floor(event.price * 0.5);
InventoryService.giveItem(event.player, ItemType.IRON, refund, true)
end
end)

Parameters

player: Player

The player who received a new item.

itemType: ItemType

The type of item received by the player.

amount: number

The amount of the item received by the player.

costItem: ItemType

The type of item used to purchase the specified item.

price: number

The amount of the cost item used to purchase the specified item.