Interface Management

This page aims to centralize all the information concerning the creation of the game interfaces.

The instructions for creating the interface xml files are described on the dedicated page:Client interface's configuration.

As what is provided as a concept, underlying the game interface.. is explained on the detailed page:interface_khanat_client.

Notes to be filed:

• Explanation of the player variables

The interface files are called from what is in the INTERFACES part of the fileclient_default.cfg

In the code, these calls are managed by two files:

• init.cpp contient l'appel vers XMLInputFile.
• interface_manager.cpp contains calls to XMLLoginInterfaceFiles and XMLOutGameInterfaceFiles, and towards the images TexturesInterface, TexturesLoginInterface and TexturesOutGameInterface.

The currently called file input_config_v3.xml is unchanged at this time(relative to RC).

These are the files that manage the login window where you identify yourself.

The files currently called are:

• login_config.xml non modifié pour l'instant par rapport à RC
• login_widgets.xml
• login_main.xml
• login_keys.xml

• out_v2_config.xml Unchanged for the time being with respect to RC
• out_v2_widgets.xml Unchanged for the time being with respect to RC
• out_v2_connect.xml
• out_v2_intro.xml Unchanged from RC
• out_v2_select.xml
• out_v2_appear.xml
• out_v2_location.xml
• out_v2_crash.xml
• out_v2_hierarchy.xml
• out_v2_keys.xml unchanged from RC

The general interface texture is: interface_game_khaganat.

It is manufactured according to a precise procedure, and is accompanied by a .txt file of the same name.See: Creating the interface file(To be put on a separate page with detailed procedure).

The texture for the interface of the connection window is: interface_login_khaganat. It is manufactured as: the above interface texture.

The texture for the interface of the Outgame window, ie the creation and selection of the character, is: interface_outgame_khaganat. It is manufactured as: the above interface texture.

The file: database.xml lists the architecture of the database that is queried by the interface xml files to obtain the server's game data(apparently).

There is a file local_database.xml (Not in gamedev, it is an error of placement). Which contains the database to query with LOCAL:.

The architecture of the database given in these files is simple: branches “branch”, to leaves “leaf”.. which indicate a data to return.

For example:

database.xml

  <branch name="PACK_ANIMAL"
          bank="PLR">
    <!-- beasts -->
    <!-- MAX_INVENTORY_ANIMAL -->
    <branch name="BEAST"
            count="4"
            atomic="1">
      <!-- Atomic, for correct Bar Management on client -->
            type="I7" />
      <leaf name="BULK_MAX"
            type="I32" />

To have the BULK_MAX parameter of our pack animals, we could create variables in the interface xml file and assign them the values with the instructions:

interface.xml

<define id="pa1_bulk"
          value="SERVER:PACK_ANIMAL:BEAST0:BULK_MAX" />
<define id="pa2_bulk"
          value="SERVER:PACK_ANIMAL:BEAST1:BULK_MAX" />
<define id="pa3_bulk"
          value="SERVER:PACK_ANIMAL:BEAST2:BULK_MAX" />
<define id="pa4_bulk"
          value="SERVER:PACK_ANIMAL:BEAST3:BULK_MAX" />

It is then sufficient to use these variables pa1_bulk, pa2_bulk, pa3_bulk and pa5_bulk in our VIEWS and others CONTROLS.

Most of the variables called in the interface windows are created in config.xml which is provided in the data of the client.

The tree nodes let you know which windows (non-modal) are provided by the system, this makes it easier to study the starting interface.

<Hidden tree node current>

</hidden>

XMLInterfaceFiles, Present in the client_default.cfg(or client.cfg) the list of XML files used for the game interface detailed below.

