Préambule

J'avais réalisé une documentation supplémentaire (il y a presque 3 ans) et je ne l'ai jamais partagé car je n'ai pas eu le temps de le terminer.

Auteur

Samarium
Vous pouvez modifier et diffuser ce tutorial (merci de citer l'auteur ci-dessus si diffusion)

But

Documentation supplémentaire sur des variables globales :

Code: Tout sélectionner

$game_temp          = Game_Temp.new
$game_system        = Game_System.new
$game_switches      = Game_Switches.new
$game_variables     = Game_Variables.new
$game_self_switches = Game_SelfSwitches.new
$game_screen        = Game_Screen.new
$game_actors        = Game_Actors.new
$game_party         = Game_Party.new
$game_troop         = Game_Troop.new
$game_map           = Game_Map.new
$game_player        = Game_Player.new

Par exemple :

Code: Tout sélectionner

$game_system.me_play(me)

Que fait ce code ? La documentation précise :



Documentation

Temp

Nom de la variable : $game_temp

Classe : Game_Temp

Classe parente : Object

Attributs :

map_bgm
Mémorise la musique de la carte afin de la jouer après un combat.
Retourne : RPG::AudioFile
Lisible/Modifiable

message_text
Enregiste le texte du dernier message. Quand le message est terminé, celui ci est effacé (mis à "nil")
Retourne : String
Lisible/Modifiable

System

Nom de la variable : $game_system

Classe : Game_System

Classe parente : Object

Attributs :

map_interpreter
Liste des commandes d'évènement et paramètres de l'évènement.
Retourne : Interpreter
Lisible

battle_interpreter
Liste des commandes d'évènement et paramètres pendant un combat.
Retourne : Interpreter
Lisible

timer
Temps restant de la commande d'évènement chronomètre après l'avoir lancé (en frame).
Retourne : Integer
Lisible/Modifiable

timer_working
Renvoie TRUE si la commande d'évènement chronomètre est lancé
Retourne : Booléen
Lisible/Modifiable

save_disabled
Renvoie TRUE si le menu sauvegarde est désactivé
Retourne : Booléen
Lisible/Modifiable

menu_disabled
Renvoie TRUE si le menu est désactivé
Retourne : Booléen
Lisible/Modifiable

encounter_disabled
Renvoie TRUE si la rencontre de monstres est désactivé
Retourne : Booléen
Lisible/Modifiable

message_position
La position de la boite de dialogue : 0 = Haut, 1 = Milieu, 2 = Bas
Retourne : Integer
Lisible/Modifiable

message_frame
Boite de dialogue transparent ou non : 0 = Normal, 1 = Transparent
Retourne : Integer
Lisible/Modifiable

save_count
Nombre de sauvegardes effectués
Retourne : Integer
Lisible/Modifiable

Méthodes :

bgm_play(bgm)
Joue une musique.
Type du paramètre : RPG::AudioFile
Retourne : Nil

bgm_stop
Arrête la musique actuelle.
Retourne : Nil

bgm_fade(time)
"Fait disparaitre" la musique de fond sur une durée en secondes
Type du paramètre : Integer
Retourne : Nil

bgm_memorize
Mémorise la musique actuelle
Retourne : Nil

bgm_restore
Joue la musique mémorisé
Retourne : Nil

bgs_play(bgs)
Joue un fond sonore. Faites "bgs_play(nil)" pour arrêter le fond sonore.
Type du paramètre : RPG::AudioFile
Retourne : Nil

bgm_fade(time)
"Fait disparaitre" le fond sonore sur une durée en secondes
Type du paramètre : Integer
Retourne : Nil

bgs_memorize
Mémorise le fond sonore actuelle
Retourne : Nil

bgs_restore
Joue le fond sonore mémorisé
Retourne : Nil

me_play(me)
Joue un effet musical. Faites "me_play(nil)" pour arrêter l'effet musical.
Type du paramètre : RPG::AudioFile
Retourne : Nil

se_play(se)
Joue un effet sonore.
Type du paramètre : RPG::AudioFile
Retourne : Nil

se_stop
Arrête l'effet sonore en cours.
Retourne : Nil

playing_bgm
Renvoie la musique joué actuellement
Retourne : RPG::AudioFile

playing_bgs
Renvoie le fond sonore joué actuellement
Retourne : RPG::AudioFile

windowskin_name
Le nom du Windowskin
Retourne : String

battle_bgm
Renvoie la musique joué pendant les combats. Modifiable.
Retourne : RPG::AudioFile

battle_end_me
Renvoie la musique joué du fin de combat. Modifiable.
Retourne : RPG::AudioFile

Switches

Nom de la variable : $game_switches

Classe : Game_Switches

Classe parente : Object

Gestion des interrupteurs du jeu. ID est le numéro de l'interrupteur.

$game_switches[ID]
Renvoie TRUE si l'interrupteur est activé
Retourne : Booléen.

$game_switches[ID] = true/false
Active/Désactive un interrupteur
Retourne : Nil

Variables

Nom de la variable : $game_variables

Classe : Game_Variables

Classe parente : Object

Gestion des variables du jeu. ID est le numéro de la variable.

$game_variables[ID]
Renvoie la valeur de la variable
Retourne : Integer.


$game_variables[ID] = integer
Assigne une valeur à une variable
Retourne : Nil

SelfSwitches

Nom de la variable : $game_self_switches

Classe : Game_SelfSwitches

Classe parente : Object

Gestion des interrupteurs locaux du jeu. TAB_ID est un tableau de la forme :

[ID_MAP, ID_EVENT, LETTER]

où :

ID_MAP est le numéro de la map (Integer)
ID_EVENT est le numéro de l'évènement (Integer)
LETTER est la lettre de l'interrupteur local (String)


$game_self_switches[TAB_ID]
Renvoie TRUE si l'interrupteur local est activé
Retourne : Booléen.


$game_self_switches[TAB_ID] = true/false
Active/Désactive un interrupteur local
Retourne : Nil

Screen

Nom de la variable : $game_screen

Classe : Game_Screen

Classe parente : Object

Attributs :

tone
Le ton de l'écran actuelle
Retourne : Tone
Lisible

flash_color
La couleur du flash en cours
Retourne : Color
Lisible

shake
Différence entre la position de départ de l'écran et la position de l'écran décalé (grâce à la commande "Faire trembler l'écran".
Retourne : Float
Lisible

pictures
Les images utilisées via la commande d'évènement "Afficher une image"
Retourne : Array
Lisible

weather_type
Le type d'effet météorologique actuelle. 0: aucun, 1: pluie, 2:orage; 3: neige
Retourne : Integer
Lisible

weather_max
L'intensité de l'effet météorologique en cours
Retourne : Float
Lisible

Méthodes :

start_tone_change(tone, duration)
Change le ton de l'écran pendant une certaine durée (En frame)
Type des paramètres : tone : Tone, duration : Integer
Retourne : Nil

start_flash(color, duration)
Fait un flash sur l'écran pendant une certaine durée
Type des paramètres : tone : Color, duration : Integer
Retourne : Nil

start_shake(power, speed, duration)
Secoue l'écran avec une intensité (power), une vitesse (speed) et une certaine durée (duration)
Type des paramètres : power : Integer, speed : Integer, duration : Integer
Retourne : Nil


weather(type, power, duration)
Faire uh effet météorolique (type = 0: aucun, 1: pluie, 2:orage; 3: neige), une intensité (power) et pendant une certaine durée.
Type des paramètres : type : Integer, power : Integer, duration : Integer
Retourne : Nil


Actors

Nom de la variable : $game_actors

Classe : Game_Actors

Classe parente : Object

Gestion des héros du jeu. ID est le numéro du héros dans la base de données.

$game_actors[ID]
Renvoie les caractéristiques du héros n°ID
Retourne : Game_Actor.

Actor

Nom de la variable : $game_actors[ID]

Classe : Game_Actor

Classe_parente : Game_Battler

name
Nom du héros
Retourne : String
Lisible

character_name
Nom de l'image utilisé pour le héros
Retourne : String
Lisible

character_hue
La valeur d'ajustement pour le ton de l'image du héros (0..360)
Retourne : Integer
Lisible

class_id
L'ID de la classe du héros
Retourne : Integer
Lisible

weapon_id
ID de l'arme du héros équipée initialement.
Retourne : Integer
Lisible

armor1_id
ID du bouclier du héros équipé initialement.
Retourne : Integer
Lisible

armor2_id
ID du casque du héros équipé initialement.
Retourne : Integer
Lisible

armor3_id
ID de l'armure du héros équipée initialement.
Retourne : Integer
Lisible

armor4_id
ID de l'accessoire du héros équipé initialement.
Retourne : Integer
Lisible

level
Niveau actuelle du héros
Retourne : Integer
Lisible

exp
Expérience actuelle du héros
Retourne : Integer
Lisible

skills
Les ID des compétences que possèdent le héros actuellement
Retourne : Array
Lisible

Méthode :

id
ID du héros
Retourne : Integer

index
Renvoie la position dans le tableau de l'ID du héros
Retourne : Integer

maxhp
Le nombre maximum de point de vie actuelle du héros
Retourne : Integer

equip(equip_type, id)
Equipe le héros d'une arme (equip_type = 0), d'un bouclier (equip_type = 1), d'un casque (equip_type = 2), d'une armure (equip_type = 3) ou d'un accessoire (equip_type = 4) selon son ID (id)
Type des paramètres : equip_type : Integer, id : Integer
Retourne : Nil

equippable?(item)
Renvoie TRUE si l'armure ou arme peut être équipé sur le héros.
Type du paramètre : Object
Retourne : booléen

exp=(exp)
Fixe l'expérience au héros : $game_actors[ID].exp = exp
Type du paramètre : Integer
Retourne : Nil

level=(level)
Fixe le niveau du héros : $game_actors[ID].exp = exp
Type du paramètre : Integer
Retourne : Nil

learn_skill(skill_id)
Fait apprendre une compétence au héros. skill_id est l'ID de la compétence
Type du paramètre : Integer
Retourne : Nil

forget_skill(skill_id)
Fait oublier une compétence au héros. skill_id est l'ID de la compétence
Type du paramètre : Integer
Retourne : Nil

skill_learn?(skill_id)
Renvoie TRUE si la compétence peut être apprise. skill_id est l'ID de la compétence
Type du paramètre : Integer
Retourne : Booléen

skill_can_use?(skill_id)
Renvoie TRUE si la compétence peut être utilisée. skill_id est l'ID de la compétence
Type du paramètre : Integer
Retourne : Booléen


name=(name)
Donne un nom au héros : $game_actors[ID].name = name
Type du paramètre : String
Retourne : Nil

class_id=(class_id)
Fixe la classe du héros : $game_actors[ID].class_id = class_id
Type du paramètre : Integer
Retourne : Nil

set_graphic(character_name, character_hue, battler_name, battler_hue)
Change l'apparence du héros. "character_name" est le nom de l'image, "character_hue" le ton de l'image, "battler_name", le nom de l'image pour les combats, "battler_hue" le ton de l'image pour les combats
Type des paramètres : character_name : String, character_hue : Integer, battler_name : String, battler_hue : Integer
Retourne : Nil

Party

Nom de la variable : $game_party

Classe : Game_Party

Classe_parente : Object

Attributs :

actors
Les héros dans l'équipe actuelle
Retourne : Array (avec des élèments de type Game_Actor)
Lisible

golds
Le nombre d'argent possédé
Retourne : Integer
Lisible

steps
le nombre de pas actuel
Retourne : Integer
Lisible

Méthodes :

setup_starting_members
Téléporte l'équipe sur le point de départ du jeu.
Retourne : Nil

setup_battle_test_members
Commence le test d'un combat
Retourne : Nil

max_level
Renvoie le plus grand niveau atteint dans l'équipe.
Retourne : Integer

add_actor(actor_id)
Ajoute un héros dans l'équipe. actor_id est l'ID du héros a ajouté
Type de paramètre : Integer
Retourne : Nil

remove_actor(actor_id)
Enlève un héros dans l'équipe. actor_id est l'ID du héros a enlever
Type de paramètre : Integer
Retourne : Nil

gain_gold(n)
Ajoute n argent.
Type de paramètre : Integer
Retourne : Nil

lose_gold(n)
Enlève n argent.
Type de paramètre : Integer
Retourne : Nil

increase_steps
Ajoute 1 au nombre de pas actuel
Retourne : Nil

item_number(item_id)
Le nombre d'objets d'ID "item_id" possédés
Type de paramètre : Integer
Retourne : Integer

weapon_number(weapon_id)
Le nombre d'armes d'ID "item_id" possédées
Type de paramètre : Integer
Retourne : Integer

armor_number(armor_id)
Le nombre d'armuress d'ID "armor_id" possédées
Type de paramètre : Integer
Retourne : Integer

gain_item(item_id, n)
Ajoute n objet d'ID "item_id"
Type des paramètres : item_id : Integer, n : Integer
Retourne : Nil

gain_weapon(weapon_id, n)
Ajoute n arme d'ID "weapon_id"
Type des paramètres : weapon_id : Integer, n : Integer
Retourne : Nil

all_dead?
Renvoie TRUE si tout l'équipe est tuée (Tout les PV à 0)
Retourne : Booléen

Troop

Nom de la variable : $game_troop

Classe : Game_Troop

Classe_parente : Object

Méthodes :

enemies
Les ennemies présents dans le combat en cours.
Retourne : Array (Les élèments sont de types Game_Enemy)

Map

Nom de la variable : $game_map

Classe : Game_Map

Classe_parente : Object

Attributs :

tileset_name
Nom du tilesets actuel
Retourne : String
Lisible/Modifiable

autotile_names
Nom des autotiles actuels
Retourne : Array (Les élèments sont de types String)
Lisible/Modifiable

panorama_name
Nom du paronama pour ce tileset
Retourne : String
Lisible/Modifiable

panorama_hue
Ton du paronama
Retourne : Integer
Lisible/Modifiable

fog_name
Nom du fichier "brouillard" actuel
Retourne : String
Lisible/Modifiable

fog_hue
Ton du brouillard
Retourne : Integer
Lisible/Modifiable

fog_opacity
L'opacité du brouillard (0 à 255)
Retourne : Integer
Lisible/Modifiable

fog_blend_type
La transparence du brouillard
Retourne : Integer
Lisible/Modifiable

fog_zoom
Pourcentage du zomm du brouillard. Par défaut : 200%
Retourne : Integer
Lisible/Modifiable

fog_sx
Vitesse horizontale du brouillard
Retourne : Integer
Lisible/Modifiable

fog_sy
Vitesse verticale du brouillard
Retourne : Integer
Lisible/Modifiable

battleback_name
Nom du fichier "Fond de combat" pour la carte actuelle
Retourne : String
Lisible/Modifiable

display_x
Déplacement horizontal de l'écran depuis la position du héros
Retourne : Integer
Lisible/Modifiable

display_y
Déplacement vertical de l'écran depuis la position du héros
Retourne : Integer
Lisible/Modifiable

need_refresh
Rafraichir les évènements (communs) sur la carte actuelle. Si cette attribut est mis sur TRUE, il sera mis automatiquement sur FALSE à la fin du rafraichissement.
Retourne : Booléen
Lisible/Modifiable

passages
Carreau (Tiles) pouvant être traversé par le héros
Retourne : Table (une dimension : l'élément est l'ID du Tile)
Lisible

priorities
Priorité de superposition d'un carreau (Tiles)
Retourne : Table (une dimension : l'élément est l'ID du Tile)
Lisible

terrain_tags
ID du carreau (Tiles)
Retourne : Table (une dimension : l'élément est l'ID du Tile)
Lisible

events
Liste des évènements de la carte
Retourne : Hash (Clé de type "Integer" ; Valeur de type "Game_Event")
Lisible

fog_ox
Position X d'origine du brouillard
Retourne : Float
Lisible

fog_oy
Position Y d'origine du brouillard
Retourne : Float
Lisible

fog_tone
Ton actuel du brouillard
Retourne : Tone
Lisible

Méthodes :

map_id
ID de la carte actuelle
Retourne : Integer

width
Largeur de la carte (en carreau)
Retourne : Integer

height
Hauteur de la carte (en carreau)
Retourne : Integer

encounter_list
La liste des ID des monstres que le héros peut rencontrer sur la carte
Retourne : Array

encounter_step
Le nombre de pas en moyenne pour que le héros commence un combat sur la carte
Retourne : Integer

data
Tableau à 3 dimensions contenant les ID des carreaux (Tiles) sur la carte
Retourne : Table (3 dimensions : [Position X, Position Y, Couche])

autoplay
Joue automatiquement la musique et le fond sonore de la carte
Retourne : Nil

scroll_down(distance)
Déplacement de l'écran vers le bas sur une distance de n carreaux
Type du paramètre : Integer
Retourne : Nil

scroll_left(distance)
Déplacement de l'écran vers la gauche sur une distance de n carreaux
Type du paramètre : Integer
Retourne : Nil

scroll_right(distance)
Déplacement de l'écran vers la droite sur une distance de n carreaux
Type du paramètre : Integer
Retourne : Nil

scroll_up(distance)
Déplacement de l'écran vers le haut sur une distance de n carreaux
Type du paramètre : Integer
Retourne : Nil

valid?(x,y)
Renvoie TRUE si les positions indiquées (x et y) sont bien sur la carte
Type des paramètres : x : Integer ; y : Integer
Retourne : Booléen

passable?(x, y, d, self_event = nil)
Renvoie True si le carreau sur les positions indiquées (x et y) ainsi que la direction (d) peut être franchie
Type des paramètres : x : Integer ; y : Integer ; d : Integer (0,2,4,6,8,10) ; self_event : Integer
Retourne : Booléen

bush?(x, y)
Renvoie True si le carreau sur les positions indiquées (x et y) est un carreau obsurcissant
Type des paramètres : x : Integer ; y : Integer
Retourne : Booléen

counter?(x, y)
Renvoie True si le carreau sur les positions indiquées (x et y) est un carreau d'interaction
Type des paramètres : x : Integer ; y : Integer
Retourne : Booléen

terrain_tag(x, y)
ID du carreau sur les positions indiquées (x et y)
Type des paramètres : x : Integer ; y : Integer
Retourne : Integer

check_event(x, y)
ID de l'évènement sur les positions indiquées (x et y)
Type des paramètres : x : Integer ; y : Integer
Retourne : Integer

start_scroll(direction, distance, speed)
Commence le déplacement de l'écran sur une direction donnée, une distance (en carreau) à une certaine vitesse (speed)
Type des paramètres : direction : Integer ; distance : Integer ; speed : Integer
Retourne : Nil

scrolling?
Renvoie TRUE si le déplacement de l'écran est en cours
Retourne : Booléen

start_fog_tone_change(tone, duration)
Commence le changement de ton du brouillard (tone) sur une durée en frames (duration)
Type des paramètres : tone : Tone ; duration : Integer
Retourne : Nil

start_fog_opacity_change(opacity, duration)
Commence le changement d'opacité (entre 0 et 255) du brouillard (opacity) sur une durée en frames (duration)
Type des paramètres : opacity : Integer ; duration : Integer
Retourne : Nil