Score mod documentation

Calculate-Functions.md

@@ -62,7 +62,8 @@ return {
 
 There are a range of different keys that you can return in this table. These keys can be combined to have multiple effects from the same calculation step.
 
-- `chips`,`mult`,`xmult`, `xchips`, `dollars` - scores these values *(automatically adds a message to the card that is being scored)*
+- `chips`, `mult`, `xmult`, `xchips`, `dollars` - scores these values *(automatically adds a message to the card that is being scored)*
+- `score`, `xscore` - adds or multiplies the current scored chips, respectively *(automatically adds a message to the card that is being scored)*
 - `swap` - swaps current chips and mult values with each other
 - `balance` - balances the current chips and mult values *(plasma deck effect)*
 - `level_up` - levels up the played hand by the number returned *(You can specify a different hand to be levelled up by using `level_up_hand`)*

Internal-Documentation.md

@@ -117,6 +117,13 @@ Pushes `context` into `SMODS.context_stack`.
 Pops a `context` from `SMODS.context_stack`.
 #### `SMODS.get_previous_context()`
 Returns the second to last context from `SMODS.context_stack`
+#### `SMODS.mod_score(args)`
+Modifies current scored chips. Arguments:
+    - `add`: Add this number to score
+    - `mult`: Multiply score by this number
+    - `card`: Card responsible for score modification action, crucial for score display to work properly
+    - `effect`: Table of effects that were calculated
+    - `from_edition`: If `true` the effect comes from an Edition
 
 ## Misc.
 These are functions used by SMODS for miscellaneous features.

Perma-bonuses.md

@@ -24,6 +24,10 @@ perma_h_x_mult,
 perma_p_dollars,  -- money on scoring
 perma_h_dollars,  -- money on held at end of round (like gold cards)
 
+perma_score, -- adds to current chips scored
+perma_x_score, -- multiplies current chips scored
+perma_h_score, -- adds to current chips scored when held
+perma_h_x_score -- multiplies current chips scored when held
 perma_blind_size, -- adds to current blind_size
 perma_x_blind_size, -- multiplies current blind_size
 perma_h_blind_size, -- adds to current blind_size when held
@@ -59,11 +63,14 @@ Permanent bonuses are scored in the following order:
 3. xchips (enhancement * permanent)
 4. xmult (enhancement * permanent)
 5. dollars (seals + permanent)
-6. blindsize (permanent, enhancement)
-7. xblindsize (permanent, enhancement)
-8. (enhancement * permanent)
-9. all edition effects
-10. all joker effects
+6. score (permanent, enhancement)
+7. xscore (permanent, enhancement)
+8. all edition effects
+9. all joker effects
+10. blindsize (permanent, enhancement)
+11. xblindsize (permanent, enhancement)
+12. all edition effects
+13. all joker effects
 
 Permanent (held) chips get scored at the same time as a playing card's base chips and chips from enhancements. They also show up as a combined number with bonus chips from enhancements in the UI. This is inherited vanilla behaviour. Supports negative values.
 
@@ -75,6 +82,9 @@ Permanent xmult gets multiplied with enhancement xmult such as glass when scorin
 
 Permanent held xmult gets multiplied with enhancement held xmult such as steel when scoring, showing as a single multiplied number during scoring. It does show up as a seperate number in the UI when hovering over the card. It does not support negative values, and will do nothing if scored.
 
+Permanent (held) score gets scored before the enhancement. It does show up as a seperate number in the UI when hovering over the card. Supports negative values.
+
+Permanent (held) xscore gets scored before the enhancement. It does show up as a seperate number in the UI when hovering over the card. Does not support final negative xscore, and will do nothing if end result is negative.
 Permanent (held) blindsize get scored before the enhancement. It does show up as a seperate number in the UI when hovering over the card. Supports negative values.
 
 Permanent (held) xblindsize get scored before the enhancement. It does show up as a seperate number in the UI when hovering over the card. Does not support final negative xblindsize, and will do nothing if end result is negative.
@@ -96,6 +106,11 @@ card_extra_h_mult,
 card_extra_h_x_chips,
 card_extra_h_x_mult,
 
+card_extra_score,
+card_extra_x_score,
+card_extra_h_score,
+card_extra_h_x_score,
+
 card_extra_blind_size,
 card_extra_x_blind_size,
 card_extra_h_blind_size,