• config.xml
• widgets.xml
• webig_widgets.xml
• player.xml
• inventory.xml
• interaction.xml
• phrase.xml
• harvest.xml
• macros.xml
• info_player.xml
• outpost.xml
• guild.xml
• taskbar.xml
• game_config.xml
• game_context_menu.xml
• player_trade.xml
• bot_chat_v4.xml
• compass.xml
• map.xml
• hierarchy.xml
• reset.xml
• actions.xml
• help.xml
• encyclopedia.xml
• commands.xml
• commands2.xml
• ring_access_point_filter.xml
• ring_window.xml
• bg_downloader.xml

Two referenced files therefore seem to be absent without this interfering with the functioning of the game(in relation to the ring|Ring, it is true)

This file contains mostly variable definitions, templates. Most variables used in other XML files are defined in this file.
One can notice the link between the names assigned to the images in the calls of the other XML recorders and their value in the file. You can change the appearance of images just by changing the contents of the variables.

There is no GROUP element.

It contains the View type=“pointer” line 2101, which defines the mouse image according to the context with it's size etc.

  <!-- *********** -->
  <!-- *  MOUSE  * -->
  <!-- * POINTER * -->
  <!-- *********** -->
  <view type="pointer"
        id="cursor"
        x="1"
        y="-5"
        w="44"
        h="39"
        global_color="false"
        tx_default="curs_default.tga"
        tx_move_window="curs_default.tga"
        tx_resize_BR_TL="curs_resize_BR_TL.tga"
        tx_resize_BL_TR="curs_resize_BL_TR.tga"
        tx_resize_TB="curs_resize_TB.tga"
        tx_resize_LR="curs_resize_LR.tga"
        tx_rotate="curs_rotate.tga"
        tx_scale="curs_scale.tga"
        tx_colpick="curs_pick.tga"
        tx_pan="curs_pan.tga"
        tx_can_pan="curs_can_pan.tga"
        tx_pan_r2="r2_hand_pan.tga"
        tx_can_pan_r2="curs_default.tga"
        posref="BL MM" />

This file contains the templates of the various non-fixed components of the game, such as:

• Information frames in the 3D scene(such as source content: “drill_source”);
• The dialog bubbles “3dbulle_L” (note that there is a version “3dbulle_R” not used);
• Templates for menu separators, check-menus…;
• Inventory management menus;
• Currency display frame, skill points, faction;
• Chat items, edit box, context-sensitive help, object destruction dialog, some modal windows;
• Simple message window templates;
• The template of the help window of objects and bricks ITEM/BRICK HELP lines 5394 and following;
• HTML FORM SELECT WIDGET template and HTML TEXT BUTTON WIDGET templates, to line 6668;
• The webIG template: html browser window line 7019 and following.

These are the widgets that are used for windows in connection with webIG applications.

Descriptions of type elements:

• Information above the character's head;
• The progress bar of the actions CURRENT ACTION line 219. The images used for the progress(of the action) are precisely: slot_jauge_action.tga for the frame, and gauge_action.tga for the zone Dynamic internal filling;
• The window of miscellaneous information(bars, names, PvP status) on the player character;
• The buff/debuff window BONUS MALUS line 631 and following;
• The animal control menu ANIMALS GLOBAL line 930 and following, including:
  • Orders given to creatures (stop, Follow me etc);
  • The comprehensive animal management window;
  • Dead Animal Management Window ANIMAL(S) DEAD WINDOW lines 1309 and following;
  • The animal inventory window template ANIMALS INVENTORIES lines 1359 and following

This file(with the explicit title) contains all the elements for managing inventory windows.

This includes self-inventory, accommodation, animal bag, guild room and temporary exchange area.

It also contains the two zones of HANDS with the action shortcuts: HANDS lines 1086 and following for the first, <!– second hands bar –> lines 1501 And following for the second.

There is also the “TEAM SHARING SYSTEM” payout window for lines 1933 and following.

A “DEFENSE” window is quoted in line 2326 and following, whose function remains to be specified. Possibly armor equipment area… to be checked.

A GROUP CUSTOM TEXT EDITION AND DISPLAY is defined in lines 2637 and following, which may be used to manage the custom text input area on objects.

This file contains elements for interaction with other creatures in the game.

