2024-09-28 19:20:28 +01:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > TurnStartPhase | 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/phases_turn_start_phase.html" > phases/turn-start-phase< / a > < / li > < li > < a href = "phases_turn_start_phase.TurnStartPhase.html" > TurnStartPhase< / a > < / li > < / ul > < h1 > Class TurnStartPhase< / h1 > < / div > < section class = "tsd-panel tsd-hierarchy" > < h4 > Hierarchy (< a href = "../hierarchy.html#phases/turn-start-phase.TurnStartPhase" > view full< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li > < a href = "phases_field_phase.FieldPhase.html" class = "tsd-signature-type tsd-kind-class" > FieldPhase< / a > < ul class = "tsd-hierarchy" > < li > < span class = "target" > TurnStartPhase< / span > < / li > < / ul > < / li > < / ul > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/357056ebebf8893c797cd72ef36877756b89a28b/src/phases/turn-start-phase.ts#L24" > src/phases/turn-start-phase.ts:24< / 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 = "phases_turn_start_phase.TurnStartPhase.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-01 23:17:02 +01:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "phases_turn_start_phase.TurnStartPhase.html#scene" 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 > scene< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "phases_turn_start_phase.TurnStartPhase.html#end" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > end< / span > < / a >
< a href = "phases_turn_start_phase.TurnStartPhase.html#executeForAll" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > execute< wbr / > For< wbr / > All< / span > < / a >
2024-09-10 23:07:25 +01:00
< a href = "phases_turn_start_phase.TurnStartPhase.html#getCommandOrder" 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 / > Command< wbr / > Order< / span > < / a >
< a href = "phases_turn_start_phase.TurnStartPhase.html#getSpeedOrder" 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 / > Speed< wbr / > Order< / span > < / a >
2024-09-01 23:17:02 +01:00
< a href = "phases_turn_start_phase.TurnStartPhase.html#hideEnemyTrainer" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > hide< wbr / > Enemy< wbr / > Trainer< / span > < / a >
< a href = "phases_turn_start_phase.TurnStartPhase.html#showEnemyTrainer" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > show< wbr / > Enemy< wbr / > Trainer< / span > < / a >
< a href = "phases_turn_start_phase.TurnStartPhase.html#start" 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< / span > < / a >
2024-09-28 19:20:28 +01: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_TurnStartPhase" class = "tsd-anchor" > < / a > < span class = "tsd-kind-constructor-signature" > new < wbr / > Turn< wbr / > Start< wbr / > Phase< / 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 > < a href = "phases_turn_start_phase.TurnStartPhase.html" class = "tsd-signature-type tsd-kind-class" > TurnStartPhase< / a > < a href = "#constructor.new_TurnStartPhase" 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" > 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 < a href = "phases_turn_start_phase.TurnStartPhase.html" class = "tsd-signature-type tsd-kind-class" > TurnStartPhase< / a > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "phases_field_phase.FieldPhase.html" > FieldPhase< / a > .< a href = "phases_field_phase.FieldPhase.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/357056ebebf8893c797cd72ef36877756b89a28b/src/phases/turn-start-phase.ts#L25" > src/phases/turn-start-phase.ts:25< / 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 = "scene" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < span > scene< / span > < a href = "#scene" 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" > scene< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "battle_scene.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "phases_field_phase.FieldPhase.html" > FieldPhase< / a > .< a href = "phases_field_phase.FieldPhase.html#scene" > scene< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/357056ebebf8893c797cd72ef36877756b89a28b/src/phase.ts#L4" > src/phase.ts:4< / 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 tsd-is-inherited" > < a id = "end" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > end< / span > < a href = "#end" 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 tsd-is-inherited" > < li class = "tsd-signature tsd
2024-09-10 23:07:25 +01:00
This also considers the priority levels of various commands and changes the result of getSpeedOrder based on such.< / p >
< / div > < h4 class = "tsd-returns-title" > Returns < a href = "../enums/battle.BattlerIndex.html" class = "tsd-signature-type tsd-kind-enum" > BattlerIndex< / a > < span class = "tsd-signature-symbol" > []< / span > < / h4 > < p > BattlerIndex[] the final sequence of commands for this turn< / p >
2024-09-28 19:20:28 +01:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/357056ebebf8893c797cd72ef36877756b89a28b/src/phases/turn-start-phase.ts#L69" > src/phases/turn-start-phase.ts:69< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "getSpeedOrder" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > get< wbr / > Speed< wbr / > Order< / span > < a href = "#getSpeedOrder" 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 = "getSpeedOrder.getSpeedOrder-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > get< wbr / > Speed< wbr / > Order< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/battle.BattlerIndex.html" class = "tsd-signature-type tsd-kind-enum" > BattlerIndex< / a > < span class = "tsd-signature-symbol" > []< / span > < a href = "#getSpeedOrder.getSpeedOrder-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 > This orders the active Pokemon on the field by speed into an BattlerIndex array and returns that array.
2024-09-10 23:07:25 +01:00
It also checks for Trick Room and reverses the array if it is present.< / p >
< / div > < h4 class = "tsd-returns-title" > Returns < a href = "../enums/battle.BattlerIndex.html" class = "tsd-signature-type tsd-kind-enum" > BattlerIndex< / a > < span class = "tsd-signature-symbol" > []< / span > < / h4 > < p > BattlerIndex[] the battle indices of all pokemon on the field ordered by speed< / p >
2024-09-28 19:20:28 +01:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/357056ebebf8893c797cd72ef36877756b89a28b/src/phases/turn-start-phase.ts#L34" > src/phases/turn-start-phase.ts:34< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "hideEnemyTrainer" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > hide< wbr / > Enemy< wbr / > Trainer< / span > < a href = "#hideEnemyTrainer" 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 tsd-is-inherited" > < li class = "tsd-signature tsd-anchor-link" > < a id = "hideEnemyTrainer.hideEnemyTrainer-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > hide< wbr / > Enemy< wbr / > Trainer< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < a href = "#hideEnemyTrainer.hideEnemyTrainer-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" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "phases_field_phase.FieldPhase.html" > FieldPhase< / a > .< a href = "phases_field_phase.FieldPhase.html#hideEnemyTrainer" > hideEnemyTrainer< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/357056ebebf8893c797cd72ef36877756b89a28b/src/phases/battle-phase.ts#L37" > src/phases/battle-phase.ts:37< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "showEnemyTrainer" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > show< wbr / > Enemy< wbr / > Trainer< / span > < a href = "#showEnemyTrainer" 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 tsd-is-inherited" > < li class = "tsd-signature tsd-anchor-link" > < a id = "showEnemyTrainer.showEnemyTrainer-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > show< wbr / > Enemy< wbr / > Trainer< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > trainerSlot< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < a href = "#showEnemyTrainer.showEnemyTrainer-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-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > trainerSlot< / span > : < a href = "../enums/data_trainer_config.TrainerSlot.html" class = "tsd-signature-type tsd-kind-enum" > TrainerSlot< / a > < span class = "tsd-signature-symbol" > = TrainerSlot.NONE< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "phases_field_phase.FieldPhase.html" > FieldPhase< / a > .< a href = "phases_field_phase.FieldPhase.html#showEnemyTrainer" > showEnemyTrainer< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/357056ebebf8893c797cd72ef36877756b89a28b/src/phases/battle-phase.ts#L10" > src/phases/battle-phase.ts:10< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "start" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > start< / span > < a href = "#start" 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 = "start.start-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > start< /spa
