Variables globales du script

Variables globales du script

Les variables suivantes sont disponibles dans le script.

(Pour les personnages, CHARID est le numéro d'identification (ID) du personnage défini dans l'Editeur AGS). Les noms en gras sont des variables en lecture seule et NE sont PAS modifiables par le script.

Toutes les variables suivantes sont de type int (entières), sauf character[].name, qui est une string, ainsi que system.version.

character[CHARID].name Le nom complet du personnage

game.abort_key Le numéro de la touche qui permet de quitter le jeu, même lorsque votre script freeze. La valeur par défaut est 324, et correspond à la combinaison de touches Alt+X.

game.ambient_sounds_persist Si cette variable vaut 0 (par défaut), les sons ambiants cessent lors d'un changement de pièce. Donnez lui la valeur 1 pour qu'AGS continue de jouer les sons ambiants lors des changements de pièce.

game.anim_background_speed La vitesse actuelle d'animation de l'arrière-plan de la pièce - les valeurs sont les mêmes que dans l'éditeur.

game.auto_use_walkto_points Vaut 1 par défaut, donnez la valeur 0 pour qu'AGS n'utilise plus les points d'accès (walk-to points) des hotspots automatiquement.

game.bgspeech_game_speed Si la valeur est 0 (par défaut), le discours en arrière-plan restera affiché à l'écran un certain temps, défini et constant. Si la valeur est 1, le temps d'affichage sera alors relatif à la vitesse du jeu.

game.bgspeech_stay_on_display Si cette variable vaut 0 (par défaut), le discours en arrière-plan est effacé lorsqu'une commande Say intervient ; si elle vaut 1, ce ne sera pas le cas.

game.close_mouth_end_speech_time A la fin du texte de discours, l'animation de discours s'arrêtera au bout de ce nombre de cycles de jeu. La valeur par défaut est 10. Cela n'a pas d'effet pour le mode vocal.

game.debug_mode Retourne 1 si le jeu est en mode debug, sinon 0.

game.dialog_options_x Ecart horizontal entre les choix dans les dialogues.

game.dialog_options_y Ecart vertical entre les choix dans les dialogues.

game.disable_antialiasing Donnez la valeur 1 à cette variable pour désactiver le lissage des personnages redimensionnés, indépendamment du choix de l'utilisateur dans le Setup. La valeur par défaut est 0.

game.following_room_timer Correspond au temps à attendre avant que le personnage n'arrive dans une nouvelle pièce. La valeur par défaut est 150 (plus la valeur est haute, plus le temps à attendre est long).

game.inv_activated Correspond à l'objet d'inventaire dernièrement sélectionné. A utiliser notamment dans la fonction unhandled_event.

game.inventory_greys_out Donnez la valeur 1 à cette variable pour que les éléments de l'inventaire soient grisés lorsque les GUI désactivés le sont.

game.lipsync_speed Similaire à game.text_speed, mais cette variable-ci détermine à quelle vitesse le texte sera 'prononcé' par les mouvements de la bouche. Normalement, vous devriez définir cette variable à des valeurs supérieures à text_speed, sinon la prononciation sera coupée lorsque le texte s'effacera. La valeur par défaut est 15.

game.max_dialogoption_width Correspond la largeur maximum que peut prendre la boîte de texte affichant les choix des dialogues. La valeur par défaut est 180.

game.min_dialogoption_width Correspond la largeur minium que peut prendre la boîte de texte affichant les choix des dialogues. La valeur par défaut est 0.

game.narrator_speech Correspond au numéro ID du personnage qu'utilisera la commande Display() pour le texte du narrateur. La valeur par défaut correspond à l'ID du personnage joueur initial. Vous pouvez également utiliser NARRATOR qui utilise le préfixe 'NARR' - personnage narrateur spécial.

game.no_textbg_when_voice Vaut normalement 0. Si la valeur est 1, et que le discours style Sierra avec arrière-plan est utilisé, alors les lignes de la voix off n'auront pas d'arrière-plan.