From row 10 and following, the “TARGET” area allows you to define the views linked to the clicked target:

• Its relative level/power;
• Its level bars;
• List of friends and ignore list, FRIEND LIST & IGNORE LIST TEMPLATE lines 459 and following(and see below);
• The zones of CHAT:
  • CHAT TEMPLATE lines 554 and following;
  • CHAT WITH NO EDIT BOX TEMPLATE lines 693 and following;
  • CHAT WITH FILTER TEMPLATE lines 745 and following;
  • GROUP OF CHAT lines 821 and following;
  • Template of a dynamic chat tab lines 940 and following;
  • The main chat group lines 986 and following with:
    • SYSTEM INFO TEMPLATE lines 1327 and following;
    • TEAM_CHAT lines 1383 and following;
    • AROUND_ME lines 1390 and following, then lines 1425 and following;
    • REGION CHAT lines 1397 and following, then lines 1433 and following;
    • UNIVERSE CHAT lines 1404 and following;
    • SYSTEM INFO lines 1418 and following and then lines 1441 and following;
    • Dialogs with the team, TEAM lines 1449 and following;
    • BASE MENU FOR CHAT BOX lines 1883 and later(for Chat windows when they are free) :
    • AROUND ME CHAT lines 2013 and following;
• Contact templates: CONTACT TEMPLATE lines 1648 and following, in conjunction with ignore list, friend list above
• Team management menu TEAM_MENU lines 2108 and following;
• The contact management menu CONTACT_MENU lines 2184 and following;
• The chat menu by team and guild PARTY CHAT MENU lines 2269 and following;
• The window to join a team WINDOW TO ASK IF THE PLAYER WANT TO JOIN THE TEAM lines 2333 and following;
• Window to join a guild WINDOW TO ASK IF THE PLAYER WANT TO JOIN THE GUILD lines 2376 and following;
• Window to accept a duel WINDOW TO ASK IF A PLAYER WANT TO DUEL WITH ANOTHER PLAYER lines 2419 and following;
• Window to switch to PvP WINDOW TO ASK IF TO PLAYER WANT TO PVP lines 2482 and following;
• Window to switch to faction Pvp(clan?) WINDOW TO ASK CLAN PLAYER WANT JOIN FOR PVP lines 2537 And following;

* Window to join a group chat POPUP TO ASK IF A PLAYER WANT'S TO JOIN A PARTY CHAT lines 2607 and following;

• Window to enter a critical mission area POPUP TO ASK IF A PLAYER WANT TO ENTER A MISSION CRITICAL ZONE lines 2642 and following;
• Window to request teleportation POPUP TO ASK THE PLAYER FOR A TELEPORT LOCATION lines 2684 and following;
• Pure window to enter the name of a new group chat window: WINDOW TO ENTER THE NAME OF A NEW PARTY CHAT lines 2978 and following;
• Management of the YUBO CHAT lines 3064 and following;
• Dynamic channel management DYNAMIC CHAT lines 3071 and following;

This plug-in contains(apparently) elements of the composition window of sbricks in sphrases and as well as that of the composition of craft recipes.

Visibly obsolete(fully commented), used to collect collected MPs.

Manage the Macro creation and management window.

This file contains the elements of different windows related to the character and it's characteristics.

First of all, the window of general information that is about the character(Identity).

The templates are first, up to the line 556 and then the definition sheets of GROUPS to the line 1684.

We then find the part dedicated to the renowned, FAME lines 1687 and following with first the templates up to the line 1878 then the GROUPS(including SPIRES) until the Line 2603.

Then a zone info_player_journal which must certainly concern the window of missions lines 2606 and following, with the templates to the line 2969, then the GROUPSto the line 3547.

Then a definition area of POPUP MESSAGES from line 3550 to 3667.

Finally, a “RPJOB TEMPLATES” zone for jobs developed by WebIG from line 3670, and then a final “NPC WEB PAGE” for interactions with NPCs managed by webIG from line 3700.