Liste des commandes de script

De Wiki Pokémon SDK
Aller à : navigation, rechercher

Sur cette page, vous trouverez toutes les commandes de script permettant de réaliser vos évènements.

Sommaire

Ajout de Pokémon

Ajouter un Pokémon à l'équipe

ajouter_pokemon(arg1, arg2, arg3)

Alias : add_pokemon, ajouter_stocker_pokemon

Description

Permet d'ajouter un Pokémon à l'équipe (ou à défaut le stocker dans le PC). Cette fonction retourne le Pokémon en question ou nil (en cas d'échec).
Si le Pokémon a été stocké, l'interrupteur 9 : Pokémon Stocké ? sera activé et la variable 4 : Boite PC actuelle contiendra le id de boite, ajoutez 1 à la variable pour obtenir le n° de la boite.

Description des arguments

arg1 
ID du Pokémon ou Pokémon en question.
Lorsque arg1 est un Pokémon (PFM::Pokemon), arg2 et arg3 ne servent à rien.
arg2 
Niveau du Pokémon (défaut : 5). Argument optionnel.
arg3 
Caractère Shiny du Pokémon (défaut : false). Argument optionnel.
Si arg3 vaut 0, le Pokémon n'aura aucune chance d'être Shiny.
Si arg3 vaut un nombre entier positif, le Pokémon aura une chance sur arg3 d'être Shiny.

Exemples

Ajout d'un Pikachu niveau 36 : add_pokemon(25, 36)
Ajout d'un Mew Shiny niveau 100 : add_pokemon(151, 100, true)
Ajout d'un Tortipouss niveau 5 shiny une chance sur 2 : add_pokemon(387, 5, 2)

Ajouter un Pokémon paramétré à l'équipe

ajouter_pokemon_param(infos)

Alias : add_specific_pokemon

Description

Permet d'ajouter un Pokémon à l'équipe, mais un Pokémon avec des caractères que vous pouvez définir. Les caractères sont disponible sur la page suivante : PFM::Pokemon partie "Clés de hash"

Le comportement de cette appel de script est similaire à la fonction "ajouter_pokemon".

Exemples

Ajouter un Pikachu femelle capturé dans une Master Ball : add_specific_pokemon(id: 25, level: 5, gender: 2, ball: 1)
Ajouter un Goupix Alola : add_specific_pokemon(id: 37, level: 5, form: 1)
Ajouter un Pokémon d'un PNJ : add_specific_pokemon(id: 25, level: 40, trainer_id: 12345, trainer_name: "Gary", given_name: "Pokucha")

Ajouter un Pokémon dans le PC

stocker_pokemon(arg1, arg2, arg3)

Alias : store_pokemon

Description

Ajoute un Pokémon directement dans le PC de stockage. Les arguments sont les mêmes que pour la fonction "#Description_des_arguments ajouter_pokemon".

Ajouter un Oeuf

ajouter_oeuf(arg1)

Alias : add_egg

Description

Fonction permettant d'ajouter un oeuf à l'équipe (ou le stocker dans le PC). Le comportement de cette appel de script est similaire à la fonction "ajouter_pokemon".

Description des arguments

arg1 
ID du Pokémon dans l'œuf ou...
Hash de paramétrage du Pokémon à la même manière que Ajout de Pokémon paramétré (Attention, disponible uniquement à partir de l'Alpha 21 de PSDK).

Exemples

Ajouter un œuf de Pikachu : add_egg(25)
Ajouter un oeuf de Goupix Alola : add_egg(id: 25, level: 1, form: 1)

Retrait de Pokémon

Retirer un Pokémon de l'équipe en fonction de son ID

retirer_pokemon(arg1, arg2)

Alias : withdraw_pokemon

Description

Retire un ou plusieurs Pokémon de l'équipe en fonction de l'id fourni.

Description des arguments

arg1 
ID du Pokémon à retirer
arg2 
Nombre de Pokémon de cet id à retirer (défault: 1). Argument optionnel.

Retirer un Pokémon de l'équipe en fonction de sa position

retirer_pokemon_index(arg1)

Alias : withdraw_pokemon_at

Description des arguments

arg1 
Position du Pokémon à retirer dans l'équipe. Le premier est en position 0, le 6ème en position 5.

Manipulation des Pokémon

Apprendre une attaque à un Pokémon

enseigner_capacite(arg1, arg2)

Alias : skill_learn

Description

Permet au dresseur de faire apprendre une attaque à un Pokémon (ouvre la fenêtre d'apprentissage).

Description des arguments

arg1 
Pokémon (PFM::Pokemon) à qui apprendre la capacité.
arg2 
ID de l'attaque dans la base de données.

Exemples

Apprendre Torgnoles au premier Pokémon de l'équipe : skill_learn($actors.first, 3)
Apprendre Torgnoles au deuxième Pokémon de l'équipe : skill_learn($actors[1], 3)
Apprendre Vol au dernier Pokémon de l'équipe : skill_learn($actors.last, 19)
Apprendre Aboiement à un Pokémon qui vient d'être ajouté :

pokemon = add_pokemon(25, 30)
skill_learn(pokemon, 555) if pokemon

Renommer un Pokémon

renommer_pokemon(arg1, arg2)

Alias : rename_pokemon

Description

Permet d'ouvrir l'interface de renommage du Pokémon.

Description des arguments

arg1 
Pokémon à renommer (PFM::Pokemon) ou...
Index du Pokémon à renommer dans l'équipe
arg2 
Nombre de caractères pour le nom (défaut : 10). Argument optionnel.

Exemples

Renommer le premier Pokémon de l'équipe avec 5 caractères : rename_pokemon($actors.first, 5)
Renommer un Pokémon choisi dans l'interface de l'équipe :

call_party_menu
rename_pokemon(gv[::Yuki::Var::TMP1]) if gv[::Yuki::Var::TMP1] >= 0


Commande de gameplay

Jouer le cri d'un Pokémon

cry_pokemon(arg1)

Description des arguments

arg1 
ID du Pokémon pour lequel il faut jouer le cri.

Afficher un choix ayant plus que 4 options

choice(arg1, arg2, *args)

Description

Cette commande permet d'afficher plusieurs choix et de stocker le choix réalisé dans une variable. Si la première option est choisie, la variable vaut 1, si la seconde est choisie, elle vaut 2 etc...

Description des arguments

arg1 
ID de la variable qui recevra le résultat du choix.
arg2 
Si cet argument est supérieur à 0, il indique le numéro du choix qui sera pris en cas d'annulation.
args 
Liste des options possibles.

Exemple

Choix qui sera stocké dans la variable 5 et qui n'a pas d'annulation possible :

choice(5, 0, "Rouge", "Bleu", "Vert", "Jaune", "Or", "Argent", "Cristal")

Choix qui sera stocké dans la variable 5 et qui a pour annulation le 7ème choix :

choice(5, 7, "Rouge", "Bleu", "Vert", "Jaune", "Or", "Argent", "Cristal")

Le résultat sera 6 si on appuie sur B (X).

Démarrer un combat contre un sauvage

demarrer_combat(arg1, arg2, *args)

Alias : call_battle_wild

Description

Démarre un combat contre un ou plusieurs Pokémon sauvages. /!\ La définition ne vaut qu'à partir de la version Alpha 21

Description des arguments

arg1 
ID du premier Pokémon ou...
Premier Pokémon (PFM::Pokemon)
arg2 
Niveau du premier Pokémon
args[0] 
Caractère Shiny du Premier Pokémon si c'est un combat 1v1 (arg1 doit être un nombre) ou...
ID du deuxième Pokémon ou...
Deuxième Pokémon (PFM::Pokemon)
args[1] 
Caractère Non Shiny du Premier Pokémon si c'est un combat 1v1 (arg1 doit être un nombre) ou...
Niveau du deuxième Pokémon

Exemples

Démarrer un combat 1v1 contre un Rattata niveau 5 : demarrer_combat(19, 5)
Démarrer un combat 1v1 contre un Rattata niveau 5 Shiny : demarrer_combat(19, 5, true)
Démarrer un combat 1v1 contre un Rattata niveau 5 non shiny : demarrer_combat(19, 5, false, true)
Démarrer un combat 2v2 contre un Rattatac niveau 25 et un rattata niveau 5 : demarrer_combat(20, 25, 19, 5)
Démarrer un combat 1v1 contre un Goupix forme Alola : demarrer_combat(PFM::Pokemon.generate_from_hash(id: 37, level: 5, form: 1), 5)
Démarrer un combat 2v2 complètement paramétré :

pokemon1 = PFM::Pokemon.generate_from_hash(id: 37, level: 5, form: 1)
pokemon2 = PFM::Pokemon.generate_from_hash(id: 37, level: 5, ability: 22) #Peau sèche
demarrer_combat(pokemon1, 5, pokemon2)

Détecter le joueur à une certaine distance

trainer_spotted(arg1)

Alias : player_spotted?

Description

Permet de détecter le joueur à n pas à condition que le PNJ peut traverser (en l'absence de PNJ) les cases qui se trouvent entre lui et le joueur.

Description des arguments

arg1 
Nombre de cases que le PNJ peut traverser au maximum pour entrer en contact (détection) avec le héros.

Détecter le joueur à une certaine distance dans une certaine direction

detect_player(arg1, arg2)

Description

Permet de détecter le joueur sur une ligne d'un certain nombre de case dans une certaine direction par rapport à l'évènement.

Description des arguments

arg1 
Nombre de case devant l'évènement sur lesquelles le joueur peut être détecté.
arg2 
Direction de la détection par rapport à l'évènement (:up, :right, :down, :left, 8, 6, 4, 2)

Exemples

Détection vers la droite de 5 cases : detect_player(5, :right) ou detect_player(5, 6)
Détection vers le bas de 80 cases : detect_player(80, :down) ou detect_player(80, 2)
Détection vers la gauche de 3 cases : detect_player(3, :left) ou detect_player(3, 4)
Détection vers le haut de 33 cases : detect_player(33, :up) ou detect_player(33, 8)

Détecter si l'évènement face au joueur appelle in évènement commun

front_event_calling(arg1)

Description

Cette fonction est à appeler dans les évènement commun découlant de l'usage d'une CS (coupe, force etc...). Ceci permet à l'évènement commun lorsqu'il sera invoqué depuis le menu de savoir si l'usage de la capacité sert ou non à quelque chose. Cette fonction indiquera si en face du joueur se trouve un évènement qui appel (dans ses premières commandes) l'évènement commun désiré.

Description des arguments

arg1 
ID de l'évènement commun. (N'utilisez pas la notation commençant par 0, c'est de l'octal et n'a pas la même valeur que la base 10).

Forcer la sauvegarde

forcer_sauvegarde

Alias : force_save

Description

Lorsque cette commande sera exécutée, la partie sera sauvegardée sans qu'aucune interface ne soit affichée.

Commande d'affichage d'interface

Afficher le PC

demarrer_pc

Alias : start_pc

Description

Cette commande lance l'interface des PC.

Afficher la carte du monde

carte_du_monde(arg1)

Description

Cette commande affiche la carte du monde dans un mode spécifié.

Description des arguments

arg1 
Mode de la carte du monde, valeurs possibles : :fly, :view (Défaut : :view, optionnel).

Appeler l'interface de l'équipe

appel_menu_equipe(arg1, arg2, arg3)

Alias : call_party_menu

Description

Affiche l'interface de l'équipe dans un mode désiré (généralement pour choisir un Pokémon). Le résultat du choix sera enregistré dans la variable précisé en premier argument. Si aucun choix n'a été fait, la variable contiendra -1, sinon elle contiendra l'index du Pokémon choisi.

Description des arguments

arg1 
ID de la variable qui contiendra le résultat (Défaut : ::Yuki::Var::TMP1, Optionnel).
arg2 
Tableau de Pokémon représentant l'équipe dans laquelle on va choisir le Pokémon (Défaut : $actors, Optionnel).
arg3 
Mode de l'interface de l'équipe (Défaut : :map, Optionnel).

Ouvrir le livre des quêtes

livre_quetes

Alias : quest_book

Description

Commande affichant l'interface du livre des quêtes.

Commandes spéciales

Afficher une émotion

emotion(arg1, arg2, arg3)

Description

Cette commande affiche une bulle d'émotion sur l'évènement indiqué.

Description des arguments

arg1 
Type d'émotion à jouer, les valeurs possibles sont : :exclamation, :poison, :exclamation2, :interrogation, :music, :love, :joy, :sad, :happy, :angry, :sulk, :nocomment
arg2 
Paramètre désignant l'évènement sur qui affiche l'émotion. -1 indique le héros ou un de ses follower, 0 indique l'évènement ayant exécuté cette commande, un nombre entier positif cible l'évènement portant pour ID ce nombre. (Défault : 0, optionnel)
arg3 
Paramètre indiquant le nombre de frame que l'évènement attendra lors de l'exécution de la commande. (Défaut : 34, optionnel).

Afficher un parallax

add_parallax(arg1, arg2, arg3, arg4)

Description

Affiche une image qui sera fixé à une position relative à la MAP. L'image peut avoir plus ou moins de profondeur par rapport aux éléments de la MAP. /!\ Commande disponible uniquement à partir de l'Alpha 21 de PSDK.

Description des arguments

arg1 
Nom de l'image dans le dossier Pictures.
arg2 
Position x (déplacer d'un tile = 16 pixels)
arg3 
Position y (déplacer d'un tile = 16 pixels)
arg4 
Profondeur. Nombre négatif (entre -50 et -2000) affiche sous la MAP. Nombre positif (entre 1000 et 2000) affiche sur la MAP.

Modifier un interrupteur local

set_self_switch(arg1, arg2, arg3, arg4)

Description des arguments

arg1 
Valeur de l'interrupteur local (true/false)
arg2 
Nom de l'interrupteur local ("A", "B", "C", "D")
arg3 
ID de l'évènement qui voit normalement cet interrupteur local.
arg4 
ID de la carte qui contient normalement cet évènement (Défaut : @map_id, Optionnel).

Obtenir la valeur d'un interrupteur local

get_self_switch(arg1, arg2, arg3)

Description des arguments

arg1 
Nom de l'interrupteur local ("A", "B", "C", "D")
arg2 
ID de l'évènement qui voit normalement cet interrupteur local.
arg3 
ID de la carte qui contient normalement cet évènement (Défaut : @map_id, Optionnel).

Modifier une variable locale

set_local_variable(arg1, arg2, arg3, arg4)

Description des arguments

arg1 
Valeur de la variable locale (Nombre)
arg2 
Numéro de la variable locale
arg3 
ID de l'évènement qui voit normalement cette variable locale (Défaut : @event_id, Optionnel).
arg4 
ID de la carte qui contient normalement cet évènement (Défaut : @map_id, Optionnel).

Obtenir la valeur d'une variable locale

get_local_variable(arg1, arg2, arg3)

Description des arguments

arg1 
Numéro de la variable locale
arg2 
ID de l'évènement qui voit normalement cette variable locale (Défaut : @event_id, Optionnel).
arg3 
ID de la carte qui contient normalement cet évènement (Défaut : @map_id, Optionnel).