game.roomscript_finished Vaut 0 tant que la fonction on_cal n'a pas fini son exécution. (Voir CallRoomScript)

game.room_height Retourne la hauteur, selon l'échelle de coordonnées 320x200, de la pièce actuelle.

game.room_width Retourne la largeur, selon l'échelle de coordonnées 320x200, de la pièce actuelle.

game.score Retourne le score du joueur. Utilisez la fonction GiveScore pour modifier le score.

game.score_sound Retourne le numéro du son à jouer lorsque le joueur obtient des points, initialement défini dans l'éditeur.

game.screenshot_height Correspond à la hauteur des images captures d'écrans lorsqu'elles sont sauvées dans les parties. La taille maximale correspond au plein écran (320x200), qui offre la meilleure qualité mais qui alourdit le poids des fichiers de sauvagerdes. La taille par défaut est 160x100.

game.screenshot_width Correspond à la largeur des images captures d'écrans lorsqu'elles sont sauvées dans les parties.

game.show_single_dialog_option Vaut 1 si, lorsqu'un seul choix est disponile un dialogue, celui-ci sera tout de même affiché. La valeur par défaut est 0.

game.sierra_inv_color Correspond à la couleur d'arrière-plan de l'inventaire dans le style Sierra.

game.skip_display Définit le temps après lequel les messages Display() sont effacés ; les valeurs possibles sont les mêmes que pour SetSkipSpeech (la valeur par défaut est 3).

game.skip_speech_specific_key Correspond à la valeur de la touche qui permet de passer les textes de discours. La valeur par défaut est 0 (ce qui signifie "aucune touche").

game.skipping_cutscene Retourne 1 si une scène cinématique (cutscene) est en train d'être passée au lieu d'être jouée dans son intégralité (c'est-à-dire, si EndCutscene() n'a pas encore été appelée pour la scène en cours).

game.speech_bubble_width Largeur maximale de la bulle utilsée pour affichée le texte des pensées (vaut 100 par défaut)

game.speech_music_drop Définit la baisse de volume lorsque du discours est prononcé (la valeur par défaut est 60).

game.speech_text_align Définit la façon dont le texte de discours dans le style Lucasarts est aligné. Les valeurs possibles sont les mêmes que pour game.text_align, et celle par défaut est eAlignCentre (texte centré).

game.speech_text_gui Correspond au numéro de la fenêtre du GUI qui est utilisé pour afficher le discours dans le style Sierra.

game.talkanim_speed Correspond à la vitesse d'animation pour les vues de dialogue (la valeur par défaut est 5).

game.text_align Définit la façon dont le texte est aligné dans les fenêtres messages, dans le style de discours Sierra :
eAlignLeft : le texte est aligné à gauche dans la boîte de messages (par défaut)
eAlignCentre : le texte est centré dans la boîte de messages
eAlignRight : le texte est aligné à droite dans la boîte de messages (par défaut)
Cette variable ne définit pas les discours de type Lucasarts, qui est centré par défaut (voir game.speech_text_align).

game.text_shadow_color Correspond à la couleur utilisée pour l'ombrage du texte de discours (par défaut, vaut 16).

game.text_speed Définit le temps après lequel le texte de discours est effacé de l'écran. Par défaut, la valeur est 15 ; plus la valeur est haute, plus le texte sera effacé rapidement.

game.top_bar_XXXX Permet de personnaliser le comportement de DisplayTopBar, cliquez sur le lien pour les détails.

game.total_score Définit le score maximum, initialement défini dans l'éditeur.

game.used_mode Correspond au mode de curseur utilisé lors du dernier clic effectué (à utiliser dans les événéments "any click" ("Tout clic") afin de déterminer quel mode a été utilisé).

gs_globals[50] Désormais obsolète, mais ceci est un tableau global de 50 ints accessible depuis les script global et les scripts locaux, vous pourrez donc le trouver intéressant.

mouse.x Retourne la coordonnée X de la souris lors du dernier cycle de jeu (en résolution 320)

mouse.y Retourne la coordonnée Y de la souris lors du dernier cycle de jeu (en résolution 320)

