add info about the return of add_money

spelunky-fyi · Oct 8, 2023 · 19a3a95 · 19a3a95
1 parent ceaf70f
commit 19a3a95
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/docs/game_data/spel2.lua b/docs/game_data/spel2.lua
diff --git a/docs/src/includes/_globals.md b/docs/src/includes/_globals.md
@@ -1187,7 +1187,7 @@ Adds new custom type (group of ENT_TYPE) that can be later used in functions lik
 #### int add_money(int amount, optional<int> display_time)
 
 Adds money to the state.money_shop_total and displays the effect on the HUD for money change
-Can be negative, default display_time = 60 (about 2s)
+Can be negative, default display_time = 60 (about 2s). Returns the current money after the transaction
 
 ### add_money_slot
 
@@ -1197,7 +1197,7 @@ Can be negative, default display_time = 60 (about 2s)
 #### int add_money_slot(int amount, int player_slot, optional<int> display_time)
 
 Adds money to the state.items.player_inventory[player_slot].money and displays the effect on the HUD for money change
-Can be negative, default display_time = 60 (about 2s)
+Can be negative, default display_time = 60 (about 2s). Returns the current money after the transaction
 
 ### change_poison_timer
 

diff --git a/src/game_api/script/lua_vm.cpp b/src/game_api/script/lua_vm.cpp
@@ -2105,11 +2105,11 @@ end
     lua["get_current_money"] = get_current_money;
 
     /// Adds money to the state.money_shop_total and displays the effect on the HUD for money change
-    /// Can be negative, default display_time = 60 (about 2s)
+    /// Can be negative, default display_time = 60 (about 2s). Returns the current money after the transaction
     lua["add_money"] = add_money;
 
     /// Adds money to the state.items.player_inventory[player_slot].money and displays the effect on the HUD for money change
-    /// Can be negative, default display_time = 60 (about 2s)
+    /// Can be negative, default display_time = 60 (about 2s). Returns the current money after the transaction
     lua["add_money_slot"] = add_money_slot;
 
     lua.create_named_table("INPUTS", "NONE", 0, "JUMP", 1, "WHIP", 2, "BOMB", 4, "ROPE", 8, "RUN", 16, "DOOR", 32, "MENU", 64, "JOURNAL", 128, "LEFT", 256, "RIGHT", 512, "UP", 1024, "DOWN", 2048);