SMODS.Seal

API Documentation: SMODS.Seal

• Required parameters:
  • key,
  • loc_txt or localization entry (reference)
    • For use with localization file, the description should be set as descriptions.Other[key:lower()..'_seal'].
    • loc_txt should contain an additional label string. It is used on badges, while name is displayed at the top of info boxes. For use with localization files, this label should be set as misc.labels[key:lower()..'_seal'].
• Optional parameters (defaults):
  • atlas = 'Joker', pos = { x = 0, y = 0 } (reference)
  • config = {}, discovered = false, no_collection, prefix_config, dependencies, badge_colour, text_colour (reference)
    • Values in config are copied to card.ability.seal when the seal is applied to card.
  • badge_colour = HEX('FFFFFF')
  • sound = { sound = 'gold_seal', per = 1.2, vol = 0.4 }: The sound that should play when the seal is applied to a card.
    • sound: The key of the sound to play.
    • per: The pitch at which the sound should be played.
    • vol: The volume at which the sound should be played.
  • always_scores: If true, cards with this seal always count in scoring.
  • never_scores: If true, cards with this seal never count in scoring (supersedes always_scores).

API methods

• calculate(self, card, context) (reference)
• loc_vars, generate_ui (reference)
• get_p_dollars(self, card) -> number
  • Gives money when a card with this seal is played.
• update(self, card, dt)
  • For actions that happen every frame.
• draw(self, card, layer)
  • Draws the sprite and shader of the seal.

Seal methods

• Card:set_seal(seal, immediate, silent)
  • Use this function to set the seal of a card
    • edition, nil removes seal, key of seal as a string
    • immediate, boolean
    • silent, boolean