Scenarios

scenarioBook = {
  -- The scenario book to use
  name = "Gloomhaven",
  -- The page that will be opened inside the book
  page = 3,
  -- If 2 pages should be shown, set this value as well
  pageCount = 2,
}

local scenario = {
  sectionBook = {
    -- the tag on the section book object
    name = "Gloomhaven",
    -- The list of sections that should be used for this scenario
    -- Determines which buttons will be shown and which pages will spawn
    sections = {
      -- the id values is the value shown in the button
      { id = "2A" },
      { id = "2B" },
      { id = "3A" },
    }
  }
}

local scenario = {
  monsters = {
    -- the name of the monster as the key
    ["Bandit Guard"] = {
      all = {
        -- settings applied to all Bandit Guards
      },
      normal = {
        -- settings additionally applied to all normal Bandit Guards
      },
      elite = {
        -- settings additionally applied to all elite Bandit Guards
      }
    },
    -- another monster
    ["Bandit Archer"] = {
      -- same structure as above
    }
  }
  -- rest of scenario definition
}

all = {
  -- The ability deck to use. If not used it will use the monsters default
  -- ability deck
  abilityDeck = "Archer",
  -- A modifier that should be applied to the current scenario level.
  -- This will make the monsters stronger/weaker. It can be a Formula.
  levelModifier = 1,
  -- The current HP value for the monster. If hpMax is not used, this is also
  -- the maximum HP value.
  -- It can be a Formula. Use the variable "H" or "this" to reference the
  -- default HP value for this monster.
  hp = { "+", "H", 3 },
  -- The maximum HP value for the monster.
  -- It can be a Formula. Use the variable "H" or "this" to reference the
  -- default maximum HP value for this monster.
  hpMax = { "+", "this", 3 },
  -- Adjusted stats for the monster
  stats = {
    -- Adjusted immunities
    immunities = {
      -- Immunities that will be added to the monster.
      add = { "Stun", "Muddle", "Poison" },
      -- Immunities that will be removed from the monster.
      remove = { "Curse" },
    },
    attributes = {
      -- Attributes that will be added to the monster. If the monster already
      -- has the attribute, it will be overwritten with this definition.
      -- The format is the same as for general Stats.
      -- The values currently can not be Formula, only fixed values.
      add = {
        "Muddle",
        Pierce = 3,
        Retaliate = {
          value = 2,
          range = 2,
        },
      },
      -- Attributes that will be removed from the monster.
      remove = { "Shield", "Wound" },
    },
    -- The adjusted attack value. Can be a formula, where the variable "this"
    -- refers to the default attack value for this monster (at its current
    -- level).
    attack = { "+", "this", 1 },
    range = { "+", "this", 1 },
    -- The adjusted move value. Can be a formula, where the variable "this"
    -- refers to the default move value for this monster (at its current
    -- level).
    move = {
      type = "Flying",
    },
    -- The text that will show below the monster.
    text = "New Text",
  }
}

local scenario = {
  monsters = {
    ["Bandit Guard"] = {
      all = {
        stats = {
          immunities = { add = { "Poison" } }, }
      },
      elite = {
        stats = {
          immunities = { add = { "Wound" } },
        },
        attributes = { add = { "Muddle" } },
      }
    }
  },
  rooms = {
    [1] = {
      monsters = {
        {
          name = "Bandit Guard",
          tiles = {
            {
              -- This Bandit Guard will get the Position immunity from all
              numCharacters = { [2] = Scenario.MonsterLevel.Normal },
            },
            {
              -- This Bandit Guard will get the Wound immunity from elite
              -- and the Muddle attack effect from elite.
              -- The immunity from all is overwritten by the immunities from
              -- elite
              numCharacters = { [2] = Scenario.MonsterLevel.Elite },
            },
            {
              -- This Bandit Guard will get the Muddle attack effect from elite
              -- and a Stun immunity from its own definition.
              -- The immunities from all and elite are overwritten by its own
              -- definition
              numCharacters = { [2] = Scenario.MonsterLevel.Elite },
              stats = {
                immunities = { add = { "Stun" } },
              },
            },
          }
        }
      }
    }
  }
}

local scenario = {
  -- can be defined on the top level
  extraContent = {
    -- one entry
    {
      -- The name of the registered extra component
      name = "Extra Stuff",
      -- The position where the content will spawn
      position = { 10, 2, 10 },
    },
    -- a second entry
    {
      -- ..
    },
  },
  rooms = {
    [2] = {
      -- Or as part of a room
      extraContent = {
        {
          name = "More Extra Stuff",
          position = { 10, 2, 10 },
        }
      }
    }
  }
}

-- The Bandit Guards use the Archer ability deck instead of their own Guard deck
local scenario = {
  monsters = {
    ["Bandit Guard"] = {
      all = {
        abilityDeck = "Archer"
      }
    }
  }
}

local scenario = {
  -- This will be placed together with the scenario
  extraContent = {
    {
      name = "Extra Stuff",
      position = { 10, 2, 10 },
    }
  },
  rooms = {
    [2] = {
      -- This will be placed, once the room 2 will be opened
      extraContent = {
        {
          name = "More Extra Stuff",
          position = { 10, 2, 10 },
        }
      }
    }
  }
}