palette[SLOT].r Correspond au taux de rouge utilisé dans la couleur contenue à l'emplacement SLOT de la palette (les valeurs vont de 0 à 63).

palette[SLOT].g Correspond au taux de vert utilisé dans la couleur contenue à l'emplacement SLOT de la palette (les valeurs vont de 0 à 63).

palette[SLOT].b Correspond au taux de bleu utilisé dans la couleur contenue à l'emplacement SLOT de la palette (les valeurs vont de 0 à 63).

player.[x,y,name,...] Permet de pointer vers le personnage joueur actuel. Exemple : player.x retournera la même valeur que cEgo.x si EGO est le personnage joueur actuel.

savegameindex[20] Position de l'emplacement de sauvegarde - voir la description de ListBox.FillSaveGameList dans la partie Scripting pour plus d'informations.

system.screen_height Retourne la résolution verticale de l'écran (200,240,400,480 ou 600). Voir Note1.

system.screen_width Retourne la résolution horizontale de l'écran (320,640 ou 800).

system.color_depth Retourne la profondeur des couleurs (8,15,16,24 ou 32).

system.os Retourne la version de l'interprète (1 = DOS, 2 = Windows, 3 = Linux, 4 = MacOS).

system.windowed Retourne le mode dans lequel le jeu tourne : 0 = plein écran, 1 = fenêtre.

system.vsync Lorsque cette variable vaut 1, les images sont synchronisées avec le rafraîchissement de l'écran en mode plein écran, pour éliminer les trainées lors du scrolling (déplacement de l'écran). La valeur par défaut est 0.

system.viewport_width Retourne la largeur de la fenêtre d'affichage (320 ou 400).

system.viewport_height Retourne la hauteur de la fenêtre d'affichage (200, 240 ou 300).

system.version Retourne une String contenant la version de la machine, "2.71.631" par exemple.

Notes:

(1) Cette information système est prévue pour vous aider à adapter le comportement de votre jeu selon la résolution utilisée, s'il le faut ; cependant, N'utilisez PAS cette information pour forcer le joueur à utiliser une résolution en particulier. Le moteur AGS est prévu pour s'adapter aux différentes caractéristiques de l'ordinateur du joueur, afin de rendre le jeu le plus agréable, rapide et maniable possible ; les utilisateurs qui possèdent un 486 préféreront sûrement voir des graphisme pixellisés en 320x200 plutôt qu'être forcés à jouer très lentement en 640x400.

