INFO: battleLoadingTips.xc

Published by ORT on

Viewing 1 post (of 1 total)
  • Author
    Posts
  • #109813
    ORT
    Member

    (Due to the lack of an official wiki and thorough public documentation of the XVM mod, this is an attempt to publish the ins and outs of XVM and cover all of the .xc files. This is intended to be a live document. Everytime there are changes to XVM, the finalized changes will be incorporated in the document. Additions/comments/corrections to the information here are welcome. If you have any comment, or noticed anything missing or needing more clarification, or anything that is wrong, please post a comment.)

     

    From WOT client version 0.9.14, there are two types of battle loading screens:
     
    (1) a battle loading with team rosters on either side separated by either a minimap or a game tip depending on your selection in the game settings;
    (2) a battle loading screen displaying only the two columns of team rosters, devoid of the minimap or game tip. More team information can be displayed.
     
    battleLoadingTips.xc (and battleLoading.xc) controls what is displayed when the map is loading before the battle countdown. The information displayed are defined by two fields per team.
     
    For the allied team (on the left)
    “formatLeftNick”:
    “formatLeftVehicle”:
     
    For the enemy team (on the right)
    “formatRightNick”:
    “formatRightVehicle”:
     
    Default XVM battleLoadingTips.xc screen

    Spoiler

    1jaq2v.jpg

     

    Alternative default XVM battleLoadingTips screen when the double-digit XVM scale is selected in the user’s personal cabinet at http://www.modxvm.com/en/ Note the 2-digit rating.

    Spoiler

    2yknouo.jpg

    By default, the following are displayed:
     
    In formatLeftNick”: and “formatRightNick”:
         – platoon icons (configurable to display or not)
         – players’ flag (as set in player’s personal cabinet in http://www.modxvm.com/en/
         – XVM user indicator (XVM logo appears when player is using XVM, thus sees the stats of other players)
         – players’ names (set to maximum 15 characters)
         – players’ clan, if any
         – clan icon (configurable to display or not. By default, only top 50 clans in your server are displayed.)
     
    In “formatLeftVehicle”: and “formatRightVehicle”:
         – players’ vehicle names
         – players’ ratings (either xWGR, xWN8, xWN6, xEFF, or xTE, as set in your XVM personal cabinet) colored according to the selected rating.
         – vehicle type icon
         – vehicle contour icon and tier
     
    Colors for number of battles, rating, winrate, and vehicle type icon are defined in colors.xc.
     
    All information (herein referred to as ‘fields’ are configurable. The fields can have any position in the rows, or any color. 
     
    Default battleLoadingTips.xc explained.

    Spoiler

    (default battleLoadingTips.xc config file)
     
    /**
     * Parameters of the Battle Loading screen.
     */
    {
      “battleLoadingTips”: {

        // Format of clock on the Battle Loading Screen.
        // http://php.net/date
        “clockFormat”: “H:i:s”, <<<< for you to know it’s time for bed, or need to pick up the kids, or Game of Thrones is on TV.

        // true – enable display of battle tier.
        “showBattleTier”: false, <<<< not that you don’t see the highest tier vehicle in the team rosters, but nice to have.

        // true – disable Platoon icons. This blank space can house, for example, clan logos.
        “removeSquadIcon”: false,

        // true – disable vehicle level indicator.
        “removeVehicleLevel”: false,  <<<< set to ‘true’ when using vehicle contour icons with tier number built-in.

        // true – disable vehicle type icon. This space will be used for formatted vehicle field.
        “removeVehicleTypeIcon”: false, <<<< set to ‘true’ when using vehicle contour icons with vehicle type icons built-in.

        // Show border for name field (useful for config tuning)
        “nameFieldShowBorder”: false,  <<<< when set to true, is useful when doing your config. it shows the actual borders of the fields.

        // Show border for vehicle field (useful for config tuning)
        “vehicleFieldShowBorder”: false,  <<<< when set to true, is useful when doing your config. it shows the actual borders of the fields.

        // X offset for allies squad icons <<<< all these are used for custom positioning of platoon icons, best to leave as it is, unless you are feeling creative.
        “squadIconOffsetXLeft”: -130,
        // X offset for enemies squad icons field
        “squadIconOffsetXRight”: -130,
        // X offset for allies player names field
        “nameFieldOffsetXLeft”: -138,
        // Width delta for allies player names field
        “nameFieldWidthDeltaLeft”: 120,
        // X offset for enemies player names field
        “nameFieldOffsetXRight”: -133,
        // Width delta for enemies player names field
        “nameFieldWidthDeltaRight”: 120,
        // X offset for allies vehicle names field
        “vehicleFieldOffsetXLeft”: 0,
        // Width delta for allies vehicle names field
        “vehicleFieldWidthDeltaLeft”: 130,
        // X offset for enemies vehicle names field
        “vehicleFieldOffsetXRight”: 0,
        // Width delta for enemies vehicle names field
        “vehicleFieldWidthDeltaRight”: 130,
        // X offset for allies vehicle icons
        “vehicleIconOffsetXLeft”: -24,
        // X offset for enemies vehicle icons
        “vehicleIconOffsetXRight”: -18,

        // Display options for Team/Clan logos. <<<< all these are used for custom positioning of clan icons, best to leave as it is, unless you are feeling creative.
        “clanIcon”: {
          // false – Disable Team/Clan logos in Battle Loading Screen.
          “show”: true,
          // Position on the X axis, relative to the vehicle icon.
          “x”: 0,
          // Position on the Y axis, relative to the vehicle icon.
          “y”: 6,
          // Position on the X axis for right side (positive values run to the *inside* of the table).
          “xr”: 0,
          // Position on the Y axis for right side.
          “yr”: 6,
          // Width of the Team/Clan logo.
          “w”: 16,
          // Height of the Team/Clan logo.
          “h”: 16,
          // Transparency of the Team/Clan logo.
          “alpha”: 90
        },

        // false – disable highlight of icons during battle start depends on ready state.
        “darkenNotReadyIcon”: true, <<<< players who has not yet loaded the map are not highlighted.
     
    Below are the fields where you put in what information you want to see.  
        // Display format for the left panel (macros allowed, see macros.txt).
        “formatLeftNick”: “<img src=’xvm://res/icons/flags/{{flag|default}}.png’ width=’16’ height=’13’> <img src=’xvm://res/icons/xvm/xvm-user-{{xvm-user}}.png’> {{name%.15s~..}} <font alpha=’#A0′>{{clan}}</font>”,

        // Display format for the right panel (macros allowed, see macros.txt).
        “formatRightNick”: “<font alpha=’#A0′>{{clan}}</font> {{name%.15s~..}} <img src=’xvm://res/icons/xvm/xvm-user-{{xvm-user}}.png’> <img src=’xvm://res/icons/flags/{{flag|default}}.png’ width=’16’ height=’13’>”,

        // Display format for the left panel (macros allowed, see macros.txt).
        “formatLeftVehicle”: “{{vehicle}}<font face=’mono’ size='{{xvm-stat?13|0}}’> <font color='{{c:r}}’>{{r}}</font></font>”,

        // Display format for the right panel (macros allowed, see macros.txt).
        “formatRightVehicle”: “<font face=’mono’ size='{{xvm-stat?13|0}}’><font color='{{c:r}}’>{{r}}</font> </font>{{vehicle}}”
      }
    }
     

     

       // Display format for the left panel (macros allowed, see macros.txt).
        “formatLeftNick”: “<img src=’xvm://res/icons/flags/{{flag|default}}.png’ width=’16’ height=’13’> <img src=’xvm://res/icons/xvm/xvm-user-{{xvm-user}}.png’> {{name%.15s~..}} <font alpha=’#A0′>{{clan}}</font>”,
        // Display format for the right panel (macros allowed, see macros.txt).
        “formatRightNick”: “<font alpha=’#A0′>{{clan}}</font> {{name%.15s~..}} <img src=’xvm://res/icons/xvm/xvm-user-{{xvm-user}}.png’> <img src=’xvm://res/icons/flags/{{flag|default}}.png’ width=’16’ height=’13’>”,
     
    <img src=’xvm://res/icons/flags/{{flag|default}}.png’ width=’16’ height=’13’> <<<< this code (in HTML or hyper-text markup language). It retrieves the XVM player’s (I mean ‘XVM’ player because if the player does not have XVM installed, there is no data to retrieve) flag that he has selected in his personal at http://www.modxvm.com/en/ and displays it. xvm: is special XVM tag which is the path relative to ‘res_mods/xvm’ folder. Images of flags are installed in res_mods/mods/shared_resources/xvm/res/icons/flags/. {{flag}} is a macro for ‘Flag for player selected in the personal cabinet or determined from the client language’, see res_mods/mods/shared_resources/doc/macros.txt. |default tells XVM to display the default.png flag if it cannot find a flag for the player. The default.png flag is just a transparent image, so in effect no visible flag is displayed.
     
    <img src=’xvm://res/icons/xvm/xvm-user-{{xvm-user}}.png’> <<<< this code finds out if the player has XVM installed, and displays the XVM logo if he does. XVM logos are stored in res_mods/mods/shared_resources/xvm/res/icons/xvm/
     
    {{name%.15s~..}} <<<< this code displays the player’s name to a maximum of 15 characters. If the name is more than 15 characters, the last two characters are substituted with a ‘ . ‘ (period). 
     
    <font alpha=’#A0′>{{clan}}</font> <<<< this code displays the player’s clan, if any. The text in brackets is HTMLtells XVM to display the clan name with an alpha of #A0. #A0 is the hex code for ~ 63%.
     
        // Display format for the left panel (macros allowed, see macros.txt).
        “formatLeftVehicle”: “{{vehicle}}<font face=’mono’ size='{{xvm-stat?13|0}}’> <font color='{{c:r}}’>{{r}}</font></font>”,
        // Display format for the right panel (macros allowed, see macros.txt).
        “formatRightVehicle”: “<font face=’mono’ size='{{xvm-stat?13|0}}’><font color='{{c:r}}’>{{r}}</font> </font>{{vehicle}}”
     
    {{vehicle}} <<<< is a macro for vehicle name, so it displays the vehicle name. 
     
    “…<font face=’mono’ size='{{xvm-stat?13|0}}’>…</font>”  <<<< {{xvm-stat}} is a macro whose value is ‘stat’ if statistic is active, empty if not, see macros.txt. {{xvm-stat?13|0}} is telling XVM to use a font size of 13 is the player uses XVM, if not use 0 (zero),
     
    <font color='{{c:r}}’>{{r}}</font> <<<< {{r}} macro is the rating macro. Whatever is selected in your XVM personal cabinet for ratings is shown, i.e., either xWGR, xWN8, xWN6, xEFF, or xTE. {{c:r}} is the macro for the color of the player’s current rating.  
     

    Also see res_mods/mods/shared_resources/doc/readme-en.txt.

    Related config file: <a href="/index.php?/topic/492-info-battleloadingxc/” rel=””>battleLoading.xc

Viewing 1 post (of 1 total)
  • You must be logged in to reply to this topic.