update docstrings about the switch prompt

This commit is contained in:
Bryan Bishop 2013-11-11 21:48:01 -06:00
parent e61643e681
commit 2801a3545f
2 changed files with 8 additions and 2 deletions

View File

@ -58,7 +58,9 @@ class Battle(EmulatorController):
def is_switch_prompt(self):
"""
Detects if the battle is waiting for the player to choose whether or
not to switch pokemon.
not to switch pokemon. This is the prompt that asks yes/no for whether
to switch pokemon, like if the trainer is switching pokemon at the end
of a turn set.
"""
return self.emulator.is_battle_switch_prompt()

View File

@ -602,8 +602,12 @@ class crystal(object):
def is_battle_switch_prompt(self):
"""
Checks if the game is currently displaying the yes/no prompt for
whether or not to switch pokemon.
whether or not to switch pokemon. This happens when the trainer is
switching pokemon out.
"""
# TODO: this method should return False if the game options have been
# set to not use the battle switching style.
# get on-screen text
text = self.get_text()