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

# Interface IEggOptions

Egg options to override egg properties

interface IEggOptions {
eggDescriptor ?: string;
eggMoveIndex ?: number;
hatchWaves ?: number;
id ?: number;
isShiny ?: boolean;
overrideHiddenAbility ?: boolean;
pulled ?: boolean;
scene ?: default ;
sourceType ?: EggSourceType ;
species ?: Species ;
tier ?: EggTier ;
timestamp ?: number;
variantTier ?: VariantTier ;
}

- Defined in src/data/egg.ts:45

##### Index

### Properties

eggDescriptor?
eggMoveIndex?
hatchWaves?
id?
isShiny?
overrideHiddenAbility?
pulled?
scene?
sourceType?
species?
tier?
timestamp?
variantTier?

## Properties

### `Optional` eggDescriptor

eggDescriptor?: string

Can customize the message displayed for where the egg was obtained

- Defined in src/data/egg.ts:83

### `Optional` eggMoveIndex

eggMoveIndex?: number

Defines which egg move will be unlocked. `3` = rare egg move.

- Defined in src/data/egg.ts:76

### `Optional` hatchWaves

hatchWaves?: number

Sets how many waves it will take till this egg hatches.

- Defined in src/data/egg.ts:68

### `Optional` id

id?: number

ID. Used to check if egg type will be manaphy (`id % 204 === 0`)

- Defined in src/data/egg.ts:47

### `Optional` isShiny

isShiny?: boolean

Defines if the hatched pokemon will be a shiny.

- Defined in src/data/egg.ts:72

### `Optional` overrideHiddenAbility

overrideHiddenAbility?: boolean

Defines if the egg will hatch with the hidden ability of this species. If no hidden ability exist, a random one will get choosen.

- Defined in src/data/egg.ts:81

### `Optional` pulled

pulled?: boolean

Defines if the egg got pulled from a gacha or not. If true, egg pity and pull statistics will be applied. Egg will be automaticly added to the game data.

- Defined in src/data/egg.ts:54

### `Optional` scene

scene?: default

Legacy field, kept for backwards-compatibility

- Defined in src/data/egg.ts:61

### `Optional` sourceType

sourceType?: EggSourceType

Defines where the egg comes from. Applies specific modifiers. Will also define the text displayed in the egg list.

- Defined in src/data/egg.ts:59

### `Optional` species

species?: Species

Sets the exact species that will hatch from this egg.

- Defined in src/data/egg.ts:70

### `Optional` tier

tier?: EggTier

Sets the tier of the egg. Only species of this tier can be hatched from this egg. Tier will be overriden if species `eggOption` is set.

- Defined in src/data/egg.ts:66

### `Optional` timestamp

timestamp?: number

Timestamp when this egg got created

- Defined in src/data/egg.ts:49

### `Optional` variantTier

variantTier?: VariantTier

Defines the variant of the pokemon that will hatch from this egg. If no `variantTier` is given the normal variant rates will apply.

- Defined in src/data/egg.ts:74