SMODS.Attribute#
(Added in 1531zeebee)
Attributes are able to assigned to different center objects to allow for more advanced polling and effects that require certain attributes. SMODS provides an initial suite of attributes for the vanilla jokers, as well as a couple of empty ones for some scoring methods that the rest of the API provides.
Required parameters:
key: does not need to be unique - duplicate keys will be combined
Optional parameters (defaults):
keys: Provide a table of keys of centers that have this attributealias: Provide a table of keys of otherSMODS.Attributeobjects that should be treated as the same attribute
If you want to apply attributes in object definitions, add attributes = {'key1', 'key2', ...} to the definition.
Utility functions#
SMODS.get_attribute_pool(attribute) -> tableTakes a attribute key and returns a table of keys of centers that have that attribute
SMODS.add_attribute(attribute_key, object_keys)Inserts a table of keys into a pre-existing attribute
attribute_key: key of the attribute to insert intoobject_keys: table of keys of centers to insert into the attribute
Card:has_attribute(attribute_key)(added in 1606b)Blind:has_attribute(attribute_key)(added in 26.829.0)Tag:has_attribute(attribute_key)(added in 26.829.0)Checks whether the object has a certain attribute or not *(respects aliases)
attribute_key: key of the attribute to check
Provided Attributes#
Detailed here is a list of attributes that SMODS provides, along with a criteria for what objects should have them. Below is a list of all vanilla objects and which attributes they have been assigned.
SMODS Attributes#
Attribute Key |
When to use |
Vanilla Objects |
|---|---|---|
mult |
gives +mult at some point of scoring or causes other cards to do so |
Jokers |
chips |
gives +chips at some point of scoring or causes other cards to do so |
Jokers |
xmult |
gives Xmult at some point of scoring or causes other cards to do so |
Jokers |
xchips |
gives Xchips at some point of scoring or causes other cards to do so |
none |
score |
gives +score at some point of scoring or causes other cards to do so |
none |
xscore |
gives Xscore at some point of scoring or causes other cards to do so |
none |
blindsize |
gives +blindsize at some point of scoring or causes other cards to do so (added in 1606b) |
none |
xblindsize |
gives Xblindsize at some point of scoring or causes other cards to do so (added in 1606b) |
none |
balance |
balances mult and chips during scoring or causes other cards to do so (added in 1606b) |
none |
swap |
swaps mult and chips during scoring or causes other cards to do so (added in 1606b) |
none |
retrigger |
retriggers a card at some point of scoring |
Jokers |
scaling |
scales a value on a trigger |
Jokers |
perma_bonus |
grants any perma bonus on a trigger (added in 26.829.0) |
Hiker |
reset |
has a value that resets |
Jokers |
suit |
trigger is affected by a suit |
Jokers |
diamonds |
trigger is affected by diamonds |
Jokers |
hearts |
trigger is affected by hearts |
Jokers |
spades |
trigger is affected by spades |
Jokers |
clubs |
trigger is affected by clubs |
Jokers |
hand_type |
trigger is affected by a specific hand type |
Jokers |
hand_level |
effect upgrades or downgrades poker hands |
Jokers |
rank |
trigger is affected by a specific rank |
Jokers |
ace |
trigger is affected by aces |
Jokers |
two |
trigger is affected by 2s |
Jokers |
three |
trigger is affected by 3s |
Jokers |
four |
trigger is affected by 4s |
Jokers |
five |
trigger is affected by 5s |
Jokers |
six |
trigger is affected by 6s |
Jokers |
seven |
trigger is affected by 7s |
Jokers |
eight |
trigger is affected by 8s |
Jokers |
nine |
trigger is affected by 9s |
Jokers |
ten |
trigger is affected by 10s |
Jokers |
jack |
trigger is affected by Jacks |
Jokers |
queen |
trigger is affected by Queens |
Jokers |
king |
trigger is affected by Kings |
Jokers |
face |
trigger is affected by face cards |
Jokers |
economy |
effect is based around money |
Jokers |
lose_economy |
effect is based around losing money |
Consumables |
generation |
generates another object on a trigger |
Jokers |
shop |
effect is based around the shop (added in 26.829.0) |
Chaos the Clown, Flash Card, Astronomer |
booster |
effect is based around booster packs (added in 26.829.0) |
Red Card, Hallucination, Astronomer |
destroy_card |
destroys another card |
Jokers |
hands |
effect is based around hands |
Jokers |
discard |
effect is based around discards |
Jokers |
hand_size |
effect is based around hand size |
Jokers |
chance |
effect has a chance to happen |
Jokers |
consumable_slot |
related to Consumable slots (added in 26.829.0) |
none |
mod_chance |
affects other chance rolls |
Jokers |
copying |
copies the effect of another card |
Jokers |
full_deck |
effect is based on your full deck |
Jokers |
passive |
passive bonus from owning the card |
Jokers |
joker |
related to Joker cards |
Jokers |
consumable |
related to Consumable cards (added in 26.829.0) |
8 Ball, Superposition, Vagabond, Hallucination, Fortune Teller, Cartomancer, Astronomer, Constellation, Satellite, Sixth Sense, Séance, Perkeo |
joker_slot |
related to Joker slots |
Jokers |
rarity |
related to specific Joker rarities |
Jokers |
position |
affected by the position of cards |
Jokers |
tarot |
related to Tarot cards |
Jokers |
planet |
related to Planet cards |
Jokers |
spectral |
related to Spectral cards |
Jokers |
consumable |
related to any consumables |
Jokers |
consumable_slot |
related to consumable slots |
Vouchers |
playing_card |
effect adds playing cards to the deck |
JokersMarble Joker, DNA, Certificate |
enhancements |
related to enhancements |
Jokers |
seals |
related to seals |
Jokers |
editions |
related to editions (added in 1606b) |
Consumables |
tag |
related to tags (added in 1606b) |
Jokers |
skip |
effect linked to skipping blinds (added in 1606b) |
Jokers |
modify_card |
modifies playing cards |
Jokers |
perma_bonus |
permanently modifies the stats of cards (added in 1606b) |
Jokers |
prevents_death |
effect prevents losing a run |
Jokers |
boss_blind |
effect linked to boss blinds (added in 1606b) |
Jokers |
hand_level |
affects the level of poker hands (added in 26.829.0) |
Space Joker, Burnt Joker |
debuff |
causes cards or Jokers to be debuffed, or is affected by them |
Boss Blinds |
face_down |
causes cards or Jokers to be faced down, or is affected by them |
Boss Blinds |
large_blind |
causes a Blind to have a larger scoring requirement than default |
Boss Blinds |
ante |
effect changes the ante |
Vouchers |
shop |
related to the shop |
Jokers |
booster |
related to Booster Packs |
Jokers |
reroll |
effect is based around rerolling the shop |
Jokers |
on_sell |
triggers when card is sold |
Jokers |
sell_value |
effect is based around sell value of a card |
Jokers |
skip |
effect is based around skipping a blind (added in 26.829.0) |
Throwback |
tag |
effect is based around tags (added in 26.829.0) |
Diet Cola |
debuff |
effect is based around debuffing cards (added in 26.829.0) |
none |
position |
effect is based around card positioning (added in 26.829.0) |
Blueprint, Brainstorm, Ceremonial Dagger, Photograph, Hanging Chad |
boss_blind |
effect is based around boss blinds (added in 26.829.0) |
Rocket, Luchador, Matador, Campfire, Chicot |
food |
themed on food |
Jokers |
space |
themed on space |
Jokers |
Vanilla Object Attributes#
Vanilla Joker Attributes#
Joker Name |
Attributes |
|---|---|
Joker |
mult |
Greedy Joker |
mult, suit, diamonds |
Lusty Joker |
mult, suit, hearts |
Wrathful Joker |
mult, suit, spades |
Gluttonous Joker |
mult, suit, clubs |
Jolly Joker |
mult, hand_type |
Zany Joker |
mult, hand_type |
Mad Joker |
mult, hand_type |
Crazy Joker |
mult, hand_type |
Droll Joker |
mult, hand_type |
Sly Joker |
hand_type, chips |
Wily Joker |
hand_type, chips |
Clever Joker |
hand_type, chips |
Devious Joker |
hand_type, chips |
Crafty Joker |
hand_type, chips |
Half Joker |
mult |
Joker Stencil |
joker_slot, xmult |
Four Fingers |
hand_type, passive |
Mime |
retrigger |
Credit Card |
passive, economy |
Ceremonial Dagger |
mult, destroy_card, sell_value, scaling, position |
Banner |
discard, chips |
Mystic Summit |
mult, discard |
Marble Joker |
enhancements, generation, playing_card |
Loyalty Card |
xmult, hands |
8 Ball |
chance, eight, tarot, consumable, generation, rank |
Misprint |
mult |
Dusk |
retrigger, hands |
Raised Fist |
mult, rank |
Chaos the Clown |
reroll, passive, economy, shop |
Fibonacci |
three, mult, ace, eight, two, rank, five |
Steel Joker |
xmult, full_deck, enhancements |
Scary Face |
chips, face |
Abstract Joker |
mult, joker |
Delayed Gratification |
discard, economy |
Hack |
three, retrigger, four, two, rank, five |
Pareidolia |
modify_card, passive, face |
Gros Michel |
chance, mult, food |
Even Steven |
mult, ten, four, eight, two, six, rank |
Odd Todd |
three, ace, seven, chips, nine, rank, five |
Scholar |
mult, ace, chips, rank |
Business Card |
chance, face, economy |
Supernova |
mult, hand_type, space |
Ride the Bus |
mult, face, reset, scaling |
Space Joker |
chance, hand_type, hand_level, space |
Egg |
food, sell_value, scaling, economy |
Burglar |
discard, hands |
Blackboard |
xmult, suit, spades, clubs |
Runner |
hand_type, chips, scaling |
Ice Cream |
food, chips, scaling |
DNA |
generation, hands, playing_card |
Splash |
passive |
Blue Joker |
chips |
Sixth Sense |
spectral, consumable, six, generation, rank |
Constellation |
xmult, planet, consumable, space, scaling |
Hiker |
modify_card, chips, perma_bonus |
Faceless Joker |
discard, face, economy |
Green Joker |
mult, discard, scaling, hands |
Superposition |
ace, hand_type, tarot, consumable, generation, rank |
To Do List |
hand_type, economy |
Cavendish |
xmult, chance, food |
Card Sharp |
xmult, hand_type |
Red Card |
mult, scaling, booster |
Madness |
xmult, destroy_card, scaling |
Square Joker |
chips, scaling, hands |
Séance |
spectral, consumable, hand_type, generation |
Riff-Raff |
joker, generation |
Vampire |
xmult, modify_card, enhancements, scaling |
Shortcut |
hand_type, passive |
Hologram |
xmult, scaling |
Vagabond |
tarot, consumable, generation, hands |
Baron |
xmult, rank, king |
Cloud 9 |
full_deck, nine, rank, economy |
Rocket |
space, scaling, economy, boss_blind |
Obelisk |
xmult, hand_type, reset, scaling |
Rocket |
space, scaling, economy, boss_blind |
Obelisk |
xmult, hand_type, reset, scaling, hands |
Midas Mask |
modify_card, enhancements, face |
Luchador |
on_sell, boss_blind |
Photograph |
xmult, face |
Gift Card |
sell_value, economy |
Luchador |
on_sell, boss_blind |
Photograph |
xmult, face, position |
Gift Card |
sell_value, scaling, economy |
Turtle Bean |
food, hand_size, scaling |
Erosion |
mult, full_deck |
Reserved Parking |
chance, face, economy |
Mail-In Rebate |
discard, rank, economy |
To the Moon |
passive, economy |
Hallucination |
chance, tarot, consumable, generation, booster |
Fortune Teller |
mult, tarot |
Juggler |
hand_size, passive |
Drunkard |
discard, passive |
Stone Joker |
full_deck, enhancements, chips |
Golden Joker |
economy |
Lucky Cat |
xmult, enhancements, scaling |
Baseball Card |
xmult, joker, rarity |
Bull |
chips |
Diet Cola |
on_sell, food, generation, tag |
Trading Card |
destroy_card, discard, economy |
Flash Card |
mult, reroll, shop, scaling |
Popcorn |
mult, food, scaling |
Spare Trousers |
mult, hand_type, scaling |
Ancient Joker |
xmult, suit |
Ramen |
xmult, food, discard, scaling |
Walkie Talkie |
mult, ten, four, chips, rank |
Seltzer |
retrigger, food, scaling |
Castle |
suit, discard, chips, scaling |
Smiley Face |
mult, face |
Campfire |
xmult, reset, scaling, boss_blind |
Golden Ticket |
enhancements, economy |
Mr. Bones |
prevents_death |
Acrobat |
xmult, hands |
Sock and Buskin |
retrigger, face |
Swashbuckler |
mult, joker, sell_value |
Troubadour |
hand_size, passive, hands |
Certificate |
seals, generation |
Smeared Joker |
suit, hearts, passive, diamonds, spades, clubs |
Throwback |
xmult, scaling, skip |
Hanging Chad |
retrigger, position |
Rough Gem |
suit, diamonds, economy |
Bloodstone |
xmult, chance, suit, hearts |
Arrowhead |
suit, chips, spades |
Onyx Agate |
mult, suit, clubs |
Glass Joker |
xmult, enhancements, scaling |
Showman |
passive |
Flower Pot |
xmult, suit, hands |
Blueprint |
copying, position |
Wee Joker |
two, chips, rank, scaling |
Merry Andy |
hand_size, discard |
Oops! All 6s |
mod_chance, passive |
The Idol |
xmult, suit, rank |
Seeing Double |
xmult, suit, clubs |
Matador |
economy, boss_blind |
Hit the Road |
xmult, jack, discard, reset, rank, scaling |
The Duo |
xmult, hand_type |
The Trio |
xmult, hand_type |
The Family |
xmult, hand_type |
The Order |
xmult, hand_type |
The Tribe |
xmult, hand_type |
Stuntman |
hand_size, chips |
Invisible Joker |
on_sell, generation |
Brainstorm |
copying, position |
Satellite |
planet, consumable, space, economy |
Shoot the Moon |
mult, rank, queen |
Driver’s License |
xmult, full_deck, enhancements |
Cartomancer |
tarot, consumable, generation |
Astronomer |
planet, booster, consumable, passive, shop, space |
Burnt Joker |
hand_type, discard, hand_level |
Bootstraps |
mult |
Canio |
xmult, face, scaling |
Triboulet |
xmult, rank, queen, king |
Yorick |
xmult, discard, scaling |
Chicot |
boss_blind |
Perkeo |
generation, consumable |
Vanilla Consumable Attributes#
(added in 26.829.0)
Tarot Name |
Attributes |
|---|---|
The Fool |
generation, tarot, planet, consumable |
The Magician |
enhancements, modify_card |
The High Priestess |
generation, planet, consumable |
The Empress |
enhancements, modify_card |
The Emperor |
generation, tarot, consumable |
The Hierophant |
enhancements, modify_card |
The Lovers |
enhancements, modify_card |
The Chariot |
enhancements, modify_card |
Justice |
enhancements, modify_card |
The Hermit |
economy |
The Wheel of Fortune |
joker, editions, chance |
Strength |
modify_card, rank |
The Hanged Man |
destroy_card |
Death |
modify_card, position |
Temperance |
economy, joker, sell_value |
The Devil |
enhancements, modify_card |
The Tower |
enhancements, modify_card |
The Star |
modify_card, suit, diamonds |
The Moon |
modify_card, suit, clubs |
The Sun |
modify_card, suit, hearts |
Judgement |
generation, joker |
The World |
modify_card, suit, spades |
Planet Name |
Attributes |
|---|---|
All vanilla Planet Cards |
hand_type, hand_level, space |
Spectral Name |
Attributes |
|---|---|
Familiar |
generation, rank, jack, queen, king, face, playing_card, destroy_card, enhancements |
Grim |
generation, rank, ace, playing_card, destroy_card, enhancements |
Incantation |
generation, rank, two, three, four, five, six, seven, eight, nine, ten, playing_card, destroy_card, enhancements |
Talisman |
modify_card, seals |
Aura |
modify_card, editions |
Wraith |
generation, joker, rarity, lose_economy |
Sigil |
modify_card, suit |
Ouija |
modify_card, rank, hand_size |
Ectoplasm |
joker, editions, hand_size |
Immolate |
destroy_card, economy |
Ankh |
generation, joker, destroy_card |
Deja Vu |
modify_card, seals |
Ectoplasm |
joker, editions, destroy_card |
Trance |
modify_card, seals |
Medium |
modify_card, seals |
Cryptid |
generation, playing_card |
The Soul |
none |
Black Hole |
none |
(The Soul and Black Hole don’t have attributes yet because the system doesn’t yet support soulable objects.)
Vanilla Booster Pack Attributes#
(added in 26.829.0)
Booster Pack Name |
Attributes |
|---|---|
Arcana Pack |
tarot |
Celestial Pack |
planet |
Standard Pack |
playing_card |
Buffoon Pack |
joker |
Spectral Pack |
spectral |
Vanilla Voucher Attributes#
(added in 26.829.0)
Voucher Name |
Attributes |
|---|---|
Overstock |
shop |
Overstock Plus |
shop |
Clearance Sale |
shop, economy, sell_value |
Liquidation |
shop, economy, sell_value |
Hone |
editions |
Glow Up |
editions |
Reroll Surplus |
shop, economy, reroll |
Reroll Glut |
shop, economy, reroll |
Crystal Ball |
consumable_slot |
Omen Globe |
spectral, booster |
Telescope |
planet, booster, hand_type |
Observatory |
xmult, planet, hand_type |
Grabber |
hands |
Nacho Tong |
hands |
Wasteful |
discard |
Recyclomancy |
discard |
Tarot Merchant |
shop, tarot, consumable |
Tarot Tycoon |
shop, tarot, consumable |
Planet Merchant |
shop, planet, consumable |
Planet Tycoon |
shop, planet, consumable |
Seed Money |
economy |
Money Tree |
economy |
Blank |
none |
Antimatter |
joker_slot |
Magic Trick |
playing_card |
Illusion |
playing_card, enhancements, editions, seals |
Hieroglyph |
ante, hands |
Petroglyph |
ante, discard |
Director’s Cut |
boss_blind |
Retcon |
boss_blind |
Paint Brush |
hand_size |
Palette |
hand_size |
Vanilla Tag Attributes#
(added in 26.829.0)
Tag Name |
Attributes |
|---|---|
Uncommon Tag |
generation, joker, rarity |
Rare Tag |
generation, joker, rarity |
Negative Tag |
joker, editions |
Foil Tag |
joker, editions |
Holographic Tag |
joker, editions |
Polychrome Tag |
joker, editions |
Investment Tag |
economy, boss_blind |
Voucher Tag |
shop |
Boss Tag |
boss_blind |
Standard Tag |
booster |
Charm Tag |
booster |
Meteor Tag |
booster |
Buffoon Tag |
booster |
Handy Tag |
economy, hands |
Garbage Tag |
economy, discard |
Ethereal Tag |
booster |
Coupon Tag |
economy, shop |
Double Tag |
generation, tag |
Juggle Tag |
hand_size |
D6 Tag |
economy, shop, reroll |
Top-up Tag |
generation, joker, rarity |
Speed Tag |
economy, skip |
Orbital Tag |
hand_level |
Economy Tag |
economy |
Vanilla card modifier Attributes#
(added in 26.829.0)
Enhancement Name |
Attributes |
|---|---|
Bonus Card |
chips |
Mult Card |
mult |
Wild Card |
suit |
Glass Card |
xmult, chance, destroy_card |
Steel Card |
xmult |
Stone Card |
chips |
Gold Card |
economy |
Lucky Card |
mult, economy, chance |
Edition Name |
Attributes |
|---|---|
Foil |
chips |
Holographic |
mult |
Polychrome |
xmult |
Negative |
joker_slot |
Seal Name |
Attributes |
|---|---|
Red Seal |
retrigger |
Blue Seal |
generation, planet, consumable |
Gold Seal |
economy |
Purple Seal |
generation, tarot, consumable, discard |
Vanilla Blind Attributes#
(added in 26.829.0)
Blind Name |
Attributes |
|---|---|
Small Blind |
none |
Big Blind |
none |
The Hook |
discard |
The Ox |
lose_economy, hand_type |
The House |
face_down |
The Wall |
large_blind |
The Wheel |
face_down, chance |
The Arm |
hand_level |
The Club |
debuff, suit, clubs |
The Fish |
face_down |
The Psychic |
none |
The Goad |
debuff, suit, spades |
The Water |
discard |
The Window |
debuff, suit, diamonds |
The Manacle |
hand_size |
The Eye |
hand_type |
The Mouth |
hand_type |
The Plant |
debuff, face |
The Serpent |
none |
The Pillar |
debuff |
The Needle |
hands |
The Head |
debuff, suit, hearts |
The Tooth |
lose_economy |
The Flint |
none |
The Mark |
face_down, face |
Amber Acorn |
face_down, joker |
Verdant Leaf |
debuff, on_sell |
Violet Vessel |
large_blind |
Crimson Heart |
debuff, joker |
Cerulean Bell |
none |