Class: Interpreter
- Includes:
- Util::SystemMessage
- Defined in:
- docs/2_PSDK_Event_Interpreter.rb,
docs/4_Systems_900_Games.rb,
docs/4_Systems_998_Global_Systems.rb
Overview
Interpreter of the event script commands
Constant Summary collapse
- FEC_SKIP_CODES =
List of command cods that needs to be skipped in order to detect the from event calling call
[108, 121, 122]
- MODE_SWOOSH =
If the put item in pocket message is not shown
true- SYSTEM_MESSAGE_HEADER =
Header of the system messages
':[windowskin=m_18]:\\c[10]'- EXCLAMATION_PARTICLE_DURATION =
Duration of the exclamation particle
54- DEFAULT_CONTEST_BGM =
Default BGM used for contests
['oras_pokemon_contest', 100, 100]
- ACTION_STATES =
List of action state suffixes
['_cycle_roll', '_cycle_roll_to_wheel', '_cycle_stop', '_cycle_wheel', '_deep_swamp_sinking', '_fish', '_ladder', '_misc2', '_pokecenter', '_run', '_shake', '_snow', '_snow_deep', '_snow_deep_misc', '_snow_misc', '_surf', '_surf_fish', '_surf_hm', '_surf_vs', '_swamp', '_swamp_deep', '_swamp_run', '_walk']
Constants included from Util::SystemMessage
Util::SystemMessage::HAS_NUMBER_REG, Util::SystemMessage::IS_ITEM, Util::SystemMessage::IS_NUMBER1, Util::SystemMessage::IS_NUMBER2, Util::SystemMessage::IS_NUMBER3, Util::SystemMessage::IS_POKEMON, Util::SystemMessage::MESSAGES
Instance Method Summary collapse
-
#add_egg(id, egg_how_obtained = :received) ⇒ PFM::Pokemon?
(also: #ajouter_oeuf)
Add an egg to the Party (or in the PC).
-
#add_item(item_id, no_delete = false, text_id: 4, no_space_text_id: 7, color: 11, count: 1)
Add an item to the bag if possible, will delete the event forever.
-
#add_items_to_limited_shop(symbol_of_shop, items_to_refill = [], quantities_to_refill = [])
(also: #ajouter_objets_magasin)
Add items to a limited shop.
-
#add_limited_shop(symbol_of_shop, items_sym = [], items_quantity = [], shop_rewrite: false)
(also: #ajouter_un_magasin_limite)
Create a limited shop (in the main PFM::Shop object).
-
#add_new_pokemon_shop(sym_new_shop, list_id, list_price, list_param, list_quantity = [], shop_rewrite: false)
(also: #ajouter_nouveau_magasin_pokemon)
Create a limited Pokemon Shop.
-
#add_parallax(image, x, y, z, zoom_x = 1, zoom_y = 1, opacity = 255, blend_type = 0)
Add a parallax.
-
#add_pokemon(pokemon_or_id, level = 5, shiny = false) ⇒ PFM::Pokemon?
(also: #ajouter_pokemon, #ajouter_stocker_pokemon)
Add a pokemon to the party or store it in the PC.
-
#add_pokemon_to_shop(symbol_of_shop, list_id, list_price, list_param, list_quantity = [], pkm_rewrite: false)
(also: #ajouter_pokemon_au_magasin)
Add Pokemon to a Pokemon Shop.
-
#add_rename_pokemon(pokemon_or_id, level = 5, shiny = false, num_char = 12) ⇒ PFM::Pokemon?
(also: #ajouter_renommer_pokemon)
Add a pokemon to the party or store it in the PC and rename it.
-
#add_specific_pokemon(hash) ⇒ PFM::Pokemon?
(also: #ajouter_pokemon_param)
Add a pokemon (#add_pokemon) with specific informations.
-
#animate_from_charset(lines, duration, reverse: false, repeat: false, last_frame_delay: false) ⇒ Boolean
Shortcut for get_character(@event_id).animate_from_charset(*args).
-
#apply_message_font(font_id)
Apply a custom font to the message window.
-
#call_battle_wild(id, level, *args)
(also: #demarrer_combat)
Start a wild battle.
-
#call_party_menu(id_var = ::Yuki::Var::Party_Menu_Sel, party = $actors, mode = :map, extend_data = nil)
(also: #appel_menu_equipe)
Show the party menu in order to select a Pokemon.
-
#can_move_reminder_be_called?(mode = 0) ⇒ Boolean
(also: #maitre_capacites_appelable?)
Detect if the move reminder can remind a move to the selected pokemon.
-
#carte_du_monde(arg = :view, wm_id = $env.get_worldmap)
(also: #world_map)
Open the world map.
-
#casino(arg = :voltorb_flip, speed = 2)
Open the casino gameplay.
-
#choice(variable_id, cancel_type, *choices)
Start a choice with more option than RMXP allows.
-
#clear_saved_fog
Clear the saved fog.
-
#combine_with_saved_bag(id_storage = nil)
Combined the saved bag with the current bag.
-
#combine_with_saved_money(id_storage = nil)
Combined the saved money with the current money.
-
#combine_with_saved_pokedex(id_storage = nil, empty_pokedex: false)
Combined the saved pokedex with the current pokedex.
-
#cry_pokemon(id, volume: 100, tempo: 100, form: 0)
Play the cry of a Pokemon.
-
#current_overlay_preset ⇒ PFM::MapOverlay::PresetBase?
(also: #map_overlay)
Get the current overlay preset.
-
#current_time ⇒ Integer
Return the current time in minute.
-
#delete_event_forever(event_id)
(also: #delete_event)
Delete the provided event forever.
-
#delete_this_event_forever
Delete the current event forever.
-
#detect_invalid_tile(x, y, width, height, tile_id) ⇒ Boolean
Detect if a specified tile (in layer 3) is in the specified zone.
-
#detect_player(nb_pas, direction) ⇒ Boolean
Detect the player in a specific direction.
-
#detect_player_circle(r) ⇒ Boolean
Detect the player in a circle around the event.
-
#detect_player_rect(nx, ny) ⇒ Boolean
Detect the player in a rectangle around the event.
-
#dynamic_light ⇒ NuriYuri::DynamicLight
(also: #dyn_light)
Return the NuriYuri::DynamicLight module.
-
#emotion(type, char_id = 0, wait = 34, params = {})
Show an emotion to an event or the player.
-
#emotion_on_multiple_npc(type, chars_id = [0], wait = 34, params = {})
(also: #emotion_on_multiple_pnj)
Show an emotion on multiple events and/or the player.
-
#empty_and_save_appearance(id_storage = nil)
Save the appearance somewhere and set the default in the point of view of the player.
-
#empty_and_save_bag(id_storage = nil)
Save the bag somewhere and make it empty in the point of view of the player.
-
#empty_and_save_money(id_storage = nil)
Save the money somewhere and make it null in the point of view of the player.
-
#empty_and_save_party(id_storage = nil)
Save the team somewhere and make it empty in the point of view of the player.
-
#empty_and_save_pokedex(id_storage = nil)
Save the pokedex somewhere and make it empty in the point of view of the player.
-
#empty_and_save_trainer(id_storage = nil)
Save the trainer somewhere and make it empty in the point of view of the player.
-
#event_calling(common_event, event_id) ⇒ Boolean
Check if an event is calling a common event (in its first non comment commands).
-
#fast_travel(x, y = nil, ms = 5)
Shortcut defining the pathfinding request and wait for the end of the path following.
-
#find_path(to:, radius: 0, tries: Pathfinding::TRY_COUNT, type: nil, running: false)
Use path finding to locate the current event move else.
-
#force_save
(also: #forcer_sauvegarde)
Save the game without asking.
-
#front_event_calling(common_event) ⇒ Boolean
Check if the front event calls a common event (in its first non comment commands).
-
#ge(id = @event_id) ⇒ Game_Event
Return the $game_map.events.
-
#get_self_switch(self_switch, event_id = @event_id, map_id = @map_id) ⇒ Boolean
(also: #get_ss)
Get the value of a self_switch.
-
#give_exp(index, amount)
Give a certain amount of exp to one Pokemon.
-
#give_exp_all(amount)
Give a certain amount of exp to every Pokemon in party.
-
#give_item(item_id, count = 1)
Give an item to the player.
-
#give_level(index, amount)
Give a certain amount of level to one Pokemon.
-
#give_level_all(amount)
Give a certain amount of level to every Pokemon in party.
-
#gm ⇒ Game_Map
Return the $game_map.
-
#gp ⇒ Game_Player
Return the $game_player.
-
#gs ⇒ Game_Switches
Return the $game_switches.
-
#gt ⇒ Game_Temp
Return the $game_temp.
-
#gv ⇒ Game_Variables
Return the $game_variables.
-
#hall_of_fame(filename_bgm = 'audio/bgm/Hall-of-Fame', context_of_victory = :league)
Open the Hall of Fame UI.
-
#hm_bar_animation_on_map(reason)
Triggers the HM Bar Animation.
-
#honey_tree_event(id)
Function calling the honey tree event.
-
#internal_add_pokemon_check_level_shiny(pokemon_id, level, shiny, method_name) ⇒ PFM::Pokemon
Check the input parameters and send the Pokemon to method_name.
-
#internal_add_pokemon_check_symbol(pokemon_or_id, level, shiny, method_name) ⇒ PFM::Pokemon
Check the symbol of the Pokemon and send the Pokemon to method_name.
-
#internal_add_pokemon_final(pokemon) ⇒ PFM::Pokemon
Try to add Pokemon to the party or store the Pokemon in the storage system.
-
#internal_store_pokemon_final(pokemon) ⇒ PFM::Pokemon
Try to add Pokemon to the party or store the Pokemon in the storage system.
-
#message(string, cancel_type = 0, *choices) ⇒ Integer
Show a message with eventually a choice.
-
#mining_game(param = nil, music_filename = GamePlay::MiningGame::DEFAULT_MUSIC, delete_after: true, grid_handler: nil)
Open the Mining Game UI.
-
#mirror_picture(id, bool = true)
Mirror a RMXP Picture.
-
#move_camera_to_event(event_id, duration, block_interpreter = true, distortion: :UNICITY_DISTORTION)
Smoothly move the map camera to a specific event over a given duration (in seconds).
-
#move_camera_to_tiles(x, y, duration, block_interpreter = true, distortion: :UNICITY_DISTORTION)
Smoothly move the map camera to specific tile coordinates over a given duration (in seconds).
-
#move_reminder(pokemon = $actors[$game_variables[::Yuki::Var::Party_Menu_Sel]], mode = 0) ⇒ Boolean
(also: #maitre_capacites)
Call the move reminder UI with the choosen Pokemon and a specific mode (0 by default).
-
#name_player(default_name, character_filename, max_char = 12, message: [43, 0], set_appearance: true, &block)
Shows a character, a default name, and asks the player for their name.
-
#npc_trade_sequence(index, pokemon)
Sequence that perform NPC trade.
-
#open_shop(symbol_or_list, prices = {}, show_background: true)
(also: #ouvrir_magasin)
Open a shop.
-
#party ⇒ PFM::GameState
Return the party object (game state).
-
#pfm_text ⇒ PFM::Text
Return the PFM::Text module.
-
#pick_item(item_id, count = 1, no_delete = false)
Pick an item on the ground (and delete the event).
-
#player_spotted?(nb_pas) ⇒ Boolean
(also: #trainer_spotted)
Detect if the event can spot the player and move to the player.
-
#player_spotted_directional?(up: nil, down: nil, left: nil, right: nil) ⇒ Boolean
Detect if the event can spot the player and move to the player with direction relative detection.
-
#player_spotted_rect?(nb_pas, dist) ⇒ Boolean
(also: #trainer_spotted_rect)
Detect if the event can spot the player in a certain rect in frond of itself.
-
#pokemon_hidden_power(index_or_pokemon)
Returns the db_symbol of the type of the Pokemon's Hidden Power.
-
#pokemon_index(method_name, *args)
Return the index of the choosen Pokemon or call a method of GameState to find the right Pokemon.
-
#pokemon_shop_open(symbol_or_list, prices = [], param = [], show_background: true)
(also: #ouvrir_magasin_pokemon)
Open a Pokemon shop.
-
#pokemon_stored_sequence(pokemon)
Show the "Pokemon was sent to BOX $" message.
-
#puzzle_alpha(id = 1, id_switch = Yuki::Sw::RuinsVictory)
Start the Alpha Ruins puzzle.
-
#quest_book
(also: #livre_quetes, #quest_ui)
Show the quest book.
-
#receive_pokemon_sequence(pokemon_or_id, level = 5, shiny = false) ⇒ PFM::Pokemon?
Receive Pokemon sequence, when the player is given a Pokemon.
-
#remove_items_from_limited_shop(symbol_of_shop, items_to_remove, quantities_to_remove)
(also: #enlever_objets_magasin)
Remove items from a limited shop.
-
#remove_pokemon_from_shop(symbol_of_shop, remove_list_mon, param_form, quantities_to_remove = [])
(also: #enlever_pokemon_du_magasin)
Remove Pokemon from a Pokemon Shop.
-
#rename_pokemon(index_or_pokemon, num_char = 12)
(also: #renommer_pokemon)
Show the rename interface of a Pokemon.
-
#reset_message_font
Reset the message window font to the default.
-
#retrieve_saved_appearance(id_storage = nil)
Retrieve the saved appearance.
-
#retrieve_saved_bag(id_storage = nil)
Retrieve the saved bag when emptied ( /!\ empty the current bag).
-
#retrieve_saved_money(id_storage = nil)
Retrieve the saved money.
-
#retrieve_saved_party(id_storage = nil)
(also: #retreive_saved_party)
Retrieve the saved team when emptied ( /!\ empty the current team).
-
#retrieve_saved_pokedex(id_storage = nil)
Retrieve the saved pokedex when emptied.
-
#retrieve_saved_trainer(id_storage = nil)
Retrieve the saved trainer.
-
#retrieve_stolen_pokemon(id_storage = nil)
(also: #retreive_stolen_pokemon)
Retrieve previously stolen Pokemon ( /!\ uses #add_pokemon).
-
#save_this_fog ⇒ Array
Save the current fog.
-
#set_actor_back(actor_id, filename)
Sets a specific actors battle sprite to a specific one.
-
#set_player_back(filename)
Sets the players battle sprite to a specific one.
-
#set_self_switch(value, self_switch, event_id = @event_id, map_id = @map_id)
(also: #set_ss)
Set the value of a self_switch.
-
#show_pokemon(pokemon_id)
Show the Pokemon dex info.
-
#skill_learn(pokemon, id_skill) ⇒ Boolean
(also: #enseigner_capacite)
Learn a skill to a Pokemon.
-
#start_contest(creature_position, coordinator1_id, coordinator2_id, coordinator3_id, condition: :cool, rank: :normal, bgm: DEFAULT_CONTEST_BGM)
Start a contest.
-
#start_double_trainer_battle(trainer_id, second_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block)
Start a trainer battle.
-
#start_double_trainer_battle_with_friend(trainer_id, second_trainer_id, friend_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block)
Start a trainer battle.
-
#start_overlay(preset)
Start an overlay preset.
-
#start_pc
(also: #demarrer_pc)
Start the storage PC.
-
#start_trade(server)
Start an online Trade.
-
#start_trainer_battle(trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3)
Start a trainer battle.
-
#start_triple_trainer_battle(trainer_id, second_trainer_id, third_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block)
Start a triple trainer battle.
-
#start_triple_trainer_battle_with_friend(trainer_id, second_trainer_id, third_trainer_id, friend_trainer_id, second_friend_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block)
Start a triple trainer battle.
-
#steal_pokemon(indexes, id_storage = nil, no_save = false)
Save some Pokemon of the team somewhere and remove them from the party.
-
#stop_overlay
Clear overlay.
-
#stop_path
Shortcut for get_character(@event_id).stop_path.
-
#store_pokemon(pokemon_or_id, level = 5, shiny = false) ⇒ PFM::Pokemon?
(also: #stocker_pokemon)
Store a Pokemon in the PC.
-
#switch_player(from_player_id, to_player_id, switch_bag: true, switch_party: true, switch_trainer: true, switch_appearance: true, switch_money: true, switch_pokedex: true)
Switch from one player to another, in term of party, trainer, money, pokedex and appearance (all optional).
-
#switch_player_safe(to_player_id, switch_bag: true, switch_party: true, switch_trainer: true, switch_appearance: true, switch_money: true, switch_pokedex: true)
Switch from one player to another, in term of party, trainer, money, pokedex and appearance (all optional) The Yuki::Var::Current_Player_ID must be defined beforehand.
-
#take_screenshot(filename = 'map_screenshot%d.png', scale = 1)
Take a screenshot of the map and save it as a png.
-
#timed_event_remaining_time(event_id = @event_id, map_id = @map_id) ⇒ Integer
Get the remaining time until the trigger (in minutes).
-
#trainer_eye_sequence(phrase, eye_bgm: Configs.sounds.default_eye_bgm, exclamation_se: Configs.sounds.default_exclamation_se)
Sequence to call before start trainer battle.
-
#trigger_event_in(amount_of_minutes, local_switch_letter, event_id = @event_id, map_id = @map_id)
Store a timed event (will enable the desired local switch when the timer reached the amount of minutes).
-
#update_overlay_position(new_position)
Update the UV Resolver if there is a current preset with a position.
-
#wait_character_move_completion(event_id = @event_id)
(also: #attendre_fin_deplacement_cet_event, #wait_event, #attendre_event)
Wait for the end of the movement of this particular character.
-
#wait_charset_animation(event_id = @event_id)
Wait for the end of the charset animation of this particular event.
-
#wait_for_player
(also: #attendre_joueur)
Shortcut for wait_character_move_completion(0) Wait for the end of the player movement.
-
#waiting_animate_charset_event? ⇒ Boolean
Test if the Interpreter is currently waiting for an event.
-
#withdraw_pokemon(id, counter = 1)
(also: #retirer_pokemon)
withdraw a Pokemon from the Party.
-
#withdraw_pokemon_at(index)
(also: #retirer_pokemon_index)
withdraw a Pokemon from the party at a specific position in the Party.
-
#yes_no_choice(message, yes = nil, no = nil) ⇒ Boolean
Show a yes no choice.
Methods included from Util::SystemMessage
load_message, parse_opts, show_message, show_message_and_wait
Instance Method Details
#add_egg(id, egg_how_obtained = :received) ⇒ PFM::Pokemon? Also known as: ajouter_oeuf
Add an egg to the Party (or in the PC)
182 183 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 182 def add_egg(id, egg_how_obtained = :received) end |
#add_item(item_id, no_delete = false, text_id: 4, no_space_text_id: 7, color: 11, count: 1)
Add an item to the bag if possible, will delete the event forever
539 540 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 539 def add_item(item_id, no_delete = false, text_id: 4, no_space_text_id: 7, color: 11, count: 1) end |
#add_items_to_limited_shop(symbol_of_shop, items_to_refill = [], quantities_to_refill = []) Also known as: ajouter_objets_magasin
Add items to a limited shop
738 739 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 738 def add_items_to_limited_shop(symbol_of_shop, items_to_refill = [], quantities_to_refill = []) end |
#add_limited_shop(symbol_of_shop, items_sym = [], items_quantity = [], shop_rewrite: false) Also known as: ajouter_un_magasin_limite
Create a limited shop (in the main PFM::Shop object)
731 732 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 731 def add_limited_shop(symbol_of_shop, items_sym = [], items_quantity = [], shop_rewrite: false) end |
#add_new_pokemon_shop(sym_new_shop, list_id, list_price, list_param, list_quantity = [], shop_rewrite: false) Also known as: ajouter_nouveau_magasin_pokemon
Create a limited Pokemon Shop
768 769 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 768 def add_new_pokemon_shop(sym_new_shop, list_id, list_price, list_param, list_quantity = [], shop_rewrite: false) end |
#add_parallax(image, x, y, z, zoom_x = 1, zoom_y = 1, opacity = 255, blend_type = 0)
Add a parallax
420 421 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 420 def add_parallax(*args) end |
#add_pokemon(pokemon_or_id, level = 5, shiny = false) ⇒ PFM::Pokemon? Also known as: ajouter_pokemon, ajouter_stocker_pokemon
Add a pokemon to the party or store it in the PC
113 114 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 113 def add_pokemon(pokemon_or_id, level = 5, shiny = false) end |
#add_pokemon_to_shop(symbol_of_shop, list_id, list_price, list_param, list_quantity = [], pkm_rewrite: false) Also known as: ajouter_pokemon_au_magasin
Add Pokemon to a Pokemon Shop
778 779 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 778 def add_pokemon_to_shop(symbol_of_shop, list_id, list_price, list_param, list_quantity = [], pkm_rewrite: false) end |
#add_rename_pokemon(pokemon_or_id, level = 5, shiny = false, num_char = 12) ⇒ PFM::Pokemon? Also known as: ajouter_renommer_pokemon
Add a pokemon to the party or store it in the PC and rename it
174 175 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 174 def add_rename_pokemon(pokemon_or_id, level = 5, shiny = false, num_char = 12) end |
#add_specific_pokemon(hash) ⇒ PFM::Pokemon? Also known as: ajouter_pokemon_param
Add a pokemon (#add_pokemon) with specific informations
130 131 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 130 def add_specific_pokemon(hash) end |
#animate_from_charset(lines, duration, reverse: false, repeat: false, last_frame_delay: false) ⇒ Boolean
Shortcut for get_character(@event_id).animate_from_charset(*args)
456 457 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 456 def animate_from_charset(lines, duration, reverse: false, repeat: false, last_frame_delay: false) end |
#apply_message_font(font_id)
Apply a custom font to the message window
947 948 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 947 def (font_id) end |
#call_battle_wild(id, level, shiny, no_shiny) #call_battle_wild(id, level, *args) #call_battle_wild(id, level, *args) Also known as: demarrer_combat
Start a wild battle
200 201 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 200 def call_battle_wild(id, level, *args) end |
#call_party_menu(id_var = ::Yuki::Var::Party_Menu_Sel, party = $actors, mode = :map, extend_data = nil) Also known as:
Show the party menu in order to select a Pokemon
402 403 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 402 def (id_var = ::Yuki::Var::Party_Menu_Sel, party = $actors, mode = :map, extend_data = nil) end |
#can_move_reminder_be_called?(mode = 0) ⇒ Boolean Also known as: maitre_capacites_appelable?
Detect if the move reminder can remind a move to the selected pokemon
270 271 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 270 def can_move_reminder_be_called?(mode = 0) end |
#carte_du_monde(arg = :view, wm_id = $env.get_worldmap) Also known as: world_map
Open the world map
371 372 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 371 def carte_du_monde(arg = :view, wm_id = $env.get_worldmap) end |
#casino(arg = :voltorb_flip, speed = 2)
Open the casino gameplay
476 477 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 476 def casino(arg = :voltorb_flip, speed = 2) end |
#choice(variable_id, cancel_type, *choices)
Start a choice with more option than RMXP allows.
365 366 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 365 def choice(variable_id, cancel_type, *choices) end |
#clear_saved_fog
Clear the saved fog
83 84 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 83 def clear_saved_fog end |
#combine_with_saved_bag(id_storage = nil)
Combined the saved bag with the current bag
805 806 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 805 def combine_with_saved_bag(id_storage = nil) end |
#combine_with_saved_money(id_storage = nil)
Combined the saved money with the current money
845 846 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 845 def combine_with_saved_money(id_storage = nil) end |
#combine_with_saved_pokedex(id_storage = nil, empty_pokedex: false)
Combined the saved pokedex with the current pokedex
830 831 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 830 def combine_with_saved_pokedex(id_storage = nil, empty_pokedex: false) end |
#cry_pokemon(id, volume: 100, tempo: 100, form: 0)
Play the cry of a Pokemon
158 159 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 158 def cry_pokemon(id, volume: 100, tempo: 100, form: 0) end |
#current_overlay_preset ⇒ PFM::MapOverlay::PresetBase? Also known as: map_overlay
Get the current overlay preset
934 935 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 934 def end |
#current_time ⇒ Integer
Return the current time in minute
903 904 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 903 def current_time end |
#delete_event_forever(event_id) Also known as: delete_event
Delete the provided event forever
54 55 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 54 def delete_event_forever(event_id) end |
#delete_this_event_forever
Delete the current event forever
50 51 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 50 def delete_this_event_forever end |
#detect_invalid_tile(x, y, width, height, tile_id) ⇒ Boolean
Detect if a specified tile (in layer 3) is in the specified zone
76 77 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 76 def detect_invalid_tile(x, y, width, height, tile_id) end |
#detect_player(nb_pas, direction) ⇒ Boolean
Detect the player in a specific direction
34 35 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 34 def detect_player(nb_pas, direction) end |
#detect_player_circle(r) ⇒ Boolean
Detect the player in a circle around the event
47 48 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 47 def detect_player_circle(r) end |
#detect_player_rect(nx, ny) ⇒ Boolean
Detect the player in a rectangle around the event
41 42 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 41 def detect_player_rect(nx, ny) end |
#dynamic_light ⇒ NuriYuri::DynamicLight Also known as: dyn_light
Return the NuriYuri::DynamicLight module
304 305 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 304 def dynamic_light end |
#emotion(type, char_id = 0, wait = 34, params = {})
The available emotion type are :
- :exclamation
- :exclamation2
- :poison
- :interrogation
- :music
- :love
- :joy
- :sad
- :happy
- :angry
- :sulk
- :nocomment
Show an emotion to an event or the player
333 334 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 333 def emotion(type, char_id = 0, wait = 34, params = {}) end |
#emotion_on_multiple_npc(type, chars_id = [0], wait = 34, params = {}) Also known as: emotion_on_multiple_pnj
See the #emotion method comments for the available emotion type
Show an emotion on multiple events and/or the player
343 344 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 343 def emotion_on_multiple_npc(type, chars_id = [0], wait = 34, params = {}) end |
#empty_and_save_appearance(id_storage = nil)
Save the appearance somewhere and set the default in the point of view of the player.
850 851 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 850 def empty_and_save_appearance(id_storage = nil) end |
#empty_and_save_bag(id_storage = nil)
Save the bag somewhere and make it empty in the point of view of the player.
795 796 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 795 def empty_and_save_bag(id_storage = nil) end |
#empty_and_save_money(id_storage = nil)
Save the money somewhere and make it null in the point of view of the player.
835 836 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 835 def empty_and_save_money(id_storage = nil) end |
#empty_and_save_party(id_storage = nil)
Save the team somewhere and make it empty in the point of view of the player.
860 861 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 860 def empty_and_save_party(id_storage = nil) end |
#empty_and_save_pokedex(id_storage = nil)
Save the pokedex somewhere and make it empty in the point of view of the player.
820 821 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 820 def empty_and_save_pokedex(id_storage = nil) end |
#empty_and_save_trainer(id_storage = nil)
Save the trainer somewhere and make it empty in the point of view of the player.
810 811 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 810 def empty_and_save_trainer(id_storage = nil) end |
#event_calling(common_event, event_id) ⇒ Boolean
Check if an event is calling a common event (in its first non comment commands)
358 359 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 358 def event_calling(common_event, event_id) end |
#fast_travel(x, y = nil, ms = 5)
Shortcut defining the pathfinding request and wait for the end of the path following
448 449 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 448 def fast_travel(x, y = nil, ms = 5) end |
#find_path(to:, radius: 0, tries: Pathfinding::TRY_COUNT, type: nil, running: false)
Use path finding to locate the current event move else
439 440 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 439 def find_path(to:, radius: 0, tries: Pathfinding::TRY_COUNT, type: nil, running: false) end |
#force_save Also known as: forcer_sauvegarde
Save the game without asking
375 376 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 375 def force_save end |
#front_event_calling(common_event) ⇒ Boolean
Check if the front event calls a common event (in its first non comment commands)
352 353 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 352 def front_event_calling(common_event) end |
#ge(id = @event_id) ⇒ Game_Event
Return the $game_map.events
296 297 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 296 def ge(id = @event_id) end |
#get_self_switch(self_switch, event_id = @event_id, map_id = @map_id) ⇒ Boolean Also known as: get_ss
Get the value of a self_switch
393 394 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 393 def get_self_switch(self_switch, event_id = @event_id, map_id = @map_id) end |
#give_exp(index, amount)
Give a certain amount of exp to one Pokemon
504 505 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 504 def give_exp(index, amount) end |
#give_exp_all(amount)
Give a certain amount of exp to every Pokemon in party
508 509 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 508 def give_exp_all(amount) end |
#give_item(item_id, count = 1)
Give an item to the player
550 551 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 550 def give_item(item_id, count = 1) end |
#give_level(index, amount)
Give a certain amount of level to one Pokemon
513 514 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 513 def give_level(index, amount) end |
#give_level_all(amount)
Give a certain amount of level to every Pokemon in party
517 518 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 517 def give_level_all(amount) end |
#gm ⇒ Game_Map
Return the $game_map
288 289 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 288 def gm end |
#gp ⇒ Game_Player
Return the $game_player
292 293 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 292 def gp end |
#gs ⇒ Game_Switches
Return the $game_switches
280 281 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 280 def gs end |
#gt ⇒ Game_Temp
Return the $game_temp
284 285 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 284 def gt end |
#gv ⇒ Game_Variables
Return the $game_variables
276 277 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 276 def gv end |
#hall_of_fame(filename_bgm = 'audio/bgm/Hall-of-Fame', context_of_victory = :league)
Open the Hall of Fame UI
481 482 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 481 def hall_of_fame(filename_bgm = 'audio/bgm/Hall-of-Fame', context_of_victory = :league) end |
#hm_bar_animation_on_map(reason)
Triggers the HM Bar Animation
690 691 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 690 def (reason) end |
#honey_tree_event(id)
Function calling the honey tree event
96 97 |
# File 'docs/4_Systems_998_Global_Systems.rb', line 96 def honey_tree_event(id) end |
#internal_add_pokemon_check_level_shiny(pokemon_id, level, shiny, method_name) ⇒ PFM::Pokemon
Check the input parameters and send the Pokemon to method_name
252 253 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 252 def internal_add_pokemon_check_level_shiny(pokemon_id, level, shiny, method_name) end |
#internal_add_pokemon_check_symbol(pokemon_or_id, level, shiny, method_name) ⇒ PFM::Pokemon
Check the symbol of the Pokemon and send the Pokemon to method_name
244 245 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 244 def internal_add_pokemon_check_symbol(pokemon_or_id, level, shiny, method_name) end |
#internal_add_pokemon_final(pokemon) ⇒ PFM::Pokemon
Try to add Pokemon to the party or store the Pokemon in the storage system
236 237 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 236 def internal_add_pokemon_final(pokemon) end |
#internal_store_pokemon_final(pokemon) ⇒ PFM::Pokemon
Try to add Pokemon to the party or store the Pokemon in the storage system
257 258 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 257 def internal_store_pokemon_final(pokemon) end |
#message(string, cancel_type = 0, *choices) ⇒ Integer
This function should only be called from text events!
Show a message with eventually a choice
580 581 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 580 def (string, cancel_type = 0, *choices) end |
#mining_game(item_count, music_filename = GamePlay::MiningGame::DEFAULT_MUSIC) #mining_game(wanted_item_db_symbols, music_filename = GamePlay::MiningGame::DEFAULT_MUSIC)
Open the Mining Game UI
494 495 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 494 def mining_game(param = nil, music_filename = GamePlay::MiningGame::DEFAULT_MUSIC, delete_after: true, grid_handler: nil) end |
#mirror_picture(id, bool = true)
Mirror a RMXP Picture
499 500 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 499 def mirror_picture(id, bool = true) end |
#move_camera_to_event(event_id, duration, block_interpreter = true, distortion: :UNICITY_DISTORTION)
Smoothly move the map camera to a specific event over a given duration (in seconds)
96 97 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 96 def move_camera_to_event(event_id, duration, block_interpreter = true, distortion: :UNICITY_DISTORTION) end |
#move_camera_to_tiles(x, y, duration, block_interpreter = true, distortion: :UNICITY_DISTORTION)
Smoothly move the map camera to specific tile coordinates over a given duration (in seconds)
104 105 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 104 def move_camera_to_tiles(x, y, duration, block_interpreter = true, distortion: :UNICITY_DISTORTION) end |
#move_reminder(pokemon = $actors[$game_variables[::Yuki::Var::Party_Menu_Sel]], mode = 0) ⇒ Boolean Also known as: maitre_capacites
Call the move reminder UI with the choosen Pokemon and a specific mode (0 by default)
264 265 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 264 def move_reminder(pokemon = $actors[$game_variables[::Yuki::Var::Party_Menu_Sel]], mode = 0) end |
#name_player(default_name, character_filename, max_char = 12, message: [43, 0], set_appearance: true, &block)
Example: name_player("Yuri", "player_m_walk") or name_player("Yuri", "player_m_walk", set_appearance: false)
Shows a character, a default name, and asks the player for their name
876 877 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 876 def name_player(default_name, character_filename, max_char = 12, message: [43, 0], set_appearance: true, &block) end |
#npc_trade_sequence(index, pokemon)
Sequence that perform NPC trade
686 687 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 686 def npc_trade_sequence(index, pokemon) end |
#open_shop(items, prices) #open_shop(items, prices) Also known as: ouvrir_magasin
Open a shop
723 724 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 723 def open_shop(symbol_or_list, prices = {}, show_background: true) end |
#party ⇒ PFM::GameState
Return the party object (game state)
300 301 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 300 def party end |
#pfm_text ⇒ PFM::Text
Return the PFM::Text module
424 425 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 424 def pfm_text end |
#pick_item(item_id, count = 1, no_delete = false)
Pick an item on the ground (and delete the event)
545 546 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 545 def pick_item(item_id, count = 1, no_delete = false) end |
#player_spotted?(nb_pas) ⇒ Boolean Also known as: trainer_spotted
Detect if the event can spot the player and move to the player
9 10 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 9 def player_spotted?(nb_pas) end |
#player_spotted_directional?(up: nil, down: nil, left: nil, right: nil) ⇒ Boolean
Detect if the event can spot the player and move to the player with direction relative detection
27 28 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 27 def player_spotted_directional?(up: nil, down: nil, left: nil, right: nil) end |
#player_spotted_rect?(nb_pas, dist) ⇒ Boolean Also known as: trainer_spotted_rect
Detect if the event can spot the player in a certain rect in frond of itself
16 17 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 16 def player_spotted_rect?(nb_pas, dist) end |
#pokemon_hidden_power(index_or_pokemon)
Returns the db_symbol of the type of the Pokemon's Hidden Power
230 231 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 230 def pokemon_hidden_power(index_or_pokemon) end |
#pokemon_index(method_name, *args)
Return the index of the choosen Pokemon or call a method of GameState to find the right Pokemon
429 430 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 429 def pokemon_index(method_name, *args) end |
#open_shop(items, prices) #open_shop(items, prices) Also known as: ouvrir_magasin_pokemon
Open a Pokemon shop
758 759 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 758 def pokemon_shop_open(symbol_or_list, prices = [], param = [], show_background: true) end |
#pokemon_stored_sequence(pokemon)
Show the "Pokemon was sent to BOX $" message
618 619 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 618 def pokemon_stored_sequence(pokemon) end |
#puzzle_alpha(id = 1, id_switch = Yuki::Sw::RuinsVictory)
Start the Alpha Ruins puzzle
515 516 |
# File 'docs/4_Systems_900_Games.rb', line 515 def puzzle_alpha(id = 1, id_switch = Yuki::Sw::RuinsVictory) end |
#quest_book Also known as: livre_quetes, quest_ui
Show the quest book
406 407 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 406 def quest_book end |
#receive_pokemon_sequence(pokemon_or_id, level = 5, shiny = false) ⇒ PFM::Pokemon?
Receive Pokemon sequence, when the player is given a Pokemon
614 615 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 614 def receive_pokemon_sequence(pokemon_or_id, level = 5, shiny = false) end |
#remove_items_from_limited_shop(symbol_of_shop, items_to_remove, quantities_to_remove) Also known as: enlever_objets_magasin
Remove items from a limited shop
745 746 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 745 def remove_items_from_limited_shop(symbol_of_shop, items_to_remove, quantities_to_remove) end |
#remove_pokemon_from_shop(symbol_of_shop, remove_list_mon, param_form, quantities_to_remove = []) Also known as: enlever_pokemon_du_magasin
Remove Pokemon from a Pokemon Shop
786 787 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 786 def remove_pokemon_from_shop(symbol_of_shop, remove_list_mon, param_form, quantities_to_remove = []) end |
#rename_pokemon(index_or_pokemon, num_char = 12) Also known as: renommer_pokemon
Show the rename interface of a Pokemon
164 165 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 164 def rename_pokemon(index_or_pokemon, num_char = 12) end |
#reset_message_font
Reset the message window font to the default
950 951 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 950 def end |
#retrieve_saved_appearance(id_storage = nil)
Retrieve the saved appearance
855 856 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 855 def retrieve_saved_appearance(id_storage = nil) end |
#retrieve_saved_bag(id_storage = nil)
Retrieve the saved bag when emptied ( /!\ empty the current bag)
800 801 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 800 def retrieve_saved_bag(id_storage = nil) end |
#retrieve_saved_money(id_storage = nil)
Retrieve the saved money
840 841 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 840 def retrieve_saved_money(id_storage = nil) end |
#retrieve_saved_party(id_storage = nil) Also known as: retreive_saved_party
Retrieve the saved team when emptied ( /!\ empty the current team)
865 866 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 865 def retrieve_saved_party(id_storage = nil) end |
#retrieve_saved_pokedex(id_storage = nil)
Retrieve the saved pokedex when emptied
825 826 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 825 def retrieve_saved_pokedex(id_storage = nil) end |
#retrieve_saved_trainer(id_storage = nil)
Retrieve the saved trainer
815 816 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 815 def retrieve_saved_trainer(id_storage = nil) end |
#retrieve_stolen_pokemon(id_storage = nil) Also known as: retreive_stolen_pokemon
Retrieve previously stolen Pokemon ( /!\ uses #add_pokemon)
213 214 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 213 def retrieve_stolen_pokemon(id_storage = nil) end |
#save_this_fog ⇒ Array
Save the current fog
80 81 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 80 def save_this_fog end |
#set_actor_back(actor_id, filename)
Sets a specific actors battle sprite to a specific one
527 528 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 527 def set_actor_back(actor_id, filename) end |
#set_player_back(filename)
Sets the players battle sprite to a specific one
880 881 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 880 def set_player_back(filename) end |
#set_self_switch(value, self_switch, event_id = @event_id, map_id = @map_id) Also known as: set_ss
Set the value of a self_switch
384 385 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 384 def set_self_switch(value, self_switch, event_id = @event_id, map_id = @map_id) end |
#show_pokemon(pokemon) #show_pokemon(pokemon_id)
Show the Pokemon dex info
225 226 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 225 def show_pokemon(pokemon_id) end |
#skill_learn(pokemon, id_skill) ⇒ Boolean Also known as: enseigner_capacite
Learn a skill to a Pokemon
150 151 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 150 def skill_learn(pokemon, id_skill) end |
#start_contest(creature_position, coordinator1_id, coordinator2_id, coordinator3_id, condition: :cool, rank: :normal, bgm: DEFAULT_CONTEST_BGM)
Start a contest
700 701 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 700 def start_contest(creature_position, coordinator1_id, coordinator2_id, coordinator3_id, condition: :cool, rank: :normal, bgm: DEFAULT_CONTEST_BGM) end |
#start_double_trainer_battle(trainer_id, second_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block)
Start a trainer battle
639 640 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 639 def start_double_trainer_battle(trainer_id, second_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block) end |
#start_double_trainer_battle_with_friend(trainer_id, second_trainer_id, friend_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block)
Start a trainer battle
649 650 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 649 def start_double_trainer_battle_with_friend(trainer_id, second_trainer_id, friend_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block) end |
#start_overlay(preset)
Start an overlay preset
925 926 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 925 def (preset) end |
#start_pc Also known as: demarrer_pc
Start the storage PC
308 309 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 308 def start_pc end |
#start_trade(server)
Start an online Trade
218 219 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 218 def start_trade(server) end |
#start_trainer_battle(trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3)
Start a trainer battle
630 631 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 630 def start_trainer_battle(trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3) end |
#start_triple_trainer_battle(trainer_id, second_trainer_id, third_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block)
Start a triple trainer battle
659 660 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 659 def start_triple_trainer_battle(trainer_id, second_trainer_id, third_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block) end |
#start_triple_trainer_battle_with_friend(trainer_id, second_trainer_id, third_trainer_id, friend_trainer_id, second_friend_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block)
Start a triple trainer battle
671 672 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 671 def start_triple_trainer_battle_with_friend(trainer_id, second_trainer_id, third_trainer_id, friend_trainer_id, second_friend_trainer_id, bgm: Configs.sounds.base_trainer_battle_bgm, disable: 'A', enable: 'B', troop_id: 3, &block) end |
#steal_pokemon(indexes, id_storage = nil, no_save = false)
Save some Pokemon of the team somewhere and remove them from the party
208 209 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 208 def steal_pokemon(indexes, id_storage = nil, no_save = false) end |
#stop_overlay
Clear overlay
930 931 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 930 def end |
#stop_path
Shortcut for get_character(@event_id).stop_path
442 443 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 442 def stop_path end |
#store_pokemon(pokemon_or_id, level = 5, shiny = false) ⇒ PFM::Pokemon? Also known as: stocker_pokemon
Store a Pokemon in the PC
123 124 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 123 def store_pokemon(pokemon_or_id, level = 5, shiny = false) end |
#switch_player(from_player_id, to_player_id, switch_bag: true, switch_party: true, switch_trainer: true, switch_appearance: true, switch_money: true, switch_pokedex: true)
Switch from one player to another, in term of party, trainer, money, pokedex and appearance (all optional)
886 887 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 886 def switch_player(from_player_id, to_player_id, switch_bag: true, switch_party: true, switch_trainer: true, switch_appearance: true, switch_money: true, switch_pokedex: true) end |
#switch_player_safe(to_player_id, switch_bag: true, switch_party: true, switch_trainer: true, switch_appearance: true, switch_money: true, switch_pokedex: true)
Switch from one player to another, in term of party, trainer, money, pokedex and appearance (all optional) The Yuki::Var::Current_Player_ID must be defined beforehand
892 893 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 892 def switch_player_safe(to_player_id, switch_bag: true, switch_party: true, switch_trainer: true, switch_appearance: true, switch_money: true, switch_pokedex: true) end |
#take_screenshot(filename = 'map_screenshot%d.png', scale = 1)
Take a screenshot of the map and save it as a png
522 523 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 522 def take_screenshot(filename = 'map_screenshot%d.png', scale = 1) end |
#timed_event_remaining_time(event_id = @event_id, map_id = @map_id) ⇒ Integer
Get the remaining time until the trigger (in minutes)
918 919 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 918 def timed_event_remaining_time(event_id = @event_id, map_id = @map_id) end |
#trainer_eye_sequence(phrase, eye_bgm: Configs.sounds.default_eye_bgm, exclamation_se: Configs.sounds.default_exclamation_se)
Sequence to call before start trainer battle
681 682 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 681 def trainer_eye_sequence(phrase, eye_bgm: Configs.sounds.default_eye_bgm, exclamation_se: Configs.sounds.default_exclamation_se) end |
#trigger_event_in(amount_of_minutes, local_switch_letter, event_id = @event_id, map_id = @map_id)
Store a timed event (will enable the desired local switch when the timer reached the amount of minutes)
912 913 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 912 def trigger_event_in(amount_of_minutes, local_switch_letter, event_id = @event_id, map_id = @map_id) end |
#update_overlay_position(new_position)
(if not directly instanciating the UVResolver, use :game_player for player's coordinates, array of two numbers for custom coordinates)
Update the UV Resolver if there is a current preset with a position
942 943 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 942 def (new_position) end |
#wait_character_move_completion(event_id = @event_id) Also known as: attendre_fin_deplacement_cet_event, wait_event, attendre_event
Wait for the end of the movement of this particular character
59 60 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 59 def wait_character_move_completion(event_id = @event_id) end |
#wait_charset_animation(event_id = @event_id)
Wait for the end of the charset animation of this particular event
460 461 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 460 def wait_charset_animation(event_id = @event_id) end |
#wait_for_player Also known as: attendre_joueur
Shortcut for wait_character_move_completion(0) Wait for the end of the player movement
469 470 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 469 def wait_for_player end |
#waiting_animate_charset_event? ⇒ Boolean
This function automatically update the states it use if it returns false
Test if the Interpreter is currently waiting for an event
465 466 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 465 def waiting_animate_charset_event? end |
#withdraw_pokemon(id, counter = 1) Also known as: retirer_pokemon
withdraw a Pokemon from the Party
137 138 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 137 def withdraw_pokemon(id, counter = 1) end |
#withdraw_pokemon_at(index) Also known as: retirer_pokemon_index
withdraw a Pokemon from the party at a specific position in the Party
142 143 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 142 def withdraw_pokemon_at(index) end |
#yes_no_choice(message, yes = nil, no = nil) ⇒ Boolean
Show a yes no choice
591 592 |
# File 'docs/2_PSDK_Event_Interpreter.rb', line 591 def yes_no_choice(, yes = nil, no = nil) end |