From 07d7219a626f838456600ff104a9103c793e9b96 Mon Sep 17 00:00:00 2001 From: the-Astra Date: Tue, 24 Mar 2026 20:12:15 -0400 Subject: [PATCH 1/6] Document `disable_shine` --- SMODS.Center/SMODS.Booster.md | 1 + SMODS.Center/SMODS.Consumable.md | 1 + SMODS.Center/SMODS.Voucher.md | 1 + 3 files changed, 3 insertions(+) diff --git a/SMODS.Center/SMODS.Booster.md b/SMODS.Center/SMODS.Booster.md index fffb1bf..6668e4c 100644 --- a/SMODS.Center/SMODS.Booster.md +++ b/SMODS.Center/SMODS.Booster.md @@ -27,6 +27,7 @@ - Set to string of destination card area, ex. `'consumeables'`, to save cards from the pack instead of using them. - Set to table of form `{Set = 'area'}` to change behaviour according to a card's `Set` (e.g. `{Tarot = 'consumeables'}` to only save `Tarot` cards, relevant if you have multiple types of consumables in a booster). - Set to a function `select_card(self, card, pack) -> string?` to control if and where `card` should be saved for any `card, pack` combination. + - `disable_shine`: Used to disable the shine shader that gets applied to boosters by default ## API methods - `loc_vars, generate_ui` [(reference)](https://github.com/Steamodded/smods/wiki/Localization#Localization-functions) diff --git a/SMODS.Center/SMODS.Consumable.md b/SMODS.Center/SMODS.Consumable.md index 1b77eb9..fa79e83 100644 --- a/SMODS.Center/SMODS.Consumable.md +++ b/SMODS.Center/SMODS.Consumable.md @@ -24,6 +24,7 @@ - Set to string of destination card area, ex. `'consumeables'`, to save this card from Booster packs instead of using it. - Set to a function `select_card(card, pack) -> string?` to control if and where `card` should be saved for any `card, pack` combination. - Takes priority over `select_card` on the ConsumableType or Booster pack + - `disable_shine` (Spectral card only): Used to disable the shine shader that gets applied to Spectral cards by default ## API methods - `calculate(self, card, context)` [(reference)](https://github.com/Steamodded/smods/wiki/Calculate-Functions) diff --git a/SMODS.Center/SMODS.Voucher.md b/SMODS.Center/SMODS.Voucher.md index 8b46461..1e71b40 100644 --- a/SMODS.Center/SMODS.Voucher.md +++ b/SMODS.Center/SMODS.Voucher.md @@ -16,6 +16,7 @@ ``` - `cost = 10`, - `requires`: specify a list of one or more vouchers by their **full key** (e.g. `'v_grabber'` for vanilla vouchers, or `'v_pref_myvoucher'` for a modded voucher from the mod with prefix `'pref'`) + - `disable_shine`: Used to disable the shine shader that gets applied to vouchers by default ## API methods - `calculate(self, card, context)` [(reference)](https://github.com/Steamodded/smods/wiki/Calculate-Functions) From 195b7ad34f3ebb1a74b6107b83c319b0069bf1e0 Mon Sep 17 00:00:00 2001 From: the-Astra Date: Tue, 24 Mar 2026 20:26:18 -0400 Subject: [PATCH 2/6] `context.create_booster_card` and `context.modify_booster_card` --- Calculate-Functions.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/Calculate-Functions.md b/Calculate-Functions.md index ada2e34..005e7d6 100644 --- a/Calculate-Functions.md +++ b/Calculate-Functions.md @@ -965,7 +965,39 @@ context.booster -- the booster pack center that was opened >[!TIP] >You can access the cards in the booster pack by checking in `G.pack_cards.cards` - + +--- +#### context.create_booster_card +This context is used when a card is about created for a booster pack. + +```lua +if context.create_booster_card then +``` + +```lua +context.create_booster_card -- flag to identify this context, always TRUE +context.booster -- the booster pack object that was opened +context.index -- the index order the card to be created is in +``` + +>[!TIP] +>Returning `booster_create_flags` as a table structured similarly to SMODS.create_card will create the card with your specified parameters + +--- +#### context.modify_booster_card +This context is used after a card is created for a booster pack. + +```lua +if context.modify_booster_card then +``` + +```lua +context.modify_booster_card -- flag to identify this context, always TRUE +context.booster -- the booster pack object that was opened +context.card -- the card that was created and is primed for modification +context.index -- the index order the card was created is in +``` + --- #### context.skipping_booster This context is used when a Booster Pack is skipped. From c9d5022d09667a5b1557006c4637b405d92ece5f Mon Sep 17 00:00:00 2001 From: the-Astra Date: Tue, 24 Mar 2026 20:41:12 -0400 Subject: [PATCH 3/6] `context.modify_blind_chips` --- Calculate-Functions.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/Calculate-Functions.md b/Calculate-Functions.md index 005e7d6..ac516dd 100644 --- a/Calculate-Functions.md +++ b/Calculate-Functions.md @@ -705,6 +705,23 @@ context.beat_boss -- boolean value to flag whether a Boss Blind is active context.card_effects -- this is a table of effects that has been calculated during the end of round step ``` +--- +#### context.modify_blind_chips +This context is used to modify a blind's chip goal . + +```lua +if context.modify_blind_chips then +``` + +```lua +context.modify_blind_chips -- boolean value to flag this context, always TRUE +context.blind -- a reference to the blind that will be modified +context.multiplier -- the multiplier value the blind uses to modify from the base ante amount (i.e. 1.5 for Big Blind) +context.blind_chips -- the blind's chip goal +``` +>[!TIP] +>Returning `modify` as a number will set the chip goal to that number + --- #### context.setting_blind This context is used for effects when the blind is started. From e110dd457b1ea69e77e4796d8c6de3be35ec9f2f Mon Sep 17 00:00:00 2001 From: the-Astra Date: Tue, 24 Mar 2026 20:43:53 -0400 Subject: [PATCH 4/6] `context.modify_final_cashout` --- Calculate-Functions.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Calculate-Functions.md b/Calculate-Functions.md index ac516dd..bbd0c8b 100644 --- a/Calculate-Functions.md +++ b/Calculate-Functions.md @@ -923,6 +923,21 @@ if context.round_eval then >[!NOTE] >You can call `add_round_eval_row` in this context to add to the cash out display. +--- +#### context.modify_final_cashout +This context is used to manipulate the final cashout value. + +```lua +if context.modify_final_cashout then +``` + +```lua +context.modify_final_cashout -- boolean value to flag this context, always TRUE +context.dollars -- the current final cashout value +``` +>[!TIP] +>Returning `cashout_mod` as a number will change the cashout value by that number and automatically add a row to the cashout report + --- #### context.modify_ante This context is used when the ante is about to change. Returning `modify = number` will change the amount that the ante will change by. From bc2aa8ce9fa85dc03cd898ab7147fa978b0e2761 Mon Sep 17 00:00:00 2001 From: the-Astra Date: Tue, 24 Mar 2026 20:46:01 -0400 Subject: [PATCH 5/6] Revert "`context.create_booster_card` and `context.modify_booster_card`" This reverts commit 195b7ad34f3ebb1a74b6107b83c319b0069bf1e0. --- Calculate-Functions.md | 34 +--------------------------------- 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/Calculate-Functions.md b/Calculate-Functions.md index bbd0c8b..1f0ca35 100644 --- a/Calculate-Functions.md +++ b/Calculate-Functions.md @@ -997,39 +997,7 @@ context.booster -- the booster pack center that was opened >[!TIP] >You can access the cards in the booster pack by checking in `G.pack_cards.cards` - ---- -#### context.create_booster_card -This context is used when a card is about created for a booster pack. - -```lua -if context.create_booster_card then -``` - -```lua -context.create_booster_card -- flag to identify this context, always TRUE -context.booster -- the booster pack object that was opened -context.index -- the index order the card to be created is in -``` - ->[!TIP] ->Returning `booster_create_flags` as a table structured similarly to SMODS.create_card will create the card with your specified parameters - ---- -#### context.modify_booster_card -This context is used after a card is created for a booster pack. - -```lua -if context.modify_booster_card then -``` - -```lua -context.modify_booster_card -- flag to identify this context, always TRUE -context.booster -- the booster pack object that was opened -context.card -- the card that was created and is primed for modification -context.index -- the index order the card was created is in -``` - + --- #### context.skipping_booster This context is used when a Booster Pack is skipped. From f0bb8e86ef39f282f021e619857e718b87491fc7 Mon Sep 17 00:00:00 2001 From: the-Astra Date: Tue, 24 Mar 2026 20:46:03 -0400 Subject: [PATCH 6/6] Revert "Document `disable_shine`" This reverts commit 07d7219a626f838456600ff104a9103c793e9b96. --- SMODS.Center/SMODS.Booster.md | 1 - SMODS.Center/SMODS.Consumable.md | 1 - SMODS.Center/SMODS.Voucher.md | 1 - 3 files changed, 3 deletions(-) diff --git a/SMODS.Center/SMODS.Booster.md b/SMODS.Center/SMODS.Booster.md index 6668e4c..fffb1bf 100644 --- a/SMODS.Center/SMODS.Booster.md +++ b/SMODS.Center/SMODS.Booster.md @@ -27,7 +27,6 @@ - Set to string of destination card area, ex. `'consumeables'`, to save cards from the pack instead of using them. - Set to table of form `{Set = 'area'}` to change behaviour according to a card's `Set` (e.g. `{Tarot = 'consumeables'}` to only save `Tarot` cards, relevant if you have multiple types of consumables in a booster). - Set to a function `select_card(self, card, pack) -> string?` to control if and where `card` should be saved for any `card, pack` combination. - - `disable_shine`: Used to disable the shine shader that gets applied to boosters by default ## API methods - `loc_vars, generate_ui` [(reference)](https://github.com/Steamodded/smods/wiki/Localization#Localization-functions) diff --git a/SMODS.Center/SMODS.Consumable.md b/SMODS.Center/SMODS.Consumable.md index fa79e83..1b77eb9 100644 --- a/SMODS.Center/SMODS.Consumable.md +++ b/SMODS.Center/SMODS.Consumable.md @@ -24,7 +24,6 @@ - Set to string of destination card area, ex. `'consumeables'`, to save this card from Booster packs instead of using it. - Set to a function `select_card(card, pack) -> string?` to control if and where `card` should be saved for any `card, pack` combination. - Takes priority over `select_card` on the ConsumableType or Booster pack - - `disable_shine` (Spectral card only): Used to disable the shine shader that gets applied to Spectral cards by default ## API methods - `calculate(self, card, context)` [(reference)](https://github.com/Steamodded/smods/wiki/Calculate-Functions) diff --git a/SMODS.Center/SMODS.Voucher.md b/SMODS.Center/SMODS.Voucher.md index 1e71b40..8b46461 100644 --- a/SMODS.Center/SMODS.Voucher.md +++ b/SMODS.Center/SMODS.Voucher.md @@ -16,7 +16,6 @@ ``` - `cost = 10`, - `requires`: specify a list of one or more vouchers by their **full key** (e.g. `'v_grabber'` for vanilla vouchers, or `'v_pref_myvoucher'` for a modded voucher from the mod with prefix `'pref'`) - - `disable_shine`: Used to disable the shine shader that gets applied to vouchers by default ## API methods - `calculate(self, card, context)` [(reference)](https://github.com/Steamodded/smods/wiki/Calculate-Functions)