wasvendel_luckycases

Installation

Unzip wasvendel_luckycases.
Drag the wasvendel_luckycases folder into your server's resources directory.
Import install.sql into your database.
Add the resource to your server.cfg after your framework core.

cfg

ensure oxmysql
ensure your_core
ensure wasvendel_luckycases

SQL

Import install.sql into your database before starting the resource for the first time.

Configuration

Edit config.lua to configure case types, rewards, coin settings, and admin permissions.

Setting	Default	Description
`Config.Settings.cmd`	`case`	Command used to open the lucky cases UI.
`Config.Settings.cmdLuckycoin`	`luckycoin`	Admin command used to manage player coins.
`Config.CoinsAdmin`	Configurable	Permissions for the coin admin command.

Commands

Command	Usage	Description
`/case`	`/case`	Opens the lucky cases UI.
`/luckycoin`	`/luckycoin [id] [amount]`	Manages player coins.

Permissions

Coin admin command access is controlled by Config.CoinsAdmin in config.lua.

Exports

All server exports listed below are safe to call from other resources.

Server Exports

Export	Signature	Description
`GetCoins`	`(src) -> number`	Gets the coin balance by server ID.
`GetCoinsByIdentifier`	`(identifier, charid) -> number`	Gets the coin balance by identifier.
`AddCoins`	`(src, amount) -> boolean`	Adds coins to a player.
`AddCoinsByIdentifier`	`(identifier, charid, amount) -> boolean`	Adds coins by identifier.
`RemoveCoins`	`(src, amount) -> boolean`	Removes coins from a player.
`RemoveCoinsByIdentifier`	`(identifier, charid, amount) -> boolean`	Removes coins by identifier.
`SetCoins`	`(src, amount) -> boolean`	Sets the exact coin balance.
`SetCoinsByIdentifier`	`(identifier, charid, amount) -> boolean`	Sets coins by identifier.

Server Example

lua

local coins = exports['wasvendel_luckycases']:GetCoins(src)

exports['wasvendel_luckycases']:AddCoins(src, 50)

Events

Client Events

Event	Payload	Description
`wasvendel_luckycases:openui`	None	Opens the cases shop UI.
`wasvendel_luckycases:openAndRoll`	None	Opens the UI and starts the roll animation.
`wasvendel_luckycases:checkLootcaseResult`	None	Returns the loot case validation result.
`wasvendel_luckycases:refreshamount`	None	Refreshes the coin balance in the UI.
`wasvendel_luckycases:Notify`	None	Shows a notification.

Server Events

Event	Payload	Description
`wasvendel_luckycases:checkplayer`	None	Checks player access.
`wasvendel_luckycases:checkLootcase`	None	Validates and opens a case.
`wasvendel_luckycases:collectreward`	None	Collects the case reward.
`wasvendel_luckycases:refreshamounts`	None	Refreshes coin amounts.

Custom Reward Hook

Edit customevent.lua to handle custom reward types.

Event	Payload	Description
`wasvendel_luckycases:customevent`	`identifier, item, count, label`	Handles custom rewards.

Example

lua

RegisterNetEvent('wasvendel_luckycases:customevent')

AddEventHandler('wasvendel_luckycases:customevent', function(identifier, item, count, label)
    -- Add your custom reward logic here
end)