Skip to content

API Documentation

DoctorWafflePhD edited this page Apr 25, 2026 · 5 revisions

Boss Jokers

Boss Jokers are matched to their corresponding Boss Blind through a key-value dictionary, stored in WaffleMod.bossJokerTable, where the key is the blind's key, and the value is the joker's key. For example, if your Boss Blind had the key bl_yourmod_fighter, and you wanted to make it drop a Joker with the key j_yourmod_fighter, you would add to the table like so -

WaffleMod.bossJokerTable[bl_yourmod_fighter] = "j_yourmod_fighter"

Jokers for Showdown/Finisher Blinds are also stored in this table.

Reference Jokers (Fuzzy Pickle)

To mark a joker as a pop-culture reference for compatibility with Fuzzy Pickle, simply give it an attribute named reference. This alone will make it functional.

-- somewhere in SMODS.Joker()
attributes = {"reference"}

While Fuzzy Pickle is held, Jokers that activate its effect (i.e. have the reference attribute) are given tooltips to indicate that they are a reference, as well as what they are a reference to. To add such a tooltip for your Joker, add a localization key in the Other descriptions set, where the key is r_ followed by your Joker's key. For example, to add a tooltip for a Joker with key j_yourmod_deltarune_joker -

descriptions = {
    Other = {
        r_j_yourmod_deltarune_joker = {
            name = "Reference", -- This is the same across all reference tooltips
            text = { "Deltarune" } -- Sub out "Deltarune" for whatever media your Joker is a reference to
        }
    }
}

If the reference attribute is present but a matching localization entry cannot be found, it will still be given a generic tooltip while Fuzzy Pickle is held to denote that it is compatible with Fuzzy Pickle.

Clone this wiki locally