feat: score modification effect (#1167)

* feat: score modification effect

* chore: add LSP

* chore: resolve merge conflict

* chore: change all add_score to just score

* Feature parity: (x)score_message, remove_default_message + loc key consistency

---------

Co-authored-by: Casimir Eisenach <casimirusenormus@hotmail.de>

Author: Aikoyori

assets/sounds/xscore.ogg

@@ -142,6 +142,46 @@ return {
                     "card {C:attention}#1#{} #2#",
                 },
             },
+            card_score = {
+                text = {
+                    "{C:purple}#1#{} Score",
+                },
+            },
+            card_h_score = {
+                text = {
+                    "{C:purple}#1#{} Score when held",
+                },
+            },
+            card_x_score = {
+                text = {
+                    "{X:purple,C:white}X#1#{} Score",
+                },
+            },
+            card_h_x_score = {
+                text = {
+                    "{X:purple,C:white}X#1#{} Score when held",
+                },
+            },
+            card_extra_score = {
+                text = {
+                    "{C:purple}#1#{} extra Score",
+                },
+            },
+            card_extra_h_score = {
+                text = {
+                    "{C:purple}#1#{} extra Score when held",
+                },
+            },
+            card_extra_x_score = {
+                text = {
+                    "{X:purple,C:white}X#1#{} extra Score",
+                },
+            },
+            card_extra_h_x_score = {
+                text = {
+                    "{X:purple,C:white}X#1#{} extra Score when held",
+                },
+            },
             artist = {
                 text = {
                     "{C:inactive}Artist",
@@ -300,6 +340,9 @@ return {
 			cashout_hidden = '...and #1# more',
             a_xchips = "X#1# Chips",
             a_xchips_minus = "-X#1# Chips",
+            a_score="#1# Score",
+            a_xscore="X#1# Score",
+            a_xscore_minus="-X#1# Score",
             smods_version_mismatch = {
                 "Your Steamodded version has changed",
                 "since this run was started!",

localization/en-us.lua

@@ -116,6 +116,14 @@ if context.cardarea == G.play and context.main_scoring then
         ret.playing_card.x_chips = x_chips
     end
 
+    local score = card:get_bonus_score()
+    if score ~= 0 then
+        ret.playing_card.score = score
+    end
+    local x_score = card:get_bonus_x_score()
+    if x_score ~= 1 then
+        ret.playing_card.x_score = x_score
+    end
     -- TARGET: main scoring on played cards
 end
 if context.end_of_round and context.cardarea == G.hand and context.playing_card_end_of_round then
@@ -170,6 +178,15 @@ if context.cardarea == G.hand and context.main_scoring then
         ret.playing_card.x_chips = h_x_chips
     end
 
+    local h_score = card:get_bonus_h_score()
+    if h_score ~= 0 then
+        ret.playing_card.score = h_score
+    end
+    local h_x_score = card:get_bonus_h_x_score()
+    if h_x_score ~= 1 then
+        ret.playing_card.h_x_score = h_x_score
+    end
+
     -- TARGET: main scoring on held cards
 """
 

lovely/better_calc.toml

@@ -99,6 +99,10 @@ bonus_h_x_mult = self.ability.perma_h_x_mult ~= 0 and (self.ability.perma_h_x_mu
 bonus_p_dollars = self.ability.perma_p_dollars ~= 0 and self.ability.perma_p_dollars or nil,
 bonus_h_dollars = self.ability.perma_h_dollars ~= 0 and self.ability.perma_h_dollars or nil,
 total_h_dollars = total_h_dollars ~= 0 and total_h_dollars or nil,
+perma_score = self.ability.perma_score ~= 0 and (self.ability.perma_score) or nil,
+perma_h_score = self.ability.perma_h_score ~= 0 and (self.ability.perma_h_score) or nil,
+perma_x_score = self.ability.perma_x_score ~= 1 and (self.ability.perma_x_score) or nil,
+perma_h_x_score = self.ability.perma_h_x_score ~= 1 and (self.ability.perma_h_x_score) or nil,
 bonus_chips = bonus_chips ~= 0 and bonus_chips or nil,
 bonus_repetitions = self.ability.perma_repetitions ~= 0 and self.ability.perma_repetitions or nil,'''
 match_indent = true
@@ -140,6 +144,10 @@ perma_h_dollars = self.ability and self.ability.perma_h_dollars or 0,
 perma_repetitions = self.ability and self.ability.perma_repetitions or 0,
 card_limit = self.ability and self.ability.card_limit or 0,
 extra_slots_used = self.ability and self.ability.extra_slots_used or 0,
+perma_score = self.ability and self.ability.perma_score or 0,
+perma_h_score = self.ability and self.ability.perma_h_score or 0,
+perma_x_score = self.ability and self.ability.perma_x_score or 1,
+perma_h_x_score = self.ability and self.ability.perma_h_x_score or 1,
 '''
 match_indent = true
 overwrite = false
@@ -257,6 +265,34 @@ function Card:get_h_dollars()
     -- TARGET: get_h_dollars
     return ret
 end
+
+function Card:get_bonus_score()
+    if self.debuff then return 0 end
+    local ret = (self.ability.perma_score or 0)
+    -- TARGET: get_bonus_score
+    return ret
+end
+
+function Card:get_bonus_x_score()
+    if self.debuff then return 1 end
+    local ret = (self.ability.perma_x_score or 1)
+    -- TARGET: get_bonus_x_score
+    return ret
+end
+
+function Card:get_bonus_h_score()
+    if self.debuff then return 0 end
+    local ret = (self.ability.perma_h_score or 0)
+    -- TARGET: get_bonus_h_score
+    return ret
+end
+
+function Card:get_bonus_h_x_score()
+    if self.debuff then return 1 end
+    local ret = (self.ability.perma_h_x_score or 1)
+    -- TARGET: get_bonus_h_x_score
+    return ret
+end
 '''
 
 # Card:get_p_dollars

lovely/perma_bonus.toml

@@ -0,0 +1,72 @@
+[manifest]
+version = "1.0.0"
+dump_lua = true
+priority = -10
+
+# Score Modification!
+
+
+[[patches]]
+[patches.pattern]
+target = "functions/common_events.lua"
+pattern = """        if extra.edition then """
+position = "before"
+payload = """
+if extra.sound_override then
+    sound = extra.sound_override
+end
+if extra.update_score then
+    G.CARD_EVAL_TRIGGERED = nil
+    update_score = true
+end
+"""
+overwrite = true
+match_indent = true
+
+
+
+[[patches]]
+[patches.pattern]
+target = "functions/common_events.lua"
+pattern = """    local trigger = 'before'"""
+position = "before"
+payload = """
+local update_score = nil
+"""
+overwrite = true
+match_indent = true
+
+
+
+[[patches]]
+[patches.pattern]
+target = "functions/common_events.lua"
+pattern = """play_sound(sound, 0.8+percent*0.2, volume)"""
+position = "before"
+payload = """
+if update_score then
+    G.SCORE_DISPLAY_QUEUE = G.SCORE_DISPLAY_QUEUE or {}
+    table.remove(G.SCORE_DISPLAY_QUEUE, 1)
+    G.HUD:get_UIE_by_ID('chip_UI_count'):juice_up(0.3, 0.3)
+end
+"""
+overwrite = true
+match_indent = true
+
+
+[[patches]]
+[patches.pattern]
+target = 'functions/button_callbacks.lua'
+pattern = """  local new_chips_text = number_format(G.GAME.chips)"""
+position = "after"
+payload = """if G.SCORE_DISPLAY_QUEUE and G.SCORE_DISPLAY_QUEUE[1] then 
+    new_chips_text = number_format(G.SCORE_DISPLAY_QUEUE[1])
+    if G.GAME.chips_text ~= new_chips_text then
+        e.config.scale = math.min(0.8, scale_number(G.SCORE_DISPLAY_QUEUE[1], 1.1))
+        G.GAME.chips_text = new_chips_text
+    end
+    return
+end
+"""
+overwrite = true
+match_indent = true

lovely/score_mod.toml

@@ -810,3 +810,14 @@ function SMODS.get_card_type_text_colour(type, center, card) end
 ---@param key string
 ---@return table?
 function SMODS.get_badge_text_colour(key) end
+
+---Check if `challenge` is unlocked.
+---@param mod_score Score_Mod_Parameter Score modification parameter
+function SMODS.mod_score(mod_score) end
+
+---@class Score_Mod_Parameter
+---@field add? number Add this number to score
+---@field mult? number Multiply score by this number
+---@field card? Card Card responsible for score modification action, crucial for score display to work properly
+---@field effect? table Table of effects that were calculated
+---@field from_edition? boolean 

lsp_def/utils.lua

@@ -617,6 +617,7 @@ Set `prefix_config.key = false` on your object instead.]]):format(obj.key), obj.
     end
 
     SMODS.Sound{ key = 'xchips', path = 'xchips.ogg'}
+    SMODS.Sound{ key = 'xscore', path = 'xscore.ogg'}
 
     -------------------------------------------------------------------------------------------------
     ------- API CODE GameObject.Gradient

src/game_object.lua

@@ -1245,6 +1245,16 @@ SMODS.calculate_individual_effect = function(effect, scored_card, key, amount, f
         })
         return true
     end
+    if (key == 'xscore' or key == 'h_xscore' or key == 'x_score' or key == 'h_x_score') and amount ~= 1 then
+        if effect.card and effect.card ~= scored_card then juice_card(effect.card) end
+        SMODS.mod_score({ mult = amount, card = effect.message_card or effect.juice_card or scored_card or effect.card or effect.focus, effect = effect, from_edition = from_edition })
+        return true
+    end
+    if (key == 'score' or key == 'h_score') and amount ~= 0 then
+        if effect.card and effect.card ~= scored_card then juice_card(effect.card) end
+        SMODS.mod_score({ add = amount, card = effect.message_card or effect.juice_card or scored_card or effect.card or effect.focus, effect = effect, from_edition = from_edition })
+        return true
+    end
 
     if key == 'message' and not SMODS.no_resolve then
         if effect.card and effect.card ~= scored_card then juice_card(effect.card) end
@@ -1466,6 +1476,8 @@ SMODS.scoring_parameter_keys = {
 }
 SMODS.other_calculation_keys = {
     'p_dollars', 'dollars', 'h_dollars',
+    'score', 'h_score',
+    'xscore', 'x_score', 'h_x_score', 'h_xscore',
     'swap', 'balance',
     'saved', 'effect', 'remove',
     'debuff', 'prevent_debuff', 'debuff_text',
@@ -3126,6 +3138,18 @@ function SMODS.localize_perma_bonuses(specific_vars, desc_nodes)
     if specific_vars and specific_vars.bonus_h_dollars then
         localize{type = 'other', key = 'card_extra_h_dollars', nodes = desc_nodes, vars = {SMODS.signed_dollars(specific_vars.bonus_h_dollars)}}
     end
+    if specific_vars and specific_vars.perma_score then
+        localize{type = 'other', key = 'card_extra_score', nodes = desc_nodes, vars = {SMODS.signed(specific_vars.perma_score)}}
+    end
+    if specific_vars and specific_vars.perma_h_score then
+        localize{type = 'other', key = 'card_extra_h_score', nodes = desc_nodes, vars = {SMODS.signed(specific_vars.perma_h_score)}}
+    end
+    if specific_vars and specific_vars.perma_x_score then
+        localize{type = 'other', key = 'card_extra_x_score', nodes = desc_nodes, vars = {(specific_vars.perma_x_score)}}
+    end
+    if specific_vars and specific_vars.perma_h_x_score then
+        localize{type = 'other', key = 'card_extra_h_x_score', nodes = desc_nodes, vars = {(specific_vars.perma_h_x_score)}}
+    end
     if specific_vars and specific_vars.bonus_repetitions then
         localize{type = 'other', key = 'card_extra_repetitions', nodes = desc_nodes, vars = {specific_vars.bonus_repetitions, localize(specific_vars.bonus_repetitions > 1 and 'b_retrigger_plural' or 'b_retrigger_single')}}
     end
@@ -3578,4 +3602,47 @@ function SMODS.get_badge_text_colour(key)
     for k, v in pairs(SMODS.Seals) do
         if k:lower()..'_seal' == key and v.text_colour then return v.text_colour end
     end
+end
+-- function to modify score: normally accepts add and mult argument and additionally card argument
+SMODS.mod_score = function(score_mod)
+    score_mod = score_mod or {}
+    local score_fx = {}
+    local score_cal = score_mod.set or G.GAME.chips
+    local old = G.GAME.chips
+    G.SCORE_DISPLAY_QUEUE = G.SCORE_DISPLAY_QUEUE or {}
+    -- TARGET: higher priority score operation
+    if score_mod.mult then
+        local absoluted = math.abs(score_mod.mult)
+        score_cal = score_cal * score_mod.mult
+        table.insert(G.SCORE_DISPLAY_QUEUE, old)
+        score_fx[#score_fx+1] = {key = score_mod.mult < 0 and "a_xscore_minus" or "a_xscore", value = absoluted, sound = "xscore", message_key = "xscore_message"}
+    end
+    if score_mod.add and score_mod.add ~= 0 then
+        local absoluted = math.abs(score_mod.add)
+        score_cal = score_cal + score_mod.add
+        table.insert(G.SCORE_DISPLAY_QUEUE, old)
+        score_fx[#score_fx+1] = { key = "a_score", value = score_mod.add, sound = "gong", message_key = 'score_message'}
+    end
+    -- TARGET: lower priority score operation
+    G.GAME.chips = score_cal
+
+    if not (score_mod.effect and score_mod.effect.remove_default_message) and score_mod.card then
+        for _,v in ipairs(score_fx) do
+            if score_mod.from_edition then
+                card_eval_status_text(score_mod.card, 'jokers', nil, percent, nil, {message = localize{type = 'variable', key = v.key, vars = {v.value}}, update_score = true, colour = G.C.EDITION, edition = true, sound = v.sound, volume = 0.5 })
+            elseif score_mod.effect and score_mod.effect[v.message_key] then
+                score_mod.effect[v.message_key].update_score = true
+                card_eval_status_text(score_mod.card, 'extra', v.value, percent, nil, score_mod.effect[v.message_key])
+            else
+                card_eval_status_text(score_mod.card, 'jokers', nil, percent, nil, {message = localize{type='variable',key= v.key,vars={v.value}}, update_score = true, volume = 0.5, sound_override = v.sound, colour =  G.C.PURPLE})
+            end
+        end 
+        -- this check is in case some skip animation mods is there, may be removed in the future
+        if G.CARD_EVAL_TRIGGERED then
+            G.SCORE_DISPLAY_QUEUE = nil
+        end
+    elseif score_mod.effect then
+        score_mod.effect.update_score = true
+    end
+    delay(0.2)
 end