character[CHARID].name	Le nom complet du personnage
game.abort_key	Le numéro de la touche qui permet de quitter le jeu, même lorsque votre script freeze. La valeur par défaut est 324, et correspond à la combinaison de touches Alt+X.
game.ambient_sounds_persist	Si cette variable vaut 0 (par défaut), les sons ambiants cessent lors d'un changement de pièce. Donnez lui la valeur 1 pour qu'AGS continue de jouer les sons ambiants lors des changements de pièce.
game.anim_background_speed	La vitesse actuelle d'animation de l'arrière-plan de la pièce - les valeurs sont les mêmes que dans l'éditeur.
game.auto_use_walkto_points	Vaut 1 par défaut, donnez la valeur 0 pour qu'AGS n'utilise plus les points d'accès (walk-to points) des hotspots automatiquement.
game.bgspeech_game_speed	Si la valeur est 0 (par défaut), le discours en arrière-plan restera affiché à l'écran un certain temps, défini et constant. Si la valeur est 1, le temps d'affichage sera alors relatif à la vitesse du jeu.
game.bgspeech_stay_on_display	Si cette variable vaut 0 (par défaut), le discours en arrière-plan est effacé lorsqu'une commande Say intervient ; si elle vaut 1, ce ne sera pas le cas.
game.close_mouth_end_speech_time	A la fin du texte de discours, l'animation de discours s'arrêtera au bout de ce nombre de cycles de jeu. La valeur par défaut est 10. Cela n'a pas d'effet pour le mode vocal.
game.debug_mode	Retourne 1 si le jeu est en mode debug, sinon 0.
game.dialog_options_x	Ecart horizontal entre les choix dans les dialogues.
game.dialog_options_y	Ecart vertical entre les choix dans les dialogues.
game.disable_antialiasing	Donnez la valeur 1 à cette variable pour désactiver le lissage des personnages redimensionnés, indépendamment du choix de l'utilisateur dans le Setup. La valeur par défaut est 0.
game.following_room_timer	Correspond au temps à attendre avant que le personnage n'arrive dans une nouvelle pièce. La valeur par défaut est 150 (plus la valeur est haute, plus le temps à attendre est long).
game.inv_activated	Correspond à l'objet d'inventaire dernièrement sélectionné. A utiliser notamment dans la fonction unhandled_event.
game.inventory_greys_out	Donnez la valeur 1 à cette variable pour que les éléments de l'inventaire soient grisés lorsque les GUI désactivés le sont.
game.lipsync_speed	Similaire à game.text_speed, mais cette variable-ci détermine à quelle vitesse le texte sera 'prononcé' par les mouvements de la bouche. Normalement, vous devriez définir cette variable à des valeurs supérieures à text_speed, sinon la prononciation sera coupée lorsque le texte s'effacera. La valeur par défaut est 15.
game.max_dialogoption_width	Correspond la largeur maximum que peut prendre la boîte de texte affichant les choix des dialogues. La valeur par défaut est 180.
game.min_dialogoption_width	Correspond la largeur minium que peut prendre la boîte de texte affichant les choix des dialogues. La valeur par défaut est 0.
game.narrator_speech	Correspond au numéro ID du personnage qu'utilisera la commande Display() pour le texte du narrateur. La valeur par défaut correspond à l'ID du personnage joueur initial. Vous pouvez également utiliser NARRATOR qui utilise le préfixe 'NARR' - personnage narrateur spécial.
game.no_textbg_when_voice	Vaut normalement 0. Si la valeur est 1, et que le discours style Sierra avec arrière-plan est utilisé, alors les lignes de la voix off n'auront pas d'arrière-plan.
game.roomscript_finished	Vaut 0 tant que la fonction on_cal n'a pas fini son exécution. (Voir CallRoomScript)
game.room_height	Retourne la hauteur, selon l'échelle de coordonnées 320x200, de la pièce actuelle.
game.room_width	Retourne la largeur, selon l'échelle de coordonnées 320x200, de la pièce actuelle.
game.score	Retourne le score du joueur. Utilisez la fonction GiveScore pour modifier le score.
game.score_sound	Retourne le numéro du son à jouer lorsque le joueur obtient des points, initialement défini dans l'éditeur.
game.screenshot_height	Correspond à la hauteur des images captures d'écrans lorsqu'elles sont sauvées dans les parties. La taille maximale correspond au plein écran (320x200), qui offre la meilleure qualité mais qui alourdit le poids des fichiers de sauvagerdes. La taille par défaut est 160x100.
game.screenshot_width	Correspond à la largeur des images captures d'écrans lorsqu'elles sont sauvées dans les parties.
game.show_single_dialog_option	Vaut 1 si, lorsqu'un seul choix est disponile un dialogue, celui-ci sera tout de même affiché. La valeur par défaut est 0.
game.sierra_inv_color	Correspond à la couleur d'arrière-plan de l'inventaire dans le style Sierra.
game.skip_display	Définit le temps après lequel les messages Display() sont effacés ; les valeurs possibles sont les mêmes que pour SetSkipSpeech (la valeur par défaut est 3).
game.skip_speech_specific_key	Correspond à la valeur de la touche qui permet de passer les textes de discours. La valeur par défaut est 0 (ce qui signifie "aucune touche").
game.skipping_cutscene	Retourne 1 si une scène cinématique (cutscene) est en train d'être passée au lieu d'être jouée dans son intégralité (c'est-à-dire, si EndCutscene() n'a pas encore été appelée pour la scène en cours).
game.speech_bubble_width	Largeur maximale de la bulle utilsée pour affichée le texte des pensées (vaut 100 par défaut)
game.speech_music_drop	Définit la baisse de volume lorsque du discours est prononcé (la valeur par défaut est 60).
game.speech_text_align	Définit la façon dont le texte de discours dans le style Lucasarts est aligné. Les valeurs possibles sont les mêmes que pour game.text_align, et celle par défaut est eAlignCentre (texte centré).
game.speech_text_gui	Correspond au numéro de la fenêtre du GUI qui est utilisé pour afficher le discours dans le style Sierra.
game.talkanim_speed	Correspond à la vitesse d'animation pour les vues de dialogue (la valeur par défaut est 5).
game.text_align	Définit la façon dont le texte est aligné dans les fenêtres messages, dans le style de discours Sierra : eAlignLeft : le texte est aligné à gauche dans la boîte de messages (par défaut) eAlignCentre : le texte est centré dans la boîte de messages eAlignRight : le texte est aligné à droite dans la boîte de messages (par défaut) Cette variable ne définit pas les discours de type Lucasarts, qui est centré par défaut (voir game.speech_text_align).
game.text_shadow_color	Correspond à la couleur utilisée pour l'ombrage du texte de discours (par défaut, vaut 16).
game.text_speed	Définit le temps après lequel le texte de discours est effacé de l'écran. Par défaut, la valeur est 15 ; plus la valeur est haute, plus le texte sera effacé rapidement.
game.top_bar_XXXX	Permet de personnaliser le comportement de DisplayTopBar, cliquez sur le lien pour les détails.
game.total_score	Définit le score maximum, initialement défini dans l'éditeur.
game.used_mode	Correspond au mode de curseur utilisé lors du dernier clic effectué (à utiliser dans les événéments "any click" ("Tout clic") afin de déterminer quel mode a été utilisé).
gs_globals[50]	Désormais obsolète, mais ceci est un tableau global de 50 ints accessible depuis les script global et les scripts locaux, vous pourrez donc le trouver intéressant.
mouse.x	Retourne la coordonnée X de la souris lors du dernier cycle de jeu (en résolution 320)
mouse.y	Retourne la coordonnée Y de la souris lors du dernier cycle de jeu (en résolution 320)
palette[SLOT].r	Correspond au taux de rouge utilisé dans la couleur contenue à l'emplacement SLOT de la palette (les valeurs vont de 0 à 63).
palette[SLOT].g	Correspond au taux de vert utilisé dans la couleur contenue à l'emplacement SLOT de la palette (les valeurs vont de 0 à 63).
palette[SLOT].b	Correspond au taux de bleu utilisé dans la couleur contenue à l'emplacement SLOT de la palette (les valeurs vont de 0 à 63).
player.[x,y,name,...]	Permet de pointer vers le personnage joueur actuel. Exemple : player.x retournera la même valeur que cEgo.x si EGO est le personnage joueur actuel.
savegameindex[20]	Position de l'emplacement de sauvegarde - voir la description de ListBox.FillSaveGameList dans la partie Scripting pour plus d'informations.
system.screen_height	Retourne la résolution verticale de l'écran (200,240,400,480 ou 600). Voir Note1.
system.screen_width	Retourne la résolution horizontale de l'écran (320,640 ou 800).
system.color_depth	Retourne la profondeur des couleurs (8,15,16,24 ou 32).
system.os	Retourne la version de l'interprète (1 = DOS, 2 = Windows, 3 = Linux, 4 = MacOS).
system.windowed	Retourne le mode dans lequel le jeu tourne : 0 = plein écran, 1 = fenêtre.
system.vsync	Lorsque cette variable vaut 1, les images sont synchronisées avec le rafraîchissement de l'écran en mode plein écran, pour éliminer les trainées lors du scrolling (déplacement de l'écran). La valeur par défaut est 0.
system.viewport_width	Retourne la largeur de la fenêtre d'affichage (320 ou 400).
system.viewport_height	Retourne la hauteur de la fenêtre d'affichage (200, 240 ou 300).
system.version	Retourne une String contenant la version de la machine, "2.71.631" par exemple.