Skip to main content

UgsEconomy

20 tools in this family (folder Editor/Tools/UgsEconomy/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.

ToolEffectDescription
ugs_economy_add_itemwritesGrant a single inventory-item instance to the player. The item type must be configured on the
ugs_economy_decrement_balancewritesAtomically spend currency. The server rejects insufficient-funds (no overdraft) — the call
ugs_economy_delete_itemwritesPermanently remove a single owned inventory instance from the player's cloud inventory.
ugs_economy_export_setupread-onlyExport the complete dashboard configuration (currencies + inventory items + virtual purchases +
ugs_economy_get_balanceread-onlyFetch a single currency balance by currency_id. Cheaper than get_balances when you only need one.
ugs_economy_get_balancesread-onlyFetch ALL currency balances for the signed-in player. Returns one entry per currency with
ugs_economy_get_currencies_configread-onlyList every CURRENCY configured on the Unity dashboard (or mock seed): id, name, max, initial.
ugs_economy_get_inventoryread-onlyFetch the player's cloud inventory. Optionally filter by inventory_item_id (e.g. \
ugs_economy_get_items_configread-onlyList every INVENTORY ITEM TYPE configured on the dashboard (or mock seed): id, name, type,
ugs_economy_get_real_money_purchases_configread-onlyList every REAL-MONEY (IAP) PURCHASE configured on the dashboard (or mock seed): id,
ugs_economy_get_virtual_purchases_configread-onlyList every VIRTUAL PURCHASE configured on the dashboard (or mock seed): id, cost (currency +
ugs_economy_increment_balancewritesAtomically grant currency to the player. The server enforces the configured cap (further
ugs_economy_initwritesInitialize UGS Economy. Verifies UGS Authentication is initialized and the player is signed in
ugs_economy_make_virtual_purchasewritesExecute a virtual purchase configured on the dashboard. Atomic: the server checks all costs
ugs_economy_redeem_apple_purchasewritesRedeem an Apple App Store IAP receipt. Called by the Unity-IAP-on-success handler — the Economy
ugs_economy_redeem_google_purchasewritesRedeem a Google Play IAP receipt. Called by the Unity-IAP-on-success handler — the Economy server
ugs_economy_set_balancedestructiveOVERWRITE a player balance to an arbitrary value. DESTRUCTIVE: the previous balance is gone and
ugs_economy_setup_iap_bridgewritesGenerate ready-to-drop C# files for a project: an IAP → Economy bridge MonoBehaviour (Apple +
ugs_economy_sync_to_local_inventorywritesPull every cloud balance + inventory instance and replay them into the local inv_master_* state.
ugs_economy_update_itemwritesMutate the instance_data of a single owned inventory instance. Pass the players_inventory_item_id