pokerogue/main/interfaces/data_mystery_encounters_mys...

15 lines
26 KiB
HTML
Raw Permalink Normal View History

2024-09-27 22:52:07 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IMysteryEncounterOption | pokemon-rogue-battle</title><meta name="description" content="Documentation for pokemon-rogue-battle"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">pokemon-rogue-battle</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">pokemon-rogue-battle</a></li><li><a href="../modules/data_mystery_encounters_mystery_encounter_option.html">data/mystery-encounters/mystery-encounter-option</a></li><li><a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html">IMysteryEncounterOption</a></li></ul><h1>Interface IMysteryEncounterOption</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Used by <a href="../classes/data_mystery_encounters_mystery_encounter_option.MysteryEncounterOptionBuilder.html" class="tsd-kind-class"><code>MysteryEncounterOptionBuilder</code></a> class to define required/optional properties on the <a href="../classes/data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-kind-class"><code>MysteryEncounterOption</code></a> class when building.</p>
<p>Should ONLY contain properties that are necessary for <a href="../classes/data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-kind-class"><code>MysteryEncounterOption</code></a> construction.
Post-construct and flag data properties are defined in the <a href="../classes/data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-kind-class"><code>MysteryEncounterOption</code></a> class itself.</p>
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IMysteryEncounterOption</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#dialogue">dialogue</a><span class="tsd-signature-symbol">?: </span><a href="../classes/data_mystery_encounters_mystery_encounter_dialogue.OptionTextDisplay.html" class="tsd-signature-type tsd-kind-class">OptionTextDisplay</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#excludePrimaryFromSecondaryRequirements">excludePrimaryFromSecondaryRequirements</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#hasDexProgress">hasDexProgress</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#onOptionPhase">onOptionPhase</a><span class="tsd-signature-symbol">: </span><a href="../types/data_mystery_encounters_mystery_encounter_option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#onPostOptionPhase">onPostOptionPhase</a><span class="tsd-signature-symbol">?: </span><a href="../types/data_mystery_encounters_mystery_encounter_option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#onPreOptionPhase">onPreOptionPhase</a><span class="tsd-signature-symbol">?: </span><a href="../types/data_mystery_encounters_mystery_encounter_option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#optionMode">optionMode</a><span class="tsd-signature-symbol">: </span><a href="../enums/enums_mystery_encounter_option_mode.MysteryEncounterOptionMode.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterOptionMode</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#primaryPokemonRequirements">primaryPokemonRequirements</a><span class="tsd-signature-symbol">: </span><a href="../classes/data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#requirements">requirements</a><span class="tsd-signature-symbol">: </span><a href="../classes/data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterSceneRequirement</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mys
2024-09-27 22:52:07 +01:00
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#excludePrimaryFromSecondaryRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Primary<wbr/>From<wbr/>Secondary<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#hasDexProgress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Dex<wbr/>Progress</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#onOptionPhase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Option<wbr/>Phase</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#onPostOptionPhase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Post<wbr/>Option<wbr/>Phase?</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#onPreOptionPhase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Pre<wbr/>Option<wbr/>Phase?</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#optionMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>option<wbr/>Mode</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#primaryPokemonRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#requirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.IMysteryEncounterOption.html#secondaryPokemonRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a>
2024-11-18 18:42:56 +00:00
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="dialogue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>dialogue</span><a href="#dialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dialogue</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/data_mystery_encounters_mystery_encounter_dialogue.OptionTextDisplay.html" class="tsd-signature-type tsd-kind-class">OptionTextDisplay</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L28">src/data/mystery-encounters/mystery-encounter-option.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="excludePrimaryFromSecondaryRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exclude<wbr/>Primary<wbr/>From<wbr/>Secondary<wbr/>Requirements</span><a href="#excludePrimaryFromSecondaryRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">exclude<wbr/>Primary<wbr/>From<wbr/>Secondary<wbr/>Requirements</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L26">src/data/mystery-encounters/mystery-encounter-option.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hasDexProgress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Dex<wbr/>Progress</span><a href="#hasDexProgress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Dex<wbr/>Progress</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L22">src/data/mystery-encounters/mystery-encounter-option.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onOptionPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Option<wbr/>Phase</span><a href="#onOptionPhase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Option<wbr/>Phase</span><span class="tsd-signature-symbol">:</span> <a href="../types/data_mystery_encounters_mystery_encounter_option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L31">src/data/mystery-encounters/mystery-encounter-option.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onPostOptionPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Post<wbr/>Option<wbr/>Phase</span><a href="#on