2024-06-07 21:07:09 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > PokemonMove | 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/field_pokemon.html" > field/pokemon< / a > < / li > < li > < a href = "field_pokemon.PokemonMove.html" > PokemonMove< / a > < / li > < / ul > < h1 > Class PokemonMove< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > Wrapper class for the < a href = "data_move.default.html" class = "tsd-kind-class" > < code > Move< / code > < / a > class for Pokemon to interact with.
These are the moves assigned to a < a href = "field_pokemon.default.html" class = "tsd-kind-class" > < code > Pokemon< / code > < / a > object.
It links to < a href = "data_move.default.html" class = "tsd-kind-class" > < code > Move< / code > < / a > class via the move ID.
Compared to < a href = "data_move.default.html" class = "tsd-kind-class" > < code > Move< / code > < / a > , this class also tracks if a move has received.
PP Ups, amount of PP used, and things like that.< / p >
< / div > < div class = "tsd-comment tsd-typography" > < h4 > See< / h4 > < ul >
< li > < a href = "field_pokemon.PokemonMove.html#isUsable" class = "tsd-kind-method" > < code > isUsable< / code > < / a > - checks if move is disabled, out of PP, or not implemented.< / li >
< li > < a href = "field_pokemon.PokemonMove.html#getMove" class = "tsd-kind-method" > < code > getMove< / code > < / a > - returns < a href = "data_move.default.html" class = "tsd-kind-class" > < code > Move< / code > < / a > object by looking it up via ID.< / li >
< li > < a href = "field_pokemon.PokemonMove.html#usePp" class = "tsd-kind-method" > < code > usePp< / code > < / a > - removes a point of PP from the move.< / li >
< li > < a href = "field_pokemon.PokemonMove.html#getMovePp" class = "tsd-kind-method" > < code > getMovePp< / code > < / a > - returns amount of PP a move currently has.< / li >
< li > < a href = "field_pokemon.PokemonMove.html#getPpRatio" class = "tsd-kind-method" > < code > getPpRatio< / code > < / a > - returns the current PP amount / max PP amount.< / li >
< li > < a href = "field_pokemon.PokemonMove.html#getName" class = "tsd-kind-method" > < code > getName< / code > < / a > - returns name of < a href = "data_move.default.html" class = "tsd-kind-class" > < code > Move< / code > < / a > .< / li >
< / ul >
2024-06-28 04:56:23 +00:00
< / div > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/784035b6f5bb16360d3b0da45aae57acae3c59d1/src/field/pokemon.ts#L3970" > src/field/pokemon.ts:3970< / 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-index-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 = "field_pokemon.PokemonMove.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-05-31 13:57:14 +00:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "field_pokemon.PokemonMove.html#moveId" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > move< wbr / > Id< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#ppUp" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > pp< wbr / > Up< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#ppUsed" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > pp< wbr / > Used< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#virtual" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > virtual< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "field_pokemon.PokemonMove.html#getMove" 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 / > Move< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#getMovePp" 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 / > Move< wbr / > Pp< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#getName" 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 / > Name< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#getPpRatio" 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 / > Pp< wbr / > Ratio< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#isUsable" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > is< wbr / > Usable< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#usePp" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > use< wbr / > Pp< / span > < / a >
< a href = "field_pokemon.PokemonMove.html#loadMove" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > load< wbr / > Move< / span > < / a >
2024-06-28 04:56:23 +00:00
< / div > < / section > < / div > < / details > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Constructors< / h2 > < 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_PokemonMove" class = "tsd-anchor" > < / a > < span class = "tsd-kind-constructor-signature" > new < wbr / > Pokemon< wbr / > Move< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > moveId< / span > , < span class = "tsd-kind-parameter" > ppUsed< / span > < span class = "tsd-signature-symbol" > ?< / span > , < span class = "tsd-kind-parameter" > ppUp< / span > < span class = "tsd-signature-symbol" > ?< / span > , < span class = "tsd-kind-parameter" > virtual< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "field_pokemon.PokemonMove.html" class = "tsd-signature-type tsd-kind-class" > PokemonMove< / a > < a href = "#constructor.new_PokemonMove" 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" > moveId< / span > : < a href = "../enums/enums_moves.Moves.html" class = "tsd-signature-type tsd-kind-enum" > Moves< / a > < / span > < / li > < li > < span > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > ppUsed< / span > : < span class = "tsd-signature-type" > number< / span > < / span > < / li > < li > < span > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > ppUp< / span > : < span class = "tsd-signature-type" > number< / span > < / span > < / li > < li > < span > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > virtual< / span > : < span class = "tsd-signature-type" > boolean< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "field_pokemon.PokemonMove.html" class = "tsd-signature-type tsd-kind-class" > PokemonMove< / a > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/784035b6f5bb16360d3b0da45aae57acae3c59d1/src/field/pokemon.ts#L3976" > src/field/pokemon.ts:3976< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Properties< / h2 > < section class = "tsd-panel tsd-member" > < a id = "moveId" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > move< wbr / > Id< / span > < a href = "#moveId" 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" > move< wbr / > Id< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../enums/enums_moves.Moves.html" class = "tsd-signature-type tsd-kind-enum" > Moves< / a > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/784035b6f5bb16360d3b0da45aae57acae3c59d1/src/field/pokemon.ts#L3971" > src/field/pokemon.ts:3971< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "ppUp" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > pp< wbr / > Up< / span > < a href = "#ppUp" 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" > pp< wbr / > Up< / 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/784035b6f5bb16360d3b0da45aae57acae3c59d1/src/field/pokemon.ts#L3973" > src/field/pokemon.ts:3973< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "ppUsed" class
2024-05-31 13:57:14 +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" > count< / span > : < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > = 1< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > Amount of PP to use< / p >
2024-06-28 04:56:23 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/784035b6f5bb16360d3b0da45aae57acae3c59d1/src/field/pokemon.ts#L3998" > src/field/pokemon.ts:3998< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "loadMove" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagStatic" > Static< / code > < span > load< wbr / > Move< / span > < a href = "#loadMove" 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 = "loadMove.loadMove-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > load< wbr / > Move< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > source< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "field_pokemon.PokemonMove.html" class = "tsd-signature-type tsd-kind-class" > PokemonMove< / a > < a href = "#loadMove.loadMove-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 > Copies an existing move or creates a valid PokemonMove object from json representing one< / p >
2024-05-31 13:57:14 +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" > source< / span > : < span class = "tsd-signature-type" > any< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > The data for the move to copy< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "field_pokemon.PokemonMove.html" class = "tsd-signature-type tsd-kind-class" > PokemonMove< / a > < / h4 > < p > A valid pokemonmove object< / p >
2024-06-28 04:56:23 +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/784035b6f5bb16360d3b0da45aae57acae3c59d1/src/field/pokemon.ts#L4019" > src/field/pokemon.ts:4019< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-index-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" > < h4 class = "uppercase" > Member Visibility< / h4 > < form > < 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-private" name = "private" / > < 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 > Private< / 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 > < / form > < / div > < div class = "tsd-theme-toggle" > < h4 class = "uppercase" > Theme< / h4 > < 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-index-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" > < 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 > < a href = "#moveId" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > move< wbr / > Id< / span > < / a > < a href = "#ppUp" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > pp< wbr / > Up< / span > < / a > < a href = "#ppUsed" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > pp< wbr / > Used< / span > < / a > < a href = "#virtual" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > virtual< / span > < / a > < a href = "#getMove" class = "" > < svg class = "tsd-k
