Skip to content

Commit 99c4b48

Browse files
committed
feat: finish buy_and_use_card docs
1 parent 8f5413d commit 99c4b48

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

docs/protocol-api.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -109,20 +109,20 @@ The BalatroBot API provides core functions that correspond to the main game acti
109109

110110
### Overview
111111

112-
| Name | Description |
113-
| ----------------------- | -------------------------------------------------------------------------------------------------------------------- |
114-
| `get_game_state` | Retrieves the current complete game state |
115-
| `go_to_menu` | Returns to the main menu from any game state |
116-
| `start_run` | Starts a new game run with specified configuration |
117-
| `skip_or_select_blind` | Handles blind selection - either select the current blind to play or skip it |
118-
| `play_hand_or_discard` | Plays selected cards or discards them |
119-
| `rearrange_hand` | Reorders the current hand according to the supplied index list |
120-
| `rearrange_consumables` | Reorders the consumables according to the supplied index list |
121-
| `cash_out` | Proceeds from round completion to the shop phase |
122-
| `shop` | Performs shop actions: proceed to next round (`next_round`), purchase a card (`buy_card`), or reroll shop (`reroll`) |
123-
| `sell_joker` | Sells a joker from the player's collection for money |
124-
| `sell_consumable` | Sells a consumable from the player's collection for money |
125-
| `use_consumable` | Uses a consumable card from the player's collection (Tarot, Planet, or Spectral cards) |
112+
| Name | Description |
113+
| ----------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
114+
| `get_game_state` | Retrieves the current complete game state |
115+
| `go_to_menu` | Returns to the main menu from any game state |
116+
| `start_run` | Starts a new game run with specified configuration |
117+
| `skip_or_select_blind` | Handles blind selection - either select the current blind to play or skip it |
118+
| `play_hand_or_discard` | Plays selected cards or discards them |
119+
| `rearrange_hand` | Reorders the current hand according to the supplied index list |
120+
| `rearrange_consumables` | Reorders the consumables according to the supplied index list |
121+
| `cash_out` | Proceeds from round completion to the shop phase |
122+
| `shop` | Performs shop actions: proceed to next round (`next_round`), purchase (and use) a card (`buy_card` | `buy_and_use_card`), or reroll shop (`reroll`) |
123+
| `sell_joker` | Sells a joker from the player's collection for money |
124+
| `sell_consumable` | Sells a consumable from the player's collection for money |
125+
| `use_consumable` | Uses a consumable card from the player's collection (Tarot, Planet, or Spectral cards) |
126126

127127
### Parameters
128128

@@ -135,7 +135,7 @@ The following table details the parameters required for each function. Note that
135135
| `play_hand_or_discard` | `action` (string): Either "play_hand" or "discard"<br>`cards` (array): Card indices (0-indexed, 1-5 cards) |
136136
| `rearrange_hand` | `cards` (array): Card indices (0-indexed, exactly `hand_size` elements) |
137137
| `rearrange_consumables` | `consumables` (array): Consumable indices (0-indexed, exactly number of consumables in consumable area) |
138-
| `shop` | `action` (string): Shop action ("next_round", "buy_card", "reroll", or **"redeem_voucher"**)<br>`index` (number, required when `action` = "buy_card" or `action` = **"redeem_voucher"**): 0-based card index to purchase / redeem |
138+
| `shop` | `action` (string): Shop action ("next_round", "buy_card", "buy_and_use_card", "reroll", or "redeem_voucher")<br>`index` (number, required when `action` is one of "buy_card", "redeem_voucher", "buy_and_use_card"): 0-based card index to purchase / redeem |
139139
| `sell_joker` | `index` (number): 0-based index of the joker to sell from the player's joker collection |
140140
| `sell_consumable` | `index` (number): 0-based index of the consumable to sell from the player's consumable collection |
141141
| `use_consumable` | `index` (number): 0-based index of the consumable to use from the player's consumable collection |

0 commit comments

Comments
 (0)