Ceci est une ancienne révision du document !
Cette section liste les fonctions et propriétés communes à tous les types de contrôles GUI.
Chaque type de contrôle (Button, ListBox, etc.) possède également sa section spécifique.
(Anciennement GetGUIObjectAt, désormais obsolète)
static GUIControl* GUIControl.GetAtScreenXY(int x, int y)
Vérifie s'il y a un contrôle GUI aux coordonnées (X,Y) de l'écran. Retourne l'objet
contrôle s'il y en a un, ou null sinon. Vous voudrez probablement
utiliser cette fonction avec GetGUIAtLocation.
Exemple :
GUIControl *leControle = GUIControl.GetAtScreenXY(mouse.x, mouse.y); if (leControle == lstPartiesSauvees) { Display("La souris survole la liste Parties Sauvées."); } else if (leControle == null) { Display("La souris ne survole pas de contrôle."); } else { GUI *surGui = leControle.OwningGUI; Display("La souris survole le contrôle numéro %d du GUI numéro %d.", theControl.ID, onGui.ID); }
affichera le contrôle que survole la souris.
Voir aussi : GUI.GetAtScreenXY
Button* GUIControl.AsButton; InvWindow* GUIControl.AsInvWindow; Label* GUIControl.AsLabel; ListBox* GUIControl.AsListBox; Slider* GUIControl.AsSlider; TextBox* GUIControl.AsTextBox;Convertie un pointeur GUIControl* générique en une variable du type correct, et la retourne. Si le contrôle n'est pas du type requis, retourne null.
Button *leBouton = gBarreIcones.Controls[2].AsButton; if (leBouton == null) { Display("Le contrôle 2 n'est pas un bouton !!!!"); } else { leButton.NormalGraphic = 44; }
tentera d'attribuer la sprite 44 comme NormalGraphic au Bouton 2 du GUI BarreIcones,
mais si ce n'est en fait pas un bouton, affichera une image.
Voir aussi : GUI.Controls
GUIControl.BringToFront()Place le contrôle au-dessus de tous les autres. Ceci vous permet de réarranger l'ordre d'affichage des contrôle dans le GUI.
btnGrosBouton.BringToFront();
placera le bouton btnGrosBouton au-dessus de tous les autres contrôle du GUI.
Voir aussi : GUIControl.SendToBack
bool GUIControl.ClickableRetourne/Définit si l'on peut cliquer sur le contrôle du GUI.
btnSauverPartie.Clickable = false;
rendra le bouton btnSauverPartie non-cliquable.
Voir aussi : GUIControl.Enabled
(Anciennement SetGUIObjectEnabled, désormais obsolète)
bool GUIControl.Enabled
Active ou désactive le contrôle de GUI.
Normalement, vous vos contrôles de GUI (boutons, ascenseurs, etc.) sont activés en permanence
sauf lors d'une cutscene (cinématique), durant lesquelles ils sont désactivés. Cette commande
vous permet de désactiver explicitement un contrôle par le script.
Si vous donnez true, le contrôle sera activé ; donnez false pour le désactiver.
Que vous l'activiez ou non, il sera toujours désactivé lors d'une cutscene bloquante,
ainsi que tous les autres contrôles.
Lorsqu'un contrôle est désactivé, il ne répondra pas aux clics de souris. Si c'est un bouton,
ses images de survol et de pression ne seront pas affichées. Le contrôle sera dessiné selon
les réglages du jeu “When GUI Disabled” (”Lorsque GUI Désactivé”), comme d'habitude.
S'applique à
Hérité par Button, InvWindow, Label, ListBox, Slider and TextBox.
Exemple :
btnSauverPartie.Enabled = false;
désactivera le bouton btnSauverPartie.
Voir aussi : GUIControl.Clickable,
GUIControl.Visible
int GUIControl.Height;Retourne/Définit la hauteur du contrôle de GUI. Ceci vous permet de redimensionner dynamiquement le contrôle du GUI lors de l'exécution du jeu.
btnConfirmer.Height = 20;
fera que le bouton btnConfirmer fera 20 pixels de haut.
Voir aussi : GUIControl.SetSize,
GUIControl.Width
readonly int GUIControl.IDRetourne le numéro ID du contrôle de GUI. Ceci est le numéro de l'objet contrôle dans l'éditeur de GUI, et est pratique si vous devez gérer du code ancien qui utilise le numéro du contrôle plutôt que son nom d'objet.
SetGUIObjectEnabled(lstSauvegardes.OwningGUI.ID, lstSauvegardes.ID, 1); lstSauvegardes.Enabled = false;
utilise la fonction obsolète SetGUIObjectEnabled pour activer la liste lstSauvegardes,
puis utilise la propriété actuelle équivalente pour la désactiver.
Voir aussi : GUIControl.OwningGUI, GUI.ID
readonly GUI* GUIControl.OwningGUIRetourne le GUI qui contient le contrôle.
GUI *legui = lstSauvegardes.OwningGUI; legui.Visible = false; lstSauvegardes.OwningGUI.Visible = true;
efface le GUI qui contient la liste lstSauvegardes, puis l'affiche à nouveau en utilisant
une approche sans pointeur intermédiaire.
Voir aussi : GUIControl.ID, GUI.ID
GUIControl.SendToBack()Place ce contrôle à l'arrière-plan. Ceci vous permet de réarranger l'ordre d'affichage des contrôle dans le GUI.
btnGrosBouton.SendToBack();
placera le bouton btnGrosBouton derrière tous les autres contrôle du GUI.
Voir aussi : GUIControl.BringToFront
(Anciennement SetGUIObjectPosition, désormais obsolète)
GUIControl.SetPosition(int x, int y)
Déplace le coin supérieur gauche du contrôle de GUI à (X,Y). Ces coordonnées sont
relatives au GUI qui contient le contrôle.
Ceci vous permet de déplacer dynamiquement les contrôles de GUI à l'écran durant l'exéuction
du jeu, et pourrait être assez utile avec GUI.SetSize si vous voulez proposer un GUI
redimensionnable dynamiquement.
S'applique à
Hérité par Button, InvWindow, Label, ListBox, Slider and TextBox.
Exemple :
btnConfirmer.SetPosition(40, 10);
déplacera le bouton btnConfirmer pour le positionner à (40,10) dans le GUI.
Voir aussi : GUIControl.Enabled,
GUI.SetPosition, GUIControl.SetSize,
GUIControl.X, GUIControl.Y
(Anciennement SetGUIObjectSize, désormais obsolète)
GUIControl.SetSize(int largeur, int hauteur)
Redimensionne le contrôle de GUI spécifié à LARGEUR x HAUTEUR.
Ceci vous permet de redimensionner dynamiquement les contrôles de GUI à l'écran
durant l'exécution du jeu et pourrait être assez utile avec GUI.SetSize et
GUIControl.SetPosition si vous voulez créer un GUI dynamiquement redimensionnable.
S'applique à
Hérité par Button, InvWindow, Label, ListBox, Slider and TextBox.
Exemple :
invMain.SetSize(160, 100);
redimensionne le contrôle invMain à la taille 160 x 100.
Voir aussi : GUIControl.Height,
GUIControl.SetPosition,
GUI.SetSize,
GUIControl.Width,
bool GUIControl.VisibleRetourne/Définit si le contrôle de GUI est visible. Vaut true par défaut, mais vous pouvez donner la valeur false afin d'enlever temporairement le contrôle du GUI.
btnPartiesSauvees.Visible = false;
rendra le bouton btnPartiesSauvees invisible.
Voir aussi : GUIControl.Enabled
int GUIControl.Width;Retourne/Définit la largeur du contrôle du GUI. Ceci vous permet de redimensionner dynamiquement vos contrôles de GUI durant l'exécution du jeu.
btnConfirmer.Width = 110;
donne une largeur de 110 pixels au bouton btnConfirm.
Voir aussi : GUIControl.Height,
GUIControl.SetSize
int GUIControl.X;Retourne/Définit la position X du contrôle de GUI. Ceci spécifie son bord droit, et est relatif au GUI qui contient le contrôle.
btnConfirmer.X = 10;
déplacera le bouton btnConfirmer afin de le positionner à 10 pixels à partir de la gauche du GUI.
Voir aussi : GUIControl.SetPosition,
GUIControl.Y
int GUIControl.Y;Retourne/Définit la position Y du contrôle de GUI. Ceci spécifie le bord du haut, et est relatif au GUI qui contient le contrôle.
btnConfirmer.Y = 20;
déplacera le bouton btnConfirmer afin de le positionner à 20 pixels à partir du haut du GUI.
Voir aussi : GUIControl.SetPosition,
GUIControl.X