Logo Khaganat

Wikhan

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
en:configuration_interface_client [2019/10/11 14:58] – In part (until 3.2.4.) created Lea Calluen:configuration_interface_client [2021/12/03 18:19] (current) – external edit 127.0.0.1
Line 1: Line 1:
-====== Configuration de l'interface client ======+====== Client interface's configuration ======
  
 The client interface of the game (commonly called GUI : [[https://fr.wikipedia.org/wiki/Interface_graphique|Graphical User Interface]]) is managed by //.xml// files which are in the "code/ryzom/client/data/gamedev/interfaces_v3" source's repertory. The client interface of the game (commonly called GUI : [[https://fr.wikipedia.org/wiki/Interface_graphique|Graphical User Interface]]) is managed by //.xml// files which are in the "code/ryzom/client/data/gamedev/interfaces_v3" source's repertory.
Line 11: Line 11:
 Even it's partially corrected and reformated, this page still need work to be clear. Part of codes can be more understandebale in table. Don't hesitate to participe at the clarification, edit! Even it's partially corrected and reformated, this page still need work to be clear. Part of codes can be more understandebale in table. Don't hesitate to participe at the clarification, edit!
  
-\\ Done until [[#CONTROLS]] --- //[[wiki:user:yannk|YannK]] 2016/12/21 23:24//+\\ Done until [[#CONTROLS]] --- //[[user:yannk|YannK]] 2016/12/21 23:24//
 </WRAP> </WRAP>
  
Line 227: Line 227:
 DÉRIVÉ DE : [[#view_type_text|<view type="text" />]] DÉRIVÉ DE : [[#view_type_text|<view type="text" />]]
  
-BUT: +GOAL : Display a text according to a network identifier ( it's a charcaters line equivalent to //set_server_string(ah))//
  
-affiche un text en fonction d'un identifiant réseau (c'est une chaîne de caractères équivalent à //set_server_string(ah))// +^  Element  ^  Default value  ^  Use / Description  ^ 
- +|textid| |the identifier itself ("654123")  **MODIFIABLE**| 
-^  Élément  ^  Valeur par défaut  ^  Usage / Description  ^ +|textid_dblink | |database link to the idientifier ("UI:TEMP:VAR1") (string) **OPTIONNEL** **MODIFIABLE**| 
-|textid| |identifiant lui-même ("654123")  **MODIFIABLE**| +|dynamic_string|true|if true the sentence is composed (CStringManagerClient::getDynString), if not it's a server identifier (CStringManagerClient::getString)|
-|textid_dblink | |lien database vers un identifiant ("UI:TEMP:VAR1") (string) **OPTIONNEL** **MODIFIABLE**| +
-|dynamic_string|true|si true la phrase est composée (CStringManagerClient::getDynString), sinon c’est un identifiant server (CStringManagerClient::getString)|+
  
 == <view type="text_id_formated" /> == == <view type="text_id_formated" /> ==
Line 240: Line 238:
 DÉRIVÉ DE : [[#view_type_text_id|<view type="text_id" />]] DÉRIVÉ DE : [[#view_type_text_id|<view type="text_id" />]]
  
-BUT: +GOAL :  In the same idea of the //[[#view_type_text_formatted|VIEW text_formated]]//. It contain the same particular traitments that //text_formated// where you need to add :
  
-Un peu dans le même esprit que la //[[#view_type_text_formatted|VIEW text_formated]]//. Elle possède les mêmes traitements particuliers que //text_formated// auxquels il faut y rajouter :+  * $t -> replace by the id text value
  
-  * $t -> remplacé par la valeur du text id +Parameters : 
- +^  Element  ^  Default value  ^  Use / Description  ^ 
-Paramètres : +|format|$t|Bye default| 
-^  Élément  ^  Valeur par défaut  ^  Usage / Description  ^ +|textid| |For exemple :"SERVER:BOTCHAT:DM_CHOICE2:TITLE"|
-|format|$t|Par défaut| +
-|textid| | Par exemple :"SERVER:BOTCHAT:DM_CHOICE2:TITLE"|+
  
 ==== <view type="digit" /> ==== ==== <view type="digit" /> ====
  
-BUT:+GOAL: Special view wich display un number with special digits (bitmap).
  
-Vue spéciale qui affiche un nombre avec des digits spéciaux (bitmaps). +Parameterss : 
- +^  Element  ^  Default value  ^  Use / Description  ^ 
-Paramètres : +|value|SERVER:....|link on the database. **OBLIGATOIRE**| 
-^  Élément  ^  Valeur par défaut  ^  Usage / Description  ^ +|numdigit|2|digit's number display (eg 00 if void value). Default:2. Min:1 et Max: 10| 
-|value|SERVER:....|lien sur la database. **OBLIGATOIRE**| +|wspace|-1|pixel spacing between each digit. Default: -1| 
-|numdigit|2|nombre de digit affichs (eg 00 si la valeur est nulle). Defaut:2. Min:1 et Max: 10| +|color|255 255 255 255|like button, whithe is by défault|
-|wspace|-1|espacement en pixel entre chaque digit. Défaut: -1| +
-|color|255 255 255 255|comme les boutons, blanc par défaut|+
  
-La taille totale est automatiquement calculée en fonction du digit 0 et du nombre de digit.+The total size is automaticly calculate in function of the 0 digit and of the digit number.
  
 ===== CONTROLS ===== ===== CONTROLS =====
  
 DERIVE DE <view type="" /> DERIVE DE <view type="" />
-Un control a un type qui est défini par le paramètre type="".+A control has a type define by the type="" paramater.
  
 <WRAP prewrap 650px> <WRAP prewrap 650px>
 <code xml> <code xml>
 <ctrl type=""  <ctrl type="" 
- tooltip="" // aide contextuelle par défaut + tooltip="" // contextual help by default 
- tooltip_i18n="" // idem tooltip, mais cherche forcément la définition dans le wk.uxt, + tooltip_i18n="" // same for tooltip, but necessarily search the definition in the wk.uxt, 
- // même si le texte ne commence pas par "ui" + // even if the text don't start by "ui" 
- on_tooltip="" // action handler qui permet de mettre une autre aide contextuelle + on_tooltip="" // action handler wich allow to add an other contextual help 
- on_tooltip_params="" // les paramètres de l’action handler + on_tooltip_params="" // parameters of the handler action 
- instant_help="true" // Est-ce que l’aide contextuelle à afficher est affichée directement+ instant_help="true" // Is the contaxtual help is correclty display?
  
- tooltip_parent="ctrl" // "ctrl", "win" ou "mouse". Définit le parent relatif lors de l’affichage+ tooltip_parent="ctrl" // "ctrl", "win" or "mouse". Define the relative parent during the display
  // du tooltip.  // du tooltip.
- "ctrl" veut dire que le tooltip est calé par rapport à ce control + "ctrl" means that the tooltip is wedge against this control 
- "win" veut dire que le tooltip est affiché par rapport à la fenêtre + "win" means that the tooltip is display against the window 
- contenant le control + containing the control 
- "mouse" veut dire que le tooltip est calé par rapport à la souris + "mouse" means that the tooltip is wedge against the mouse 
- tooltip_posref="auto" // Position de référence du tooltip par rapport à son parent (cf tooltip_parent) + tooltip_posref="auto" // Position de tooltip reference against its parent (see tooltip_parent) 
- "auto" la position de référence est choisie intelligemment suivant le + "auto" the reference position is intelligemment choose following the 
- type de parent: + parent's type: 
- "ctrl": "TL BR" ou "TR BL" suivant que la fenêtre contenant + "ctrl": "TL BR" or "TR BL" following the window's container 
- le control est plus à gauche ou à droite + the control is more on the left or on the right 
- "win": "TL BL" ou "BL TL" suivant que la fenêtre contenant + "win": "TL BL" or "BL TL" following the window's container 
- le control est plus en haut ou en bas+ the control is more on the top or on the low
  "mouse": "BL BL"  "mouse": "BL BL"
- "TL BR" (ou toute autre position de référence possible): calage fixe+ "TL BR" (or all other reference position possible): fix wedge
  
 /> />
Line 305: Line 299:
 ==== <ctrl type="tooltip" /> ==== ==== <ctrl type="tooltip" /> ====
  
-BUT: +GOAL : Derivating control from ctrl_base, and wich manage no evenement and display nothing. Its only aim is to have a place to display a tooltip when the mouse pass on it.
-Control qui dérive simplement de ctrl_base, et qui ne gère aucun événement et n'affiche rien. +
-Son seul but est d'avoir une zone pour afficher un tooltip quand on passe dessus.+
  
-SYNTAXE:+SYNTAX:
 <WRAP prewrap 650px> <WRAP prewrap 650px>
 <code xml> <code xml>
Line 318: Line 310:
 ==== <ctrl type="button" /> ==== ==== <ctrl type="button" /> ====
  
-BUT: +GOAL : button, push, radio or toggle.
-boutton, push, radio ou toggle.+
  
-SYNTAXE:+SYNTAX:
 <WRAP prewrap 650px> <WRAP prewrap 650px>
 <WRAP prewrap 650px> <WRAP prewrap 650px>
 <code xml> <code xml>
 <ctrl type="button"  <ctrl type="button" 
- button_type="toggle_button" // type du bouton: "toggle_button", "push_button" ou "radio_button" + button_type="toggle_button" // button's type: "toggle_button", "push_button" or "radio_button" 
- pushed="false" // etat pushed par defaut + pushed="false" // pushed state by default 
- color="255 255 255 255" // couleur état normal + color="255 255 255 255" // color normal state 
- col_pushed="255 255 255 255" // couleur quand pushed + col_pushed="255 255 255 255" // color when pushed 
- col_over="255 255 255 255" // couleure quand over + col_over="255 255 255 255" // color when over 
- global_color_normal="" // remplace le setup global_color pour l’état normal du bouton + global_color_normal="" // replace the global_color setup for the normal state of the button 
- global_color_pushed="" // remplace le setup global_color pour l’état pushed du bouton + global_color_pushed="" // replace the  global_color setup for the pushed state of the button 
- global_color_over="" // remplace le setup global_color pour l’état over du bouton + global_color_over="" // replace the global_color setup for the over state of the button 
- tx_normal="" // texture état normal + tx_normal="" // normal state texture 
- tx_pushed="" // texture état pushed + tx_pushed="" // pushed statetexture 
- tx_over="" // texture etat over+ tx_over="" // over state texture
  scale="false"  scale="false"
- onclick_l="" // action à lancer sur un click gauche + onclick_l="" // action to launch on left click 
- params_l="" // paramètres de l’action à lancer sur un click gauche + params_l="" // action's parameter to launch on a left click 
- onlongclick_l="" // action a lancer sur un click long+ onlongclick_l="" // action to launch on a long click
  params_longclick_l=""  params_longclick_l=""
- onclick_r="" // action à lancer sur un click droit + onclick_r="" // action to launch on a right click 
- params_r="" // paramètres de l’action à lancer sur un click droit+ params_r="" // action's parameter to launch on right click
  align="" // si pas de scale et que zone définie plus grande que l’image  align="" // si pas de scale et que zone définie plus grande que l’image
- menu_l="" // context menu à afficher sur un click bouton gauche (voir group de type menu) + menu_l="" // context menu to display on left click button (see group of type menu) 
- menu_r="" // context menu à afficher sur un click bouton droit (voir group de type menu) + menu_r="" // context menu to display on right click button (see group of type menu) 
- menu_b="" // context menu à afficher sur un click bouton droit ou gauche (voir group de type menu)+ menu_b="" // context menu to display on right or left click button (see group of type menu)
  frozen="false" // button is frozen  frozen="false" // button is frozen
 /> />
Line 376: Line 367:
 ==== <ctrl type="text_button" /> ==== ==== <ctrl type="text_button" /> ====
  
-BUT: +GOAL : button, push, radio or toggle.
-boutton, push, radio ou toggle.+
  
 SYNTAXE: SYNTAXE:
Line 383: Line 373:
 <code xml> <code xml>
 <ctrl type="text_button"  <ctrl type="text_button" 
- button_type="toggle_button" // type du bouton: "toggle_button", "push_button" ou "radio_button" + button_type="toggle_button" // button type: "toggle_button", "push_button" or "radio_button" 
- pushed="false" // etat pushed par defaut + pushed="false" //  pushed state by default 
- color="255 255 255 255" // couleur état normal + color="255 255 255 255" // normal color state 
- col_pushed="255 255 255 255" // couleur quand pushed + col_pushed="255 255 255 255" // color when pushed 
- col_over="255 255 255 255" // couleure quand over + col_over="255 255 255 255" // color when over 
- global_color_normal="" // remplace le setup global_color pour l’état normal du bouton + global_color_normal="" // replace  the global_color state for the normal state of the button 
- global_color_pushed="" // remplace le setup global_color pour l’état pushed du bouton + global_color_pushed="" // replace  the global_color state for the pushed state of the button 
- global_color_over="" // remplace le setup global_color pour l’état over du bouton+ global_color_over="" // replace  the global_color state for the over state of the button
  
- //  Textures:  + //  Texture:  
- // contrairement aux boutons, ici il faut mettre seulement "textb_normal" par exemple.  + // unlike the button, here you just need to set "textb_normal" for example.  
- // les "_l.tga", "_m.tga", "_r.tga" etant ajoutees automatiquement pour trouver respectivement les parties + // the "_l.tga", "_m.tga", "_r.tga" are automatically add to find the parts. 
- // gauches, millieu (celle qui est scalée en X) et droite.+ // left, center (the one wedge on X) and right.
  
- tx_normal="" // texture état normal.  + tx_normal="" // normal state texture.  
- tx_pushed="" // texture etat pushed. + tx_pushed="" // pushed state texture. 
- tx_over="" // texture etat over. + tx_over="" // over state texture. 
- onclick_l="" // action à lancer sur un click gauche + onclick_l="" // action to launch on a left click 
- params_l="" // paramètres de l’action à lancer sur un click gauche + params_l="" // action parameters to launch on a left click 
- onlongclick_l="" // action a lancer sur un click long+ onlongclick_l="" // action to launch on a long click
  params_longclick_l=""  params_longclick_l=""
- onclick_r="" // action à lancer sur un click droit + onclick_r="" // action to launch on a right click 
- params_r="" // paramètres de l’action à lancer sur un click droit + params_r="" // action parameter to launch on a right click 
- menu_l="" // context menu à afficher sur un click bouton gauche (voir group de type menu) + menu_l="" // contextual menu to display on a left button click (see group of type menu) 
- menu_r="" // context menu à afficher sur un click bouton droit (voir group de type menu) + menu_r="" // contextual menu to display on a right button click (see group of type menu) 
- menu_b="" // context menu à afficher sur un click bouton droit ou gauche (voir group de type menu)+ menu_b="" // contextual menu to display on a left or right button click (see group of type menu)
  
  // Texte infos:  // Texte infos:
Line 416: Line 406:
  underlined=""  underlined=""
  
- // Comportement Special des Couleurs des Textes+ // Special behaviour of the text's colors
  text_color_normal="255 255 255 255"  text_color_normal="255 255 255 255"
  text_color_pushed="255 255 255 255"  text_color_pushed="255 255 255 255"
Line 428: Line 418:
  
  // Special:  // Special:
- text_y="" // décalage du texte en Y rapport au bouton (-2) + text_y="" // tex's offset in Y against the button (-2) 
- wmargin="" // taille à ajouter au texte pour avoir la taille du bouton + wmargin="" // size to add to the text to get the button size 
- wmin="" // taille minimum du bouton+ wmin="" // minimum size of the button
  
 /> />
Line 449: Line 439:
  params_l (string)  params_l (string)
  
- uc_hardtext (ucstring telle quelle) + uc_hardtext (unaltered ucstring) 
- hardtext (string qui va etre localisee)+ hardtext (localise string)
  
 </code> </code>
Line 465: Line 455:
 <ctrl type="scroll" <ctrl type="scroll"
  
- tx_bottomleft="" // Les textures du bouton (pas de background affiche) (bottom or left)+ tx_bottomleft="" // button's texture (ni background display) (bottom or left)
  tx_middle=""  tx_middle=""
- tx_topright="" // top or right (ça dépend si la sb est verticale)+ tx_topright="" // top or right (depends id the sb is vertical)
  
- vertical="" // Est-ce que c’est une sb verticale ou horizontale + vertical="" // Is that a vertical or horizontal sb 
- align="" // T, B, L ou R+ align="" // T, B, L or R
   
- value="" // Value entrée de DB ou nombre (si pas présent alors la sb est linke a une target) + value="" // Value from DB or number (if not present the sb is link to a target) 
- min="" // Si la sb n’est pas linke a une target alors le nombre qu’elle  + min="" // If the sb isn't link to a target, so the number which it represent change from min to max 
- // représente varie de min a max + tracksize="" // Track size (the button)
- tracksize="" // Taille de la track bar (le bouton)+
   
- onscroll="" // Action Handler appele lorsque la sb est deplacee + onscroll="" // Handler action called when the sb is displaced 
- onscrollend="" // Appele quand on arrete de scroller+ onscrollend="" // Called when the scroller is stoped
  params=""  params=""
   
- target="" // Si la sb n’est pas linke a une value alors elle peut être linke a un group. Dans ce cas + target="" // If the sb isn't link to a value so it can be link to a group. On this case the group displace itself in its max_w and max_h limits relativelyy to its w and h. 
- // le group est se deplace dans la limite de ses max_w et max_h relativement a ses w et h. + target_stepx="" // Give the pixel number to dsiplaced inone time. Wich allow, in example, in the  
- target_stepx="" // Donne la quantité de pixels a déplacer en une fois. Ce qui permet par exemple dans les  + target_stepy="" // list of sheet to be wedge on a sheet
- target_stepy="" // listes de sheet d’être cale sur un sheet+
  step_value=""  step_value=""
 /> />
Line 492: Line 480:
 ==== <ctrl type="sheet" /> ==== ==== <ctrl type="sheet" /> ====
  
-BUT: +GOAL : Display a item special's button, brick...
-affiche un bouton spécial d'item, brique etc...+
  
-SYNTAXE:+SYNTAX:
 <WRAP prewrap 650px> <WRAP prewrap 650px>
 <code xml> <code xml>
 <ctrl type="sheet" <ctrl type="sheet"
- value="" // Lien vers la database. OBLIGATOIRE. + value="" // Link to the database. OBLIGATOIRE. 
- // exemple: SERVER:INVENTORY:8:1. NB: lien vers une branche de la database + // example: SERVER:INVENTORY:8:1. NB: link to a database division 
- // qui DOIT contenir SHEET, et peut avoir QUANTITY et/ou QUALITY+ // which MUST countain SHEET, and can have QUANTITY and/or QUALITY
  nature="item" // "item", "brick", "spell"  nature="item" // "item", "brick", "spell"
  brick_type="" // "COMBAT", "MAGIC". may be important for some filter (memory...)  brick_type="" // "COMBAT", "MAGIC". may be important for some filter (memory...)
  // Can also put multiple filter like this: "COMBAT|MAGIC|HARVEST"  // Can also put multiple filter like this: "COMBAT|MAGIC|HARVEST"
  tx_noitem=""  tx_noitem=""
- col_noitem="true" // "true": quand pas d’item, modulate la couleur avec la couleur globale+ col_noitem="true" // "true": when no item, modulate the color with the global color
  
- onclick_l="" // action à lancer sur un click gauche + onclick_l="" // action to launch on a left click 
- params_l="" // paramètres de l’action à lancer sur un click gauche + params_l="" // action's parameters to launch on a left click 
- onclick_r="" // action à lancer sur un click droit + onclick_r="" // action to launch on a right click 
- params_r="" // paramètres de l’action à lancer sur un click droit+ params_r="" // action's parameters to launch on a right click
  
- menu_l="" // context menu à afficher sur un click bouton gauche (voir group de type menu) + menu_l="" // contextual menu to display on a left button click (see group of menu type) 
- menu_r="" // context menu à afficher sur un click bouton droit (voir group de type menu) + menu_r="" // contextual menu to display on a right button click (see group of menu type) 
- menu_b="" // context menu à afficher sur un click bouton droit ou gauche (voir group de type menu)+ menu_b="" // contextual menu to display on a left or right button click (see group of menu type)
  
  dragable="false" // drag and drop able?  dragable="false" // drag and drop able?
- oncandrop="" // Action a lancer pour savoir si on peut Droper sur moi.+ oncandrop="" // Action to launch to know if we can drop on me.
  params_candrop=""  params_candrop=""
- ondrop="" // Action a lancer sur un drop sur moi+ ondrop="" // Action to launch on a drop on me
  params_drop=""  params_drop=""
  
Line 528: Line 515:
  use_slot_type_db_entry="false" // Automatic Type.  use_slot_type_db_entry="false" // Automatic Type.
  
- grayed="false" // init the sheet as grayed or not+ grayed="false" // in it the sheet as grayed or not
  auto_grayed="false" // Gray auto the sheet according to Item LOCKED state or Brick LATENT state  auto_grayed="false" // Gray auto the sheet according to Item LOCKED state or Brick LATENT state
  slot="true" // Draw the slot  slot="true" // Draw the slot
Line 539: Line 526:
 <WRAP prewrap 650px> <WRAP prewrap 650px>
 <code xml> <code xml>
- sheet (string) (correspond a la value le lien vers la DB)+ sheet (string) (link value to the DB)
  color1 (rgba)  color1 (rgba)
  color2 (rgba)  color2 (rgba)
Line 551: Line 538:
 ==== <ctrl type="colpick" /> ==== ==== <ctrl type="colpick" /> ====
  
-BUT: +GOAL : Display a picture to choose a color in it
-affiche une image pour choisir que l on puisse choisir une couleur dedans+
  
-SYNTAXE:+SYNTAX:
 <WRAP prewrap 650px> <WRAP prewrap 650px>
 <code xml> <code xml>
  
 <ctrl type="colpick"  <ctrl type="colpick" 
- texture="color_palette.tga" // La texture a utiliser (texture non groupée!) + texture="color_palette.tga" // The Texture to use (no grouped texture!) 
- onchange="proc" // Action à lancer dès que la couleur sélectionnée change + onchange="proc" // Action to launch when the selectionned color change. 
- onchange_params="proc_col_change" // Les paramètres de l’action+ onchange_params="proc_col_change" // Action's parameter
  dbcolr="UI:TEMP:COL:R" // .  dbcolr="UI:TEMP:COL:R" // .
  dbcolg="UI:TEMP:COL:G" // .  dbcolg="UI:TEMP:COL:G" // .
  dbcolb="UI:TEMP:COL:B" // .  dbcolb="UI:TEMP:COL:B" // .
- dbcola="UI:TEMP:COL:A" // Liens directs avec la database de la couleur sélectionnée+ dbcola="UI:TEMP:COL:A" // Directs link with the database of the selectionned color
 /> />
  
Line 574: Line 560:
 <WRAP prewrap 650px> <WRAP prewrap 650px>
 <code xml> <code xml>
- r, g, b, a (int) les composantes de la couleur sélectionnée+ r, g, b, a (int) The components of the selectionned color
  color (string ('#r #g #b #a'))  color (string ('#r #g #b #a'))
  
CC Attribution-Share Alike 4.0 International Driven by DokuWiki
en/configuration_interface_client.1570805908.txt.gz · Last modified: (external edit)
Licences Mentions légales Accueil du site Contact Inclusion