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

# Interface IMysteryEncounter

Used by `MysteryEncounterBuilder` class to define required/optional properties on the `MysteryEncounter` class when building.

Should ONLY contain properties that are necessary for `MysteryEncounter` construction. Post-construct and flag data properties are defined in the `MysteryEncounter` class itself.

interface IMysteryEncounter {
autoHideIntroVisuals : boolean;
catchAllowed : boolean;
continuousEncounter : boolean;
dialogue : default ;
dialogueTokens : Record<string, string>;
disallowedChallenges ?: Challenges [];
disallowedGameModes ?: GameModes [];
doContinueEncounter ?: () => Promise<void>;
doEncounterExp ?: () => boolean;
doEncounterRewards ?: () => boolean;
encounterAnimations ?: EncounterAnim [];
encounterTier : MysteryEncounterTier ;
encounterType : MysteryEncounterType ;
enemyPartyConfigs : EnemyPartyConfig [];
enterIntroVisualsFromRight : boolean;
excludePrimaryFromSupportRequirements : boolean;
expMultiplier : number;
fleeAllowed : boolean;
hasBattleAnimationsWithoutTargets : boolean;
hideBattleIntroMessage : boolean;
maxAllowedEncounters : number;
onInit ?: () => boolean;
onVisualsStart ?: () => boolean;
options : [ default , default , ... default []];
preventGameStatsUpdates : boolean;
primaryPokemonRequirements : EncounterPokemonRequirement [];
requirements : EncounterSceneRequirement [];
secondaryPokemonRequirements : EncounterPokemonRequirement [];
skipEnemyBattleTurns : boolean;
skipToFightInput : boolean;
spriteConfigs : MysteryEncounterSpriteConfig [];
}

#### Implemented by

- default

- Defined in src/data/mystery-encounters/mystery-encounter.ts:50

##### Index

### Properties

autoHideIntroVisuals
catchAllowed
continuousEncounter
dialogue
dialogueTokens
disallowedChallenges?
disallowedGameModes?
doContinueEncounter?
doEncounterExp?
doEncounterRewards?
encounterAnimations?
encounterTier
encounterType
enemyPartyConfigs
enterIntroVisualsFromRight
excludePrimaryFromSupportRequirements
expMultiplier
fleeAllowed
hasBattleAnimationsWithoutTargets
hideBattleIntroMessage
maxAllowedEncounters
onInit?
onVisualsStart?
options
preventGameStatsUpdates
primaryPokemonRequirements
requirements
secondaryPokemonRequirements
skipEnemyBattleTurns
skipToFightInput
spriteConfigs

## Properties

### autoHideIntroVisuals

autoHideIntroVisuals: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:59

### catchAllowed

catchAllowed: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:61

### continuousEncounter

continuousEncounter: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:63

### dialogue

dialogue: default

- Defined in src/data/mystery-encounters/mystery-encounter.ts:81

### dialogueTokens

dialogueTokens: Record<string, string>

- Defined in src/data/mystery-encounters/mystery-encounter.ts:84

### `Optional` disallowedChallenges

disallowedChallenges?: Challenges []

- Defined in src/data/mystery-encounters/mystery-encounter.ts:57

### `Optional` disallowedGameModes

disallowedGameModes?: GameModes []

- Defined in src/data/mystery-encounters/mystery-encounter.ts:56

### `Optional` doContinueEncounter

doContinueEncounter?: () => Promise<void>

- Defined in src/data/mystery-encounters/mystery-encounter.ts:74

### `Optional` doEncounterExp

doEncounterExp?: () => boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:72

### `Optional` doEncounterRewards

doEncounterRewards?: () => boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:73

### `Optional` encounterAnimations

encounterAnimations?: EncounterAnim []

- Defined in src/data/mystery-encounters/mystery-encounter.ts:55

### encounterTier

encounterTier: MysteryEncounterTier

- Defined in src/data/mystery-encounters/mystery-encounter.ts:54

### encounterType

encounterType: MysteryEncounterType

- Defined in src/data/mystery-encounters/mystery-encounter.ts:51

### enemyPartyConfigs

enemyPartyConfigs: EnemyPartyConfig []

- Defined in src/data/mystery-encounters/mystery-encounter.ts:82

### enterIntroVisualsFromRight

enterIntroVisualsFromRight: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:60

### excludePrimaryFromSupportRequirements

excludePrimaryFromSupportRequirements: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:79

### expMultiplier

expMultiplier: number

- Defined in src/data/mystery-encounters/mystery-encounter.ts:85

### fleeAllowed

fleeAllowed: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:62

### hasBattleAnimationsWithoutTargets

hasBattleAnimationsWithoutTargets: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:65

### hideBattleIntroMessage

hideBattleIntroMessage: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:58

### maxAllowedEncounters

maxAllowedEncounters: number

- Defined in src/data/mystery-encounters/mystery-encounter.ts:64

### `Optional` onInit

onInit?: () => boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:70

### `Optional` onVisualsStart

onVisualsStart?: () => boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:71

### options

options: [ default , default , ... default []]

- Defined in src/data/mystery-encounters/mystery-encounter.ts:52

### preventGameStatsUpdates

preventGameStatsUpdates: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:68

### primaryPokemonRequirements

primaryPokemonRequirements: EncounterPokemonRequirement []

- Defined in src/data/mystery-encounters/mystery-encounter.ts:77

### requirements

requirements: EncounterSceneRequirement []

- Defined in src/data/mystery-encounters/mystery-encounter.ts:76

### secondaryPokemonRequirements

secondaryPokemonRequirements: EncounterPokemonRequirement []

- Defined in src/data/mystery-encounters/mystery-encounter.ts:78

### skipEnemyBattleTurns

skipEnemyBattleTurns: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:66

### skipToFightInput

skipToFightInput: boolean

- Defined in src/data/mystery-encounters/mystery-encounter.ts:67

### spriteConfigs

spriteConfigs: MysteryEncounterSpriteConfig []

- Defined in src/data/mystery-encounters/mystery-encounter.ts:53