# getPlayerModifierTypeOptions | pokemon-rogue-battle
Documentation for pokemon-rogue-battle

# Function getPlayerModifierTypeOptions

- getPlayerModifierTypeOptions(
  count: number,
  party: PlayerPokemon [],
  modifierTiers?: ModifierTier [],
  customModifierSettings?: CustomModifierSettings ,
  ): ModifierTypeOption []

  Generates modifier options for a SelectModifierPhase

  #### Parameters

  - count: number

    Determines the number of items to generate

  - party: PlayerPokemon []

    Party is required for generating proper modifier pools

  - `Optional` modifierTiers: ModifierTier []

    (Optional) If specified, rolls items in the specified tiers. Commonly used for tier-locking with Lock Capsule.

  - `Optional` customModifierSettings: CustomModifierSettings

    (Optional) If specified, can customize the item shop rewards further.

    - `guaranteedModifierTypeOptions?: ModifierTypeOption[]` If specified, will override the first X items to be specific modifier options (these should be pre-genned).
    - `guaranteedModifierTypeFuncs?: ModifierTypeFunc[]` If specified, will override the next X items to be auto-generated from specific modifier functions (these don't have to be pre-genned).
    - `guaranteedModifierTiers?: ModifierTier[]` If specified, will override the next X items to be the specified tier. These can upgrade with luck.
    - `fillRemaining?: boolean` Default 'false'. If set to true, will fill the remainder of shop items that were not overridden by the 3 options above, up to the 'count' param value.
      - Example: `count = 4`, `customModifierSettings = { guaranteedModifierTiers: [ModifierTier.GREAT], fillRemaining: true }`,
      - The first item in the shop will be `GREAT` tier, and the remaining 3 items will be generated normally.
      - If `fillRemaining = false` in the same scenario, only 1 `GREAT` tier item will appear in the shop (regardless of `count` value).
    - `rerollMultiplier?: number` If specified, can adjust the amount of money required for a shop reroll. If set to a negative value, the shop will not allow rerolls at all.
    - `allowLuckUpgrades?: boolean` Default `true`, if `false` will prevent set item tiers from upgrading via luck

  #### Returns ModifierTypeOption []

  - Defined in src/modifier/modifier-type.ts:3304