pack

Description

In a pack event, the user is shown a number of booster packs. After clicking one of them, they obtain all of the cards from that pack.
This event makes use of pack.json to store the list of cards possible to obtain in that pack.

Specific Attributes

All attributes for pack events are optional.

• shows (Integer)
• The number of cards in each pack.
• This will override the shows Attribute in pack.json.
• This does not mutate the data in pack.json - Any other pick/pack events that use the same Object from pack.json are unaffected.
• composes (Array of packIDs)
• A list of packs which are also included in this pack.
• Those packs will be shuffled into this pack's pool.
• enforceHighland (Boolean)
• If true, only 1 of each card from the pack's pool will be in the booster pack.
• If false, it will be possible to obtain multiple copies of a card, if at least 2 exist in the pack's pool.
• removeRedundant (Boolean)
• If true, cards which the player already has the maximum legal number of copies of will not appear in the pack.
• If false, it will be possible to obtain more than the maximum legal number of copies of a card from that pack.
• extendWithSearch (Array of Key-Value pairs)
• You can use this Attribute to add cards to the copy of the pack that is being opened.
• Example: [ {level:1, type:beast} ] . This example would add all level 1 monsters and all beast monsters in the campaign to that copy of the pack being opened.
• This does not mutate the data in pack.json - Any other pick/pack events that use the same Object from pack.json are unaffected.
• shrinkFromSearch (Array of Cardnames)
• You can use this Attribute to remove cards from the copy of the pack that is being opened.
• Example: [ "Red Gadget", "Green Gadget", "Yellow Gadget" ]. This example would remove the gadgets from that copy of the pack being opened.
• This does not mutate the data in pack.json - Any other pick/pack events that use the same Object from pack.json are unaffected.
• When opening a pack, shrinkFromSearch happens after extendWithSearch.

Example

        events.json
        "pack": {
            "attribute": {}   This corresponds to a pack with "type":"attribute" in pack.json.
                              Other than audio, background images, etc, no attributes are required for this event to function.
        }
      

---

extendWithSearch and shrinkFromSearch

You can use these Attributes to add/remove cards from the copy of the pack that is being opened.

• This does not mutate the data in pack.json - Any other pick/pack events that use the same Object from pack.json are unaffected.
• shrinkFromSearch happens after extendWithSearch.

        "name":       Complete Cardname,        eg "Celtic Guardian".
        "type":       Complete CardType,        eg "Effect Monster", "Spell Card".  Note that "Effect Monster" will not match an "Effect Tuner Monster" etc.
        "frameType":  The Type of Card Frame,   eg "effect", "spell", "synchro", "pendulum_xyz"
        "atk":        The Exact ATK value,      eg 1100.
        "def":        The Exact DEF value,      eg 1200.
        "level":      The Exact Level/Rank,     eg 1. Note that Levels and Ranks are both treated as "level", but linkval is not.
        "linkval":    A Link Monster's Linkval  eg 2.
        "scale":      A Pend Monster's Scale    eg 3.
        "race":       The Monster Type,         eg "Fish"
        "attribute":  The Card Attribute,       eg "WATER", "SPELL".
        "banlist":    The Banlist Status,       eg 0, 1, 2, 3, 4 (cards have banlist:3 by default).
        "rarity":     The name of the card's rarity, as specified by you in your Settings.json file. EG "Shiny".
        "tag":        The name of the card's tag, as specified by you in your Settings.json file. EG "searchers".
      

You can add "<", "<=", ">", ">=" operators after the key to widen the search. For example, the following will search for cards with level/rank 4 or lower. This will also coerce all strings into integers, so it will work with tags like "2" (but not eg "level_2").

{"level<=":"4"}

Example

      pack.json
      {
        "booster": {
            "shows": 10,
            "card": [
                "Number 1: Numeron Gate Ekam",
                "Number 2: Numeron Gate Dve",
                "Number 3: Numeron Gate Trini"
            ]
        },
    
        "justRedGadget": {
            "card": [
                "Red Gadget"
            ]
        }
      }
  
      events.json
      "pack": {
  
        "shrink_example": {    
          "mdesc": "Shrinking from Search",
          "micon": "single.webp", 
          "composes": ["booster"],  All cards from the "booster" pack will appear....
          "shrinkFromSearch": [     ...except for these, even though they are in the events.json card list.
              {"name": "Number 2: Numeron Gate Dve"  },
              {"name": "Number 3: Numeron Gate Trini"},
          ]
        },
  
        "extend_example": {    
            "mdesc": "Extending with Search",
            "micon": "single.webp", 
            "composes": ["booster"],  All cards from the "booster" pack will appear....
            "extendWithSearch": [     Even Red Gadget, even though it's not in the events.json card list.
                {"name": "Red Gadget"}Note that there still needs to be a pack somewhere in pack.json, even if unused ("justRedGadget", above), that includes Red Gadget, for the App to recognize the card.
            ]
        }
  
      }