Module: GamePlay
- Defined in:
- docs/4_Systems_000_General.rb,
docs/4_Systems_101_Dex.rb,
docs/4_Systems_103_Bag.rb,
docs/4_Systems_901_GTS.rb,
docs/4_Systems_100_Menu.rb,
docs/4_Systems_203_Shop.rb,
docs/4_Systems_102_Party.rb,
docs/4_Systems_205_Input.rb,
docs/4_Systems_800_Quest.rb,
docs/4_Systems_900_Games.rb,
docs/4_Systems_950_Movie.rb,
docs/4_Systems_303_Evolve.rb,
docs/4_Systems_002_Credits.rb,
docs/4_Systems_004_Message.rb,
docs/4_Systems_104_Trainer.rb,
docs/4_Systems_105_Options.rb,
docs/4_Systems_200_Storage.rb,
docs/4_Systems_206_TownMap.rb,
docs/4_Systems_207_Shortcut.rb,
docs/4_Systems_106_Save_Load.rb,
docs/4_Systems_400_RSE_Clock.rb,
docs/4_Systems_801_Mining_Game.rb,
docs/4_Systems_300_Hall_of_fame.rb,
docs/4_Systems_301_MoveTeaching.rb,
docs/4_Systems_302_MoveReminder.rb,
docs/4_Systems_000_General_2_GamePlay__Base.rb
Overview
Module holding all the scenes of the game
Defined Under Namespace
Modules: BagMixin, Casino, DisplayMessage, EvolveMixin, MenuMixin, MoveReminderMixin, MoveTeachingMixin, NameInputMixin, OptionsMixin, PartyMenuMixin, PokemonTradeStorageMixin, RSEClockHelpers Classes: Bag, Base, BaseCleanUpdate, Battle_Bag, CreditScene, Dex, Evolve, Hall_of_Fame, Hatch, KeyBinding, Language_Choice, Load, Menu, MiningGame, MoveTeaching, Move_Reminder, Movie, NameInput, NumberInput, Options, Party_Menu, PokemonStorage, PokemonTradeStorage, Pokemon_Shop, QuestUI, RSEClock, Save, Shop, Shortcut, StateMachine, Summary, TCard, WorldMap
Constant Summary collapse
- Skill_Learn =
Compatibility with old PSDK version
MoveTeaching
Class Attribute Summary collapse
-
.bag_class ⇒ Class<Bag>
Get the current bag scene.
-
.bag_mixin ⇒ Module<BagMixin>
Get the current bag scene mixin (telling IO).
-
.battle_bag_class ⇒ Class<Battle_Bag>
Get the current battle bag class.
-
.dex_class ⇒ Class<Dex>
Get the Dex class.
-
.evolve_class ⇒ Class<Evolve>
Get the evolve scene.
-
.evolve_mixin ⇒ Class<EvolveMixin>
Get the evolve scene mixin.
-
.hall_of_fame_class ⇒ Class<Hall_of_Fame>
Get the hall of fame scene.
-
.hatch_class ⇒ Class<Hatch>
Get the hatch scene.
-
.menu_class ⇒ Class<Menu>
Get the menu scene.
-
.menu_mixin ⇒ Class<MenuMixin>
Get the menu scene mixin.
-
.move_reminder_class ⇒ Class<Move_Reminder>
Get the move reminder scene.
-
.move_reminder_mixin ⇒ Class<MoveReminderMixin>
Get the move reminder scene mixin.
-
.move_teaching_class ⇒ Class<MoveTeaching>
Get the move teaching scene.
-
.move_teaching_mixin ⇒ Class<MoveTeachingMixin>
Get the move teaching scene mixin.
-
.options_class ⇒ Class<Options>
Get the option setting scene.
-
.options_mixin ⇒ Class<OptionsMixin>
Get the option setting scene mixin.
-
.party_menu_class ⇒ Class<Party_Menu>
Get the party menu scene.
-
.party_menu_mixin ⇒ Class<PartyMenuMixin>
Get the party menu scene mixin.
-
.player_info_class ⇒ Class<TCard>
Get the payer information scene.
-
.pokemon_shop_class ⇒ Class<Pokemon_Shop>
Get the pokemon shop scene.
-
.pokemon_storage_class ⇒ Class<PokemonStorage>
Get the storage class.
-
.pokemon_trade_storage_class ⇒ Class<PokemonTradeStorageMixin>
Get the storage class for trading.
-
.pokemon_trade_storage_mixin ⇒ Class<PokemonTradeStorage>
Get the storage scene mixin for trading.
-
.quest_ui_class ⇒ Class<QuestUI>
Get the Quest scene.
-
.shop_class ⇒ Class<Shop>
Get the item shop scene.
-
.shortcut_class ⇒ Class<Shortcut>
Get the shortcut scene.
-
.string_input_class ⇒ Class<NameInput>
Get the string input scene.
-
.string_input_mixin ⇒ Class<NameInputMixin>
Get the string input scene mixin.
-
.summary_class ⇒ Class<Summary>
Get the Summary scene.
-
.town_map_class ⇒ Class<WorldMap>
Get the town map scene.
Class Method Summary collapse
-
.current_scene ⇒ Base
Get the current scene.
-
.make_egg_hatch(pokemon)
Open the hatch scene.
-
.make_pokemon_evolve(pokemon, id, form = nil, forced = false) {|| ... }
Open the evolve scene.
-
.open_bag
Open the Bag UI (let the player manage what he wants to do in the bag).
-
.open_bag_to_choose_item {|bag_scene| ... }
Open the bag UI to choose any item.
-
.open_bag_to_give_item_to_pokemon {|bag_scene| ... }
Open the Bag UI to give an item to a Pokemon.
-
.open_bag_to_plant_berry {|bag_scene| ... }
Open the Bag UI to plant a berry.
-
.open_bag_to_sell_item
Open the Bag UI to sell item.
-
.open_battle_bag(team) {|battle_bag_scene| ... }
Open the Battle Bag UI (and let the player choose an item).
-
.open_box_name_input(box_name, max_char = 12, box_filename = 'pc_psdk') {|| ... }
Open the name input for a box.
-
.open_character_name_input(default_name, max_char, character_filename, custom_message = nil) {|| ... }
Open the name input for a character/player.
-
.open_dex
Open the dex (to view any Pokemon).
-
.open_dex_to_show_page(page_id)
Open the dex to show a specific page.
-
.open_dex_to_show_pokemon(pokemon)
Open the dex to show a specific Pokemon.
-
.open_existing_pokemon_shop(shop_symbol, price_overwrites = {}, show_background: true)
Open the Pokemon shop scene using a limited shop stored in game_state.shop.
-
.open_existing_shop(shop_symbol, price_overwrites = {}, show_background: true)
Open the shop using a limited shop stored in game_state.shop.
-
.open_hall_of_fame(filename_bgm = 'audio/bgm/Hall-of-Fame', context_of_victory = :league)
Open the hall of fame scene.
-
.open_menu {|menu_scene| ... }
Open the menu class.
-
.open_move_reminder(pokemon, mode = 0) {|move_teaching_scene| ... }
Open the move reminder scene.
-
.open_move_teaching(pokemon, skill) {|move_teaching_scene| ... }
Open the move teaching scene.
-
.open_options {|option_scene| ... }
Open the option scene.
-
.open_party_menu(party = PFM.game_state.actors) {|party_menu_scene| ... }
Open the party menu to see the Pokemon and manage them.
-
.open_party_menu_to_absofusion_pokemon(party, pokemon_db_symbol, allowed_db_symbol)
Open the party menu to absofusion Pokemons.
-
.open_party_menu_to_give_item_to_pokemon(item_db_symbol, party = PFM.game_state.actors) {|party_menu_scene| ... }
Open the party menu to give a item to a Pokemon.
-
.open_party_menu_to_select_a_party(party, amount, excluded_pokemon = nil) {|party_menu_scene| ... }
Open the party menu to select a party.
-
.open_party_menu_to_select_pokemon(party) {|party_menu_scene| ... }
Open the party menu to select a Pokemon.
-
.open_party_menu_to_separate_pokemon(party, pokemon_db_symbol)
Open the party menu to separate Pokemons.
-
.open_party_menu_to_switch(party, forced_switch) {|party_menu_scene| ... }
Open the party menu to switch a Pokemon into battle.
-
.open_party_menu_to_use_item(item_wrapper, party = PFM.game_state.actors) {|party_menu_scene| ... }
Open the party menu to use an item over a Pokemon.
-
.open_player_information
Open the player information scene.
-
.open_pokemon_name_input(pokemon, num_char = 12) {|| ... }
Open the name input for a Pokemon.
-
.open_pokemon_shop(pokemon_ids, pokemon_prices, pokemon_levels, show_background: true)
Open the pokemon shop scene.
-
.open_pokemon_storage_system
Open the Pokemon Storage System UI.
-
.open_pokemon_storage_system_for_trade {|pss_scene| ... }
Open the Pokemon Storage System UI for trade.
-
.open_quest_ui(quests = PFM.game_state.quests)
Open the QuestUI scene.
-
.open_shop(item_list, price_overwrites = {}, show_background: true)
Open the shop scene.
-
.open_shortcut
Open the shortcut scene.
-
.open_summary(pokemon, party = [pokemon])
Open the summary of a Pokemon.
-
.open_town_map(world_map_id = PFM.game_state.env.get_worldmap)
Open the town map.
-
.open_town_map_to_fly(world_map_id = PFM.game_state.env.get_worldmap, pokemon = :map)
Open the town map to use fly.
Class Attribute Details
.bag_class ⇒ Class<Bag>
Get the current bag scene
111 112 113 |
# File 'docs/4_Systems_000_General.rb', line 111 def bag_class @bag_class end |
.bag_mixin ⇒ Module<BagMixin>
Get the current bag scene mixin (telling IO)
108 109 110 |
# File 'docs/4_Systems_000_General.rb', line 108 def bag_mixin @bag_mixin end |
.battle_bag_class ⇒ Class<Battle_Bag>
Get the current battle bag class
114 115 116 |
# File 'docs/4_Systems_000_General.rb', line 114 def battle_bag_class @battle_bag_class end |
.dex_class ⇒ Class<Dex>
Get the Dex class
156 157 158 |
# File 'docs/4_Systems_000_General.rb', line 156 def dex_class @dex_class end |
.evolve_class ⇒ Class<Evolve>
Get the evolve scene
338 339 340 |
# File 'docs/4_Systems_000_General.rb', line 338 def evolve_class @evolve_class end |
.evolve_mixin ⇒ Class<EvolveMixin>
Get the evolve scene mixin
335 336 337 |
# File 'docs/4_Systems_000_General.rb', line 335 def evolve_mixin @evolve_mixin end |
.hall_of_fame_class ⇒ Class<Hall_of_Fame>
Get the hall of fame scene
277 278 279 |
# File 'docs/4_Systems_000_General.rb', line 277 def hall_of_fame_class @hall_of_fame_class end |
.hatch_class ⇒ Class<Hatch>
Get the hatch scene
341 342 343 |
# File 'docs/4_Systems_000_General.rb', line 341 def hatch_class @hatch_class end |
.menu_class ⇒ Class<Menu>
Get the menu scene
101 102 103 |
# File 'docs/4_Systems_000_General.rb', line 101 def @menu_class end |
.menu_mixin ⇒ Class<MenuMixin>
Get the menu scene mixin
98 99 100 |
# File 'docs/4_Systems_000_General.rb', line 98 def @menu_mixin end |
.move_reminder_class ⇒ Class<Move_Reminder>
Get the move reminder scene
326 327 328 |
# File 'docs/4_Systems_000_General.rb', line 326 def move_reminder_class @move_reminder_class end |
.move_reminder_mixin ⇒ Class<MoveReminderMixin>
Get the move reminder scene mixin
323 324 325 |
# File 'docs/4_Systems_000_General.rb', line 323 def move_reminder_mixin @move_reminder_mixin end |
.move_teaching_class ⇒ Class<MoveTeaching>
Get the move teaching scene
314 315 316 |
# File 'docs/4_Systems_000_General.rb', line 314 def move_teaching_class @move_teaching_class end |
.move_teaching_mixin ⇒ Class<MoveTeachingMixin>
Get the move teaching scene mixin
311 312 313 |
# File 'docs/4_Systems_000_General.rb', line 311 def move_teaching_mixin @move_teaching_mixin end |
.options_class ⇒ Class<Options>
Get the option setting scene
239 240 241 |
# File 'docs/4_Systems_000_General.rb', line 239 def @options_class end |
.options_mixin ⇒ Class<OptionsMixin>
Get the option setting scene mixin
236 237 238 |
# File 'docs/4_Systems_000_General.rb', line 236 def @options_mixin end |
.party_menu_class ⇒ Class<Party_Menu>
Get the party menu scene
173 174 175 |
# File 'docs/4_Systems_000_General.rb', line 173 def @party_menu_class end |
.party_menu_mixin ⇒ Class<PartyMenuMixin>
Get the party menu scene mixin
170 171 172 |
# File 'docs/4_Systems_000_General.rb', line 170 def @party_menu_mixin end |
.player_info_class ⇒ Class<TCard>
Get the payer information scene
230 231 232 |
# File 'docs/4_Systems_000_General.rb', line 230 def player_info_class @player_info_class end |
.pokemon_shop_class ⇒ Class<Pokemon_Shop>
Get the pokemon shop scene
249 250 251 |
# File 'docs/4_Systems_000_General.rb', line 249 def pokemon_shop_class @pokemon_shop_class end |
.pokemon_storage_class ⇒ Class<PokemonStorage>
Get the storage class
140 141 142 |
# File 'docs/4_Systems_000_General.rb', line 140 def pokemon_storage_class @pokemon_storage_class end |
.pokemon_trade_storage_class ⇒ Class<PokemonTradeStorageMixin>
Get the storage class for trading
146 147 148 |
# File 'docs/4_Systems_000_General.rb', line 146 def pokemon_trade_storage_class @pokemon_trade_storage_class end |
.pokemon_trade_storage_mixin ⇒ Class<PokemonTradeStorage>
Get the storage scene mixin for trading
143 144 145 |
# File 'docs/4_Systems_000_General.rb', line 143 def pokemon_trade_storage_mixin @pokemon_trade_storage_mixin end |
.quest_ui_class ⇒ Class<QuestUI>
Get the Quest scene
374 375 376 |
# File 'docs/4_Systems_000_General.rb', line 374 def quest_ui_class @quest_ui_class end |
.shop_class ⇒ Class<Shop>
Get the item shop scene
246 247 248 |
# File 'docs/4_Systems_000_General.rb', line 246 def shop_class @shop_class end |
.shortcut_class ⇒ Class<Shortcut>
Get the shortcut scene
368 369 370 |
# File 'docs/4_Systems_000_General.rb', line 368 def shortcut_class @shortcut_class end |
.string_input_class ⇒ Class<NameInput>
Get the string input scene
288 289 290 |
# File 'docs/4_Systems_000_General.rb', line 288 def string_input_class @string_input_class end |
.string_input_mixin ⇒ Class<NameInputMixin>
Get the string input scene mixin
285 286 287 |
# File 'docs/4_Systems_000_General.rb', line 285 def string_input_mixin @string_input_mixin end |
.summary_class ⇒ Class<Summary>
Get the Summary scene
222 223 224 |
# File 'docs/4_Systems_000_General.rb', line 222 def summary_class @summary_class end |
.town_map_class ⇒ Class<WorldMap>
Get the town map scene
356 357 358 |
# File 'docs/4_Systems_000_General.rb', line 356 def town_map_class @town_map_class end |
Class Method Details
.current_scene ⇒ Base
Get the current scene
94 95 |
# File 'docs/4_Systems_000_General.rb', line 94 def current_scene end |
.make_egg_hatch(pokemon)
Open the hatch scene
352 353 |
# File 'docs/4_Systems_000_General.rb', line 352 def make_egg_hatch(pokemon) end |
.make_pokemon_evolve(pokemon, id, form = nil, forced = false) {|| ... }
Open the evolve scene
348 349 |
# File 'docs/4_Systems_000_General.rb', line 348 def make_pokemon_evolve(pokemon, id, form = nil, forced = false, &block) end |
.open_bag
Open the Bag UI (let the player manage what he wants to do in the bag)
116 117 |
# File 'docs/4_Systems_000_General.rb', line 116 def open_bag end |
.open_bag_to_choose_item {|bag_scene| ... }
Open the bag UI to choose any item
136 137 |
# File 'docs/4_Systems_000_General.rb', line 136 def open_bag_to_choose_item(&block) end |
.open_bag_to_give_item_to_pokemon {|bag_scene| ... }
Open the Bag UI to give an item to a Pokemon
125 126 |
# File 'docs/4_Systems_000_General.rb', line 125 def open_bag_to_give_item_to_pokemon(&block) end |
.open_bag_to_plant_berry {|bag_scene| ... }
Open the Bag UI to plant a berry
129 130 |
# File 'docs/4_Systems_000_General.rb', line 129 def open_bag_to_plant_berry(&block) end |
.open_bag_to_sell_item
Open the Bag UI to sell item
132 133 |
# File 'docs/4_Systems_000_General.rb', line 132 def open_bag_to_sell_item end |
.open_battle_bag(team) {|battle_bag_scene| ... }
Open the Battle Bag UI (and let the player choose an item)
121 122 |
# File 'docs/4_Systems_000_General.rb', line 121 def open_battle_bag(team, &block) end |
.open_box_name_input(box_name, max_char = 12, box_filename = 'pc_psdk') {|| ... }
Open the name input for a box
307 308 |
# File 'docs/4_Systems_000_General.rb', line 307 def open_box_name_input(box_name, max_char = 12, box_filename = 'pc_psdk', &block) end |
.open_character_name_input(default_name, max_char, character_filename, custom_message = nil) {|| ... }
Open the name input for a character/player
294 295 |
# File 'docs/4_Systems_000_General.rb', line 294 def open_character_name_input(default_name, max_char, character_filename, = nil, &block) end |
.open_dex
Open the dex (to view any Pokemon)
158 159 |
# File 'docs/4_Systems_000_General.rb', line 158 def open_dex end |
.open_dex_to_show_page(page_id)
Open the dex to show a specific page
166 167 |
# File 'docs/4_Systems_000_General.rb', line 166 def open_dex_to_show_page(page_id) end |
.open_dex_to_show_pokemon(pokemon)
Open the dex to show a specific Pokemon
162 163 |
# File 'docs/4_Systems_000_General.rb', line 162 def open_dex_to_show_pokemon(pokemon) end |
.open_existing_pokemon_shop(shop_symbol, price_overwrites = {}, show_background: true)
Open the Pokemon shop scene using a limited shop stored in game_state.shop
273 274 |
# File 'docs/4_Systems_000_General.rb', line 273 def open_existing_pokemon_shop(shop_symbol, price_overwrites = {}, show_background: true) end |
.open_existing_shop(shop_symbol, price_overwrites = {}, show_background: true)
Open the shop using a limited shop stored in game_state.shop
260 261 |
# File 'docs/4_Systems_000_General.rb', line 260 def open_existing_shop(shop_symbol, price_overwrites = {}, show_background: true) end |
.open_hall_of_fame(filename_bgm = 'audio/bgm/Hall-of-Fame', context_of_victory = :league)
Open the hall of fame scene
281 282 |
# File 'docs/4_Systems_000_General.rb', line 281 def open_hall_of_fame(filename_bgm = 'audio/bgm/Hall-of-Fame', context_of_victory = :league) end |
.open_menu {|menu_scene| ... }
Open the menu class
104 105 |
# File 'docs/4_Systems_000_General.rb', line 104 def (&block) end |
.open_move_reminder(pokemon, mode = 0) {|move_teaching_scene| ... }
Open the move reminder scene
331 332 |
# File 'docs/4_Systems_000_General.rb', line 331 def open_move_reminder(pokemon, mode = 0, &block) end |
.open_move_teaching(pokemon, skill) {|move_teaching_scene| ... }
Open the move teaching scene
319 320 |
# File 'docs/4_Systems_000_General.rb', line 319 def open_move_teaching(pokemon, skill, &block) end |
.open_options {|option_scene| ... }
Open the option scene
242 243 |
# File 'docs/4_Systems_000_General.rb', line 242 def (&block) end |
.open_party_menu(party = PFM.game_state.actors) {|party_menu_scene| ... }
Open the party menu to see the Pokemon and manage them
177 178 |
# File 'docs/4_Systems_000_General.rb', line 177 def (party = PFM.game_state.actors, &block) end |
.open_party_menu_to_absofusion_pokemon(party, pokemon_db_symbol, allowed_db_symbol)
Open the party menu to absofusion Pokemons
213 214 |
# File 'docs/4_Systems_000_General.rb', line 213 def (party, pokemon_db_symbol, allowed_db_symbol) end |
.open_party_menu_to_give_item_to_pokemon(item_db_symbol, party = PFM.game_state.actors) {|party_menu_scene| ... }
Open the party menu to give a item to a Pokemon
189 190 |
# File 'docs/4_Systems_000_General.rb', line 189 def (item_db_symbol, party = PFM.game_state.actors, &block) end |
.open_party_menu_to_select_a_party(party, amount, excluded_pokemon = nil) {|party_menu_scene| ... }
Open the party menu to select a party
207 208 |
# File 'docs/4_Systems_000_General.rb', line 207 def (party, amount, excluded_pokemon = nil, &block) end |
.open_party_menu_to_select_pokemon(party) {|party_menu_scene| ... }
Open the party menu to select a Pokemon
200 201 |
# File 'docs/4_Systems_000_General.rb', line 200 def (party, &block) end |
.open_party_menu_to_separate_pokemon(party, pokemon_db_symbol)
Open the party menu to separate Pokemons
218 219 |
# File 'docs/4_Systems_000_General.rb', line 218 def (party, pokemon_db_symbol) end |
.open_party_menu_to_switch(party, forced_switch) {|party_menu_scene| ... }
Open the party menu to switch a Pokemon into battle
195 196 |
# File 'docs/4_Systems_000_General.rb', line 195 def (party, forced_switch, &block) end |
.open_party_menu_to_use_item(item_wrapper, party = PFM.game_state.actors) {|party_menu_scene| ... }
Open the party menu to use an item over a Pokemon
183 184 |
# File 'docs/4_Systems_000_General.rb', line 183 def (item_wrapper, party = PFM.game_state.actors, &block) end |
.open_player_information
Open the player information scene
232 233 |
# File 'docs/4_Systems_000_General.rb', line 232 def open_player_information end |
.open_pokemon_name_input(pokemon, num_char = 12) {|| ... }
Open the name input for a Pokemon
300 301 |
# File 'docs/4_Systems_000_General.rb', line 300 def open_pokemon_name_input(pokemon, num_char = 12, &block) end |
.open_pokemon_shop(pokemon_ids, pokemon_prices, pokemon_levels, show_background: true)
Open the pokemon shop scene
267 268 |
# File 'docs/4_Systems_000_General.rb', line 267 def open_pokemon_shop(pokemon_ids, pokemon_prices, pokemon_levels, show_background: true) end |
.open_pokemon_storage_system
Open the Pokemon Storage System UI
148 149 |
# File 'docs/4_Systems_000_General.rb', line 148 def open_pokemon_storage_system end |
.open_pokemon_storage_system_for_trade {|pss_scene| ... }
Open the Pokemon Storage System UI for trade
152 153 |
# File 'docs/4_Systems_000_General.rb', line 152 def open_pokemon_storage_system_for_trade(&block) end |
.open_quest_ui(quests = PFM.game_state.quests)
Open the QuestUI scene
376 377 |
# File 'docs/4_Systems_000_General.rb', line 376 def open_quest_ui(quests = PFM.game_state.quests) end |
.open_shop(item_list, price_overwrites = {}, show_background: true)
Open the shop scene
254 255 |
# File 'docs/4_Systems_000_General.rb', line 254 def open_shop(item_list, price_overwrites = {}, show_background: true) end |
.open_shortcut
Open the shortcut scene
370 371 |
# File 'docs/4_Systems_000_General.rb', line 370 def open_shortcut end |
.open_summary(pokemon, party = [pokemon])
Open the summary of a Pokemon
226 227 |
# File 'docs/4_Systems_000_General.rb', line 226 def open_summary(pokemon, party = [pokemon]) end |
.open_town_map(world_map_id = PFM.game_state.env.get_worldmap)
Open the town map
359 360 |
# File 'docs/4_Systems_000_General.rb', line 359 def open_town_map(world_map_id = PFM.game_state.env.get_worldmap) end |
.open_town_map_to_fly(world_map_id = PFM.game_state.env.get_worldmap, pokemon = :map)
Open the town map to use fly
364 365 |
# File 'docs/4_Systems_000_General.rb', line 364 def open_town_map_to_fly(world_map_id = PFM.game_state.env.get_worldmap, pokemon = :map) end |