Using Provided Counters

Provided Counters

The API mod provides 14 Counters when installed. Internally, these counters are divided up in 4 categories:

• Score Counters, which are counters that directly contribute to score in a positive way
• Beneficial Counters, which are counters that provide a (generally) positive effect, but do not directly contribute to score.
• Detrimental Counters, which are counters that provide a negative effect to the player.
• Status Effect Counters, which are counters that provide a negative effect to the player that is themed around some common trope from video games or an elemental affliction.

---

The currently provided counters are:

Score Counters (3 Counters):

• Mult Counters (counter_mult) - +1 Mult per Counter. Ticks down by 1.
• Chip Counters (counter_chip) - +5 Chips per Counter. Ticks down by 1.
• xMult Counters (counter_xmult) - x0.1 Mult per Counter. Ticks down by 1.

Beneficial Counters (3 Counters):

• Retrigger Counters (counter_retrigger) - Retrigger once per Counter. Ticks down by 1 (Only available if Joker retriggers are enabled)
• Investment Counters (counter_investment) - Lose $1 per Counter when applied. Earn $1 per Counter. Ticks down by 1.
• Money Counters (counter_money) - Earn $1 per Counter. Ticks down by 1.

Detrimental Counters (3 Counters):

• Poison Counters (counter_poison) - Lose 5% of current Mult and Chips per Counter. Ticks down by 1.
• Stun Counters (counter_stun) - Card is debuffed while it has any Counters. Ticks down by 1 each Hand.
• Debt Counters (counter_debt) - Lose $1 per Counter. Ticks down by 1.

Status Effect Counters (6 Counters):

• Burn Counters (counter_burn) - 1 in 10 chance to self Destruct per Counter. Ticks up by 1.
• Frost Counters (counter_frost) - Halves given score while this has any Counters. Ticks Down by 1.
• Paralysis Counters (counter_paralysis) - 1 in 10 chance to not trigger per Counter. Ticks down by 1.
• Drowsy Counters (counter_drowsy) - 1 in 10 chance per Counter to convert all Counters into Sleep Counters. Ticks up by 1.
• Sleep Counters (counter_sleep) - Card is debuffed while it has any Counters. Ticks down by 1 each Hand. 1 in Total Counters chance to clear all Counters.

Using Counters in your Mod.

Counters handle all their behaviour by themselves. To apply a counter, use the Card:bb_counter_apply() function

function Card:bb_counter_apply(counter_type, number, no_override)

• Card should be an existing card object
• Counter_type should be a string with the key for the specific Counter you want to apply.
• Number is the number of initial counters you wish to apply
• no_override (false by default) will disallow the new counter from overriding any existing counters

To increment counters from an external source:

function Card:bb_increment_counter(number)

• Card should be an existing card object. This function will do nothing if the object has no Counters on it.
• number is the number of counters that should be incremented by

To remove counters from an external source:

function Card:bb_remove_counter(removal_method)

• Card should be an existing card object. This function will do nothing if the object has no Counters on it.
• removal_method is nil by default.