2024-10-27 20:34:05 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > WaveModulusRequirement | 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_requirements.html" > data/mystery-encounters/mystery-encounter-requirements< / a > < / li > < li > < a href = "data_mystery_encounters_mystery_encounter_requirements.WaveModulusRequirement.html" > WaveModulusRequirement< / a > < / li > < / ul > < h1 > Class WaveModulusRequirement< / h1 > < / div > < section class = "tsd-panel tsd-hierarchy" > < h4 > Hierarchy (< a href = "../hierarchy.html#data/mystery-encounters/mystery-encounter-requirements.WaveModulusRequirement" > view full< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li > < a href = "data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class = "tsd-signature-type tsd-kind-class" > EncounterSceneRequirement< / a > < ul class = "tsd-hierarchy" > < li > < span class = "target" > WaveModulusRequirement< / span > < / li > < / ul > < / li > < / ul > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/41380b39b950f9eeb49b31a48c0e7f5a25232de3/src/data/mystery-encounters/mystery-encounter-requirements.ts#L240" > src/data/mystery-encounters/mystery-encounter-requirements.ts:240< / a > < / li > < / ul > < / aside > < section class = "tsd-panel-group tsd-index-group" > < section class = "tsd-panel tsd-index-panel" > < details class = "tsd-index-content tsd-accordion" open > < summary class = "tsd-accordion-summary tsd-index-summary" > < h5 class = "tsd-index-heading uppercase" role = "button" aria-expanded = "false" tabIndex = "0" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-chevronSmall" > < / use > < / svg > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Constructors< / h3 > < div class = "tsd-index-list" > < a href = "data_mystery_encounters_mystery_encounter_requirements.WaveModulusRequirement.html#constructor" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a >
2024-09-27 21:52:07 +00:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "data_mystery_encounters_mystery_encounter_requirements.WaveModulusRequirement.html#modulusValue" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > modulus< wbr / > Value< / span > < / a >
< a href = "data_mystery_encounters_mystery_encounter_requirements.WaveModulusRequirement.html#waveModuli" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > wave< wbr / > Moduli< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "data_mystery_encounters_mystery_encounter_requirements.WaveModulusRequirement.html#getDialogueToken" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Dialogue< wbr / > Token< / span > < / a >
< a href = "data_mystery_encounters_mystery_encounter_requirements.WaveModulusRequirement.html#meetsRequirement" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > meets< wbr / > Requirement< / span > < / a >
< / 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-Constructors" > < h2 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Constructors< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < a id = "constructor" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > constructor< / span > < a href = "#constructor" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "constructor.new_WaveModulusRequirement" class = "tsd-anchor" > < / a > < span class = "tsd-kind-constructor-signature" > new < wbr / > Wave< wbr / > Modulus< wbr / > Requirement< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > waveModuli< / span > , < span class = "tsd-kind-parameter" > modulusValue< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "data_mystery_encounters_mystery_encounter_requirements.WaveModulusRequirement.html" class = "tsd-signature-type tsd-kind-class" > WaveModulusRequirement< / a > < a href = "#constructor.new_WaveModulusRequirement" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Used for specifying a modulus requirement on the wave index
For example, can be used to require the wave index to end with 1, 2, or 3< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > waveModuli< / span > : < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > The allowed modulus results< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < span > < span class = "tsd-kind-parameter" > modulusValue< / span > : < span class = "tsd-signature-type" > number< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > The modulus calculation value< / p >
< p > Example:
new WaveModulusRequirement([1, 2, 3], 10) will check for 1st/2nd/3rd waves that are immediately after a multiple of 10 wave
So waves 21, 32, 53 all return true. 58, 14, 99 return false.< / p >
2024-10-27 20:34:05 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "data_mystery_encounters_mystery_encounter_requirements.WaveModulusRequirement.html" class = "tsd-signature-type tsd-kind-class" > WaveModulusRequirement< / a > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Overrides < a href = "data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" > EncounterSceneRequirement< / a > .< a href = "data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/41380b39b950f9eeb49b31a48c0e7f5a25232de3/src/data/mystery-encounters/mystery-encounter-requirements.ts#L254" > src/data/mystery-encounters/mystery-encounter-requirements.ts:254< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / details > < 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 = "modulusValue" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > modulus< wbr / > Value< / span > < a href = "#modulusValue" 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" > modulus< wbr / > Value< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/41380b39b950f9eeb49b31a48c0e7f5a25232de3/src/data/mystery-encounters/mystery-encounter-requirements.ts#L242" > src/data/mystery-encounters/mystery-encounter-requirements.ts:242< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "waveModuli" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > wave< wbr / > Moduli< / span > < a href = "#waveModuli" 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" > wave< wbr / > Moduli< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/41380b39b950f9eeb49b31a48c0e7f5a25232de3/src/data/mystery-encounters/mystery-encounter-requirements.ts#L241" > src/data/mystery-encounters/mystery-encounter-requirements.ts:241< / a > < / li > < / ul > < / aside > < / section > < / section > < / details > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Methods" > < h2 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Methods< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < a id = "getDialogueToken" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > get< wbr / > Dialogue< wbr / > Token< / span > < a href = "#getDialogueToken" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "getDialogueToken.getDialogueToken-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > get< wbr / > Dialogue< wbr / > Token< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > scene< / span > , < span class = "tsd-kind-parameter" > pokemon< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > , < / span > < span class =
2024-09-27 21:52:07 +00:00
Should be overridden by child Requirement classes.< / p >
2024-10-27 20:34:05 +00:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > scene< / span > : < a href = "battle_scene.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / span > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > pokemon< / span > : < a href = "field_pokemon.PlayerPokemon.html" class = "tsd-signature-type tsd-kind-class" > PlayerPokemon< / a > < / span > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > , < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ]< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Overrides < a href = "data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" > EncounterSceneRequirement< / a > .< a href = "data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html#getDialogueToken" > getDialogueToken< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/41380b39b950f9eeb49b31a48c0e7f5a25232de3/src/data/mystery-encounters/mystery-encounter-requirements.ts#L264" > src/data/mystery-encounters/mystery-encounter-requirements.ts:264< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "meetsRequirement" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > meets< wbr / > Requirement< / span > < a href = "#meetsRequirement" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "meetsRequirement.meetsRequirement-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > meets< wbr / > Requirement< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > scene< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < a href = "#meetsRequirement.meetsRequirement-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Returns whether the EncounterSceneRequirement's... requirements, are met by the given scene< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > scene< / span > : < a href = "battle_scene.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Overrides < a href = "data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" > EncounterSceneRequirement< / a > .< a href = "data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html#meetsRequirement" > meetsRequirement< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/41380b39b950f9eeb49b31a48c0e7f5a25232de3/src/data/mystery-encounters/mystery-encounter-requirements.ts#L260" > src/data/mystery-encounters/mystery-encounter-requirements.ts:260< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / details > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-accordion" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < span class = "settings-label" > Member Visibility< / span > < ul id = "tsd-filter-options" > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-protected" name = "protected" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Protected< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Inherited< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-external" name = "external" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > External< / span > < / label > < / li > < / ul > < / div > < div class = "tsd-theme-toggle" > < label class = "settings-label" for = "tsd-theme" > Theme< / label > < select id = "tsd-theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / div > < / div > < / details > < / div > < details open class = "tsd-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "tsd-otp-Constructors" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Constructors< / summary > < div > < a href = "#constructor" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a > < / div > < / details > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data
