Skip to content

shiva-economy — API

Auto-generated from LuaLS annotations. Run shiva docs:api to regenerate.

EconomyService:getBalance(serverId, account)

lua
local economy = container:make('IEconomy')
local cash = economy:getBalance(source, 'cash')   -- number

EconomyService:addMoney(serverId, account, amount)

lua
economy:addMoney(source, 'bank', 1000)  -- boolean

EconomyService:removeMoney(serverId, account, amount)

Returns false if the player has insufficient funds (and Config.allowNegativeBalance is false).

lua
local ok = economy:removeMoney(source, 'cash', 500)  -- boolean

EconomyService:transferMoney(fromId, toId, account, amount)

lua
economy:transferMoney(source, targetId, 'cash', 200)  -- boolean

EconomyService:setBalance(serverId, account, amount)

Admin-level operation. Sets balance directly without firing transaction events.

lua
economy:setBalance(source, 'bank', 10000)

Released under the MIT License.