2024-08-17 18:01:18 +01:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > ClassicModeHelper | 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/test_utils_helpers_classicModeHelper.html" > test/utils/helpers/classicModeHelper< / a > < / li > < li > < a href = "test_utils_helpers_classicModeHelper.ClassicModeHelper.html" > ClassicModeHelper< / a > < / li > < / ul > < h1 > Class ClassicModeHelper< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > Helper to handle classic mode specifics< / p >
2024-10-28 13:03:40 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / section > < section class = "tsd-panel tsd-hierarchy" > < h4 > Hierarchy (< a href = "../hierarchy.html#test/utils/helpers/classicModeHelper.ClassicModeHelper" > view full< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li > < a href = "test_utils_helpers_gameManagerHelper.GameManagerHelper.html" class = "tsd-signature-type tsd-kind-class" > GameManagerHelper< / a > < ul class = "tsd-hierarchy" > < li > < span class = "target" > ClassicModeHelper< / span > < / li > < / ul > < / li > < / ul > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/b4cc9d7892a7d8b548c857f3acca40d5cf5defba/src/test/utils/helpers/classicModeHelper.ts#L16" > src/test/utils/helpers/classicModeHelper.ts:16< / 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 = "test_utils_helpers_classicModeHelper.ClassicModeHelper.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-08-17 18:01:18 +01:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "test_utils_helpers_classicModeHelper.ClassicModeHelper.html#game" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > game< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "test_utils_helpers_classicModeHelper.ClassicModeHelper.html#runToSummon" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > run< wbr / > To< wbr / > Summon< / span > < / a >
2024-09-01 23:17:02 +01:00
< a href = "test_utils_helpers_classicModeHelper.ClassicModeHelper.html#startBattle" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > start< wbr / > Battle< / span > < / a >
2024-10-28 13:03:40 +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-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_ClassicModeHelper" class = "tsd-anchor" > < / a > < span class = "tsd-kind-constructor-signature" > new < wbr / > Classic< wbr / > Mode< wbr / > Helper< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > game< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "test_utils_helpers_classicModeHelper.ClassicModeHelper.html" class = "tsd-signature-type tsd-kind-class" > ClassicModeHelper< / a > < a href = "#constructor.new_ClassicModeHelper" 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-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > game< / span > : < a href = "test_utils_gameManager.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "test_utils_helpers_classicModeHelper.ClassicModeHelper.html" class = "tsd-signature-type tsd-kind-class" > ClassicModeHelper< / a > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "test_utils_helpers_gameManagerHelper.GameManagerHelper.html" > GameManagerHelper< / a > .< a href = "test_utils_helpers_gameManagerHelper.GameManagerHelper.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/b4cc9d7892a7d8b548c857f3acca40d5cf5defba/src/test/utils/helpers/gameManagerHelper.ts#L9" > src/test/utils/helpers/gameManagerHelper.ts:9< / 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 tsd-is-protected tsd-is-inherited" > < a id = "game" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < code class = "tsd-tag" > Readonly< / code > < span > game< / span > < a href = "#game" 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" > game< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "test_utils_gameManager.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "test_utils_helpers_gameManagerHelper.GameManagerHelper.html" > GameManagerHelper< / a > .< a href = "test_utils_helpers_gameManagerHelper.GameManagerHelper.html#game" > game< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/b4cc9d7892a7d8b548c857f3acca40d5cf5defba/src/test/utils/helpers/gameManagerHelper.ts#L7" > src/test/utils/helpers/gameManagerHelper.ts:7< / 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 = "runToSummon
2024-08-17 18:01:18 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > species< / span > : < a href = "../enums/enums_species.Species.html" class = "tsd-signature-type tsd-kind-enum" > Species< / a > < span class = "tsd-signature-symbol" > []< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > Optional array of species to summon.< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > A promise that resolves when the summon phase is reached.< / p >
2024-10-28 13:03:40 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/b4cc9d7892a7d8b548c857f3acca40d5cf5defba/src/test/utils/helpers/classicModeHelper.ts#L23" > src/test/utils/helpers/classicModeHelper.ts:23< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "startBattle" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > start< wbr / > Battle< / span > < a href = "#startBattle" 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 = "startBattle.startBattle-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > start< wbr / > Battle< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > species< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#startBattle.startBattle-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 > Transitions to the start of a battle.< / p >
2024-09-01 23:17:02 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > species< / span > : < a href = "../enums/enums_species.Species.html" class = "tsd-signature-type tsd-kind-enum" > Species< / a > < span class = "tsd-signature-symbol" > []< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > Optional array of species to start the battle with.< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > A promise that resolves when the battle is started.< / p >
2024-10-28 13:03:40 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/b4cc9d7892a7d8b548c857f3acca40d5cf5defba/src/test/utils/helpers/classicModeHelper.ts#L49" > src/test/utils/helpers/classicModeHelper.ts:49< / 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-key = "tsd-otp-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Properties< / summary > < div > < a href = "#game" class = "tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > game< / span > < / a > < / div > < / details > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "tsd-otp-Methods" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Methods< / summary > < div > < a href = "#runToSummon" class = "" > < svg class = "t