Ticket #3234: wonderOptions_V3.patch

File wonderOptions_V3.patch, 20.8 KB (added by elexis, 8 years ago)

Rewrote resizeMoreOptionsWindow to (almost) not use magic-numbers.

  • binaries/data/mods/public/gui/common/settings.js

    function loadSettingsValues()  
    3030{
    3131    var settings = {
    3232        "AIDescriptions": loadAIDescriptions(),
    3333        "AIDifficulties": loadAIDifficulties(),
    3434        "Ceasefire": loadCeasefire(),
     35        "WonderDurations": loadWonderDuration(),
    3536        "GameSpeeds": loadSettingValuesFile("game_speeds.json"),
    3637        "MapTypes": loadMapTypes(),
    3738        "MapSizes": loadSettingValuesFile("map_sizes.json"),
    3839        "PlayerDefaults": loadPlayerDefaults(),
    3940        "PopulationCapacities": loadPopulationCapacities(),
    … … function loadAIDifficulties()  
    129130        }
    130131    ];
    131132}
    132133
    133134/**
     135 * Loads available wonder-victory times
     136 */
     137function loadWonderDuration()
     138{
     139    var jsonFile = "wonder_times.json";
     140    var json = Engine.ReadJSONFile(g_SettingsDirectory + jsonFile);
     141
     142    if (!json || json.Default === undefined || !json.Times || !Array.isArray(json.Times))
     143    {
     144        error("Could not load " + jsonFile);
     145        return undefined;
     146    }
     147
     148    return json.Times.map(duration => ({
     149        "Duration": duration,
     150        "Default": duration == json.Default,
     151        "Title": sprintf(translatePluralWithContext("wonder victory", "%(min)s minute", "%(min)s minutes", duration), { "min": duration })
     152    }));
     153}
     154
     155/**
    134156 * Loads available ceasefire settings.
    135157 *
    136158 * @returns {Array|undefined}
    137159 */
    138160function loadCeasefire()

  • binaries/data/mods/public/gui/gamesetup/gamesetup.js

    const g_GameSpeeds = prepareForDropdown(  
    66const g_MapSizes = prepareForDropdown(g_Settings && g_Settings.MapSizes);
    77const g_MapTypes = prepareForDropdown(g_Settings && g_Settings.MapTypes);
    88const g_PopulationCapacities = prepareForDropdown(g_Settings && g_Settings.PopulationCapacities);
    99const g_StartingResources = prepareForDropdown(g_Settings && g_Settings.StartingResources);
    1010const g_VictoryConditions = prepareForDropdown(g_Settings && g_Settings.VictoryConditions);
     11const g_WonderDurations = prepareForDropdown(g_Settings && g_Settings.WonderDurations);
    1112
    1213/**
    1314 * All selectable playercolors except gaia.
    1415 */
    1516const g_PlayerColors = g_Settings ? g_Settings.PlayerDefaults.slice(1).map(pData => pData.Color) : undefined;
    … … function initGUIObjects()  
    246247        initNumberOfPlayers();
    247248        initGameSpeed();
    248249        initPopulationCaps();
    249250        initStartingResources();
    250251        initCeasefire();
     252        initWonderDurations();
    251253        initVictoryConditions();
    252254        initMapSizes();
    253255        initRadioButtons();
    254256    }
    255257    else
    … … function initMapFilters()  
    298300        mapFilters.selected = 0;
    299301    g_GameAttributes.mapFilter = "default";
    300302}
    301303
    302304/**
    303  * Sets the size of the more-options dialog.
     305 * Remove empty space in case of hidden options (like cheats, rating or wonder duration)
    304306 */
    305307function resizeMoreOptionsWindow()
    306308{
    307     // For singleplayer reduce the size of more options dialog by two options (cheats, rated game = 60px)
    308     if (!g_IsNetworked)
    309     {
    310         Engine.GetGUIObjectByName("moreOptions").size = "50%-200 50%-195 50%+200 50%+160";
    311         Engine.GetGUIObjectByName("hideMoreOptions").size = "50%-70 310 50%+70 336";
    312     }
    313     // For non-lobby multiplayergames reduce the size of the dialog by one option (rated game, 30px)
    314     else if (!Engine.HasXmppClient())
    315     {
    316         Engine.GetGUIObjectByName("moreOptions").size = "50%-200 50%-195 50%+200 50%+190";
    317         Engine.GetGUIObjectByName("hideMoreOptions").size = "50%-70 340 50%+70 366";
     309    const elementHeight = 30;
     310    const elements = [
     311        "optionWonderDuration",
     312        "optionRevealMap",
     313        "optionExploreMapText",
     314        "optionDisableTreasuresText",
     315        "optionLockTeams",
     316        "optionCheats",
     317        "optionRating",
     318        "hideMoreOptions"
     319    ];
     320
     321    let yPos = undefined;
     322    for (let element of elements)
     323    {
     324        let guiOption = Engine.GetGUIObjectByName(element);
     325        let gSize = guiOption.size;
     326        yPos = yPos || gSize.top;
     327
     328        if (guiOption.hidden)
     329            continue;
     330
     331        gSize.top = yPos;
     332        gSize.bottom = yPos + elementHeight - 2;
     333        guiOption.size = gSize;
     334
     335        yPos += elementHeight;
    318336    }
     337
     338    // Resize the vertically centered window containing the options
     339    let moreOptions = Engine.GetGUIObjectByName("moreOptions");
     340    let mSize = moreOptions.size;
     341    mSize.bottom = yPos + mSize.top + 20;
     342    moreOptions.size = mSize;
    319343}
    320344
    321345function initNumberOfPlayers()
    322346{
    323347    let playersArray = Array(g_MaxPlayers).fill(0).map((v, i) => i + 1); // 1, 2, ..., MaxPlayers
    … … function initVictoryConditions()  
    404428        updateGameAttributes();
    405429    };
    406430    victoryConditions.selected = g_VictoryConditions.Default;
    407431}
    408432
     433function initWonderDurations()
     434{
     435    let wonderConditions = Engine.GetGUIObjectByName("wonderDuration");
     436    wonderConditions.list = g_WonderDurations.Title;
     437    wonderConditions.list_data = g_WonderDurations.Duration;
     438    wonderConditions.selected = g_WonderDurations.Default;
     439    wonderConditions.onSelectionChange = function()
     440    {
     441        if (this.selected != -1)
     442            g_GameAttributes.settings.WonderDuration = g_WonderDurations.Duration[this.selected];
     443
     444        updateGameAttributes();
     445    };
     446}
     447
    409448function initMapSizes()
    410449{
    411450    let mapSize = Engine.GetGUIObjectByName("mapSize");
    412451    mapSize.list = g_MapSizes.LongName;
    413452    mapSize.list_data = g_MapSizes.Tiles;
    … … function updateGUIObjects()  
    12411280    let gameSpeedIdx = g_GameAttributes.gameSpeed !== undefined ? g_GameSpeeds.Speed.indexOf(g_GameAttributes.gameSpeed) : g_GameSpeeds.Default;
    12421281
    12431282    // These dropdowns might set the default (as they ignore g_IsInGuiUpdate)
    12441283    let mapSizeIdx = mapSettings.Size !== undefined ? g_MapSizes.Tiles.indexOf(mapSettings.Size) : g_MapSizes.Default;
    12451284    let victoryIdx = mapSettings.GameType !== undefined ? g_VictoryConditions.Name.indexOf(mapSettings.GameType) : g_VictoryConditions.Default;
     1285    let wonderDurationIdx = mapSettings.WonderDuration !== undefined ? g_WonderDurations.Duration.indexOf(mapSettings.WonderDuration) : g_WonderDurations.Default;
    12461286    let popIdx = mapSettings.PopulationCap !== undefined ? g_PopulationCapacities.Population.indexOf(mapSettings.PopulationCap) : g_PopulationCapacities.Default;
    12471287    let startingResIdx = mapSettings.StartingResources !== undefined ? g_StartingResources.Resources.indexOf(mapSettings.StartingResources) : g_StartingResources.Default;
    12481288    let ceasefireIdx = mapSettings.Ceasefire !== undefined ? g_Ceasefire.Duration.indexOf(mapSettings.Ceasefire) : g_Ceasefire.Default;
    12491289    let numPlayers = mapSettings.PlayerData ? mapSettings.PlayerData.length : g_MaxPlayers;
    12501290
    … … function updateGUIObjects()  
    12571297        Engine.GetGUIObjectByName("numPlayersSelection").selected = numPlayers - 1;
    12581298        Engine.GetGUIObjectByName("victoryCondition").selected = victoryIdx;
    12591299        Engine.GetGUIObjectByName("populationCap").selected = popIdx;
    12601300        Engine.GetGUIObjectByName("gameSpeed").selected = gameSpeedIdx;
    12611301        Engine.GetGUIObjectByName("ceasefire").selected = ceasefireIdx;
     1302        Engine.GetGUIObjectByName("wonderDuration").selected = wonderDurationIdx;
    12621303        Engine.GetGUIObjectByName("startingResources").selected = startingResIdx;
    12631304    }
    12641305    else
    12651306    {
    12661307        Engine.GetGUIObjectByName("mapTypeText").caption = g_MapTypes.Title[mapTypeIdx];
    … … function updateGUIObjects()  
    12711312
    12721313    // Can be visible to both host and clients
    12731314    Engine.GetGUIObjectByName("mapSizeText").caption = g_GameAttributes.mapType == "random" ? g_MapSizes.LongName[mapSizeIdx] : translate("Default");
    12741315    Engine.GetGUIObjectByName("numPlayersText").caption = numPlayers;
    12751316    Engine.GetGUIObjectByName("victoryConditionText").caption = g_VictoryConditions.Title[victoryIdx];
     1317    Engine.GetGUIObjectByName("wonderDurationText").caption = g_WonderDurations.Title[wonderDurationIdx];
    12761318    Engine.GetGUIObjectByName("populationCapText").caption = g_PopulationCapacities.Title[popIdx];
    12771319    Engine.GetGUIObjectByName("startingResourcesText").caption = g_StartingResources.Title[startingResIdx];
    12781320    Engine.GetGUIObjectByName("ceasefireText").caption = g_Ceasefire.Title[ceasefireIdx];
    12791321    Engine.GetGUIObjectByName("gameSpeedText").caption = g_GameSpeeds.Title[gameSpeedIdx];
    12801322
    … … function updateGUIObjects()  
    12831325    setGUIBoolean("exploreMap", "exploreMapText", !!mapSettings.ExploreMap);
    12841326    setGUIBoolean("revealMap", "revealMapText", !!mapSettings.RevealMap);
    12851327    setGUIBoolean("lockTeams", "lockTeamsText", !!mapSettings.LockTeams);
    12861328    setGUIBoolean("enableRating", "enableRatingText", !!mapSettings.RatingEnabled);
    12871329
     1330    Engine.GetGUIObjectByName("optionWonderDuration").hidden =
     1331        g_GameAttributes.settings.GameType &&
     1332        g_GameAttributes.settings.GameType != "wonder";
     1333
    12881334    Engine.GetGUIObjectByName("cheatWarningText").hidden = !g_IsNetworked || !mapSettings.CheatsEnabled;
    12891335
    12901336    Engine.GetGUIObjectByName("enableCheats").enabled = !mapSettings.RatingEnabled;
    12911337    Engine.GetGUIObjectByName("lockTeams").enabled = !mapSettings.RatingEnabled;
    12921338
    … … function updateGUIObjects()  
    12971343    Engine.GetGUIObjectByName("mapSizeText").hidden = !isRandom || g_IsController;
    12981344    hideControl("numPlayersSelection", "numPlayersText", isRandom && g_IsController);
    12991345
    13001346    let notScenario = g_GameAttributes.mapType != "scenario" && g_IsController ;
    13011347    hideControl("victoryCondition", "victoryConditionText", notScenario);
     1348    hideControl("wonderDuration", "wonderDurationText", notScenario);
    13021349    hideControl("populationCap", "populationCapText", notScenario);
    13031350    hideControl("startingResources", "startingResourcesText", notScenario);
    13041351    hideControl("ceasefire", "ceasefireText", notScenario);
    13051352    hideControl("revealMap", "revealMapText", notScenario);
    13061353    hideControl("exploreMap", "exploreMapText", notScenario);
    … … function updateGUIObjects()  
    13541401        pColorPickerHeading.hidden = !canChangeColors;
    13551402        if (canChangeColors)
    13561403            pColorPicker.selected = g_PlayerColors.findIndex(col => sameColor(col, color));
    13571404    }
    13581405
     1406    resizeMoreOptionsWindow();
     1407
    13591408    g_IsInGuiUpdate = false;
    13601409
    13611410    // Game attributes include AI settings, so update the player list
    13621411    updatePlayerList();
    13631412
    … … function setMapDescription()  
    13721421{
    13731422    let numPlayers = g_GameAttributes.settings.PlayerData ? g_GameAttributes.settings.PlayerData.length : 0;
    13741423    let mapName = g_GameAttributes.map || "";
    13751424
    13761425    let victoryIdx = Math.max(0, g_VictoryConditions.Name.indexOf(g_GameAttributes.settings.GameType || ""));
    1377     let victoryTitle = g_VictoryConditions.Title[victoryIdx];
     1426    let victoryTitle;
     1427
     1428    if (g_VictoryConditions.Name[victoryIdx] == "wonder")
     1429        victoryTitle = sprintf(
     1430            translatePluralWithContext(
     1431                "victory condition",
     1432                "Wonder (%(min)s minute)",
     1433                "Wonder (%(min)s minutes)",
     1434                g_GameAttributes.settings.WonderDuration
     1435            ),
     1436            { "min": g_GameAttributes.settings.WonderDuration }
     1437        );
     1438    else
     1439        victoryTitle = g_VictoryConditions.Title[victoryIdx];
     1440
    13781441    if (victoryIdx != g_VictoryConditions.Default)
    13791442        victoryTitle = "[color=\"" + g_VictoryColor + "\"]" + victoryTitle + "[/color]";
    13801443
    13811444    let mapDescription = g_GameAttributes.settings.Description ? translate(g_GameAttributes.settings.Description) : translate("Sorry, no description available.");
    13821445    if (mapName == "random")

  • binaries/data/mods/public/gui/gamesetup/gamesetup.xml

     
    324324                    <object name="ceasefire" size="40%+10 0 100% 28" type="dropdown" style="ModernDropDown" hidden="true" tooltip_style="onscreenToolTip">
    325325                        <translatableAttribute id="tooltip">Set time where no attacks are possible.</translatableAttribute>
    326326                    </object>
    327327                </object>
    328328
    329                 <object size="14 188 94% 216">
     329                <object name="optionWonderDuration" size="14 188 94% 216">
     330                    <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
     331                        <translatableAttribute id="caption">Wonder Victory:</translatableAttribute>
     332                    </object>
     333                    <object name="wonderDurationText" size="40% 0 100% 100%" type="text" style="ModernLeftLabelText"/>
     334                    <object name="wonderDuration" size="40%+10 0 100% 28" type="dropdown" style="ModernDropDown" hidden="true" tooltip_style="onscreenToolTip">
     335                        <translatableAttribute id="tooltip">Number of minutes that the player has to keep the wonder in order to win.</translatableAttribute>
     336                    </object>
     337                </object>
     338
     339                <object name="optionRevealMap" size="14 218 94% 246">
    330340                    <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
    331341                        <translatableAttribute id="caption" comment="Make sure to differentiate between the revealed map and explored map options!">Revealed Map:</translatableAttribute>
    332342                    </object>
    333343                    <object name="revealMapText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
    334344                    <object name="revealMap" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
    335345                        <translatableAttribute id="tooltip" comment="Make sure to differentiate between the revealed map and explored map options!">Toggle revealed map (see everything).</translatableAttribute>
    336346                    </object>
    337347                </object>
    338348
    339                 <object size="14 218 94% 246">
     349                <object name="optionExploreMapText" size="14 248 94% 276">
    340350                    <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
    341351                        <translatableAttribute id="caption" comment="Make sure to differentiate between the revealed map and explored map options!">Explored Map:</translatableAttribute>
    342352                    </object>
    343353                    <object name="exploreMapText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
    344354                    <object name="exploreMap" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
    345355                        <translatableAttribute id="tooltip" comment="Make sure to differentiate between the revealed map and explored map options!">Toggle explored map (see initial map).</translatableAttribute>
    346356                    </object>
    347357                </object>
    348358
    349                 <object size="14 248 94% 276">
     359                <object name="optionDisableTreasuresText" size="14 278 94% 306">
    350360                    <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
    351361                        <translatableAttribute id="caption">Disable Treasures:</translatableAttribute>
    352362                    </object>
    353363                    <object name="disableTreasuresText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
    354364                    <object name="disableTreasures" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
    355365                        <translatableAttribute id="tooltip">Disable all treasures on the map.</translatableAttribute>
    356366                    </object>
    357367                </object>
    358368
    359                 <object size="14 278 94% 306">
     369                <object name="optionLockTeams" size="14 308 94% 336">
    360370                    <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
    361371                        <translatableAttribute id="caption">Teams Locked:</translatableAttribute>
    362372                    </object>
    363373                    <object name="lockTeamsText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
    364374                    <object name="lockTeams" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
    365375                        <translatableAttribute id="tooltip">Toggle locked teams.</translatableAttribute>
    366376                    </object>
    367377                </object>
    368378
    369                 <object name="optionCheats" size="14 308 94% 336" hidden="true">
     379                <object name="optionCheats" size="14 338 94% 366" hidden="true">
    370380                    <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
    371381                        <translatableAttribute id="caption">Cheats:</translatableAttribute>
    372382                    </object>
    373383                    <object name="enableCheatsText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
    374384                    <object name="enableCheats" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
    375385                        <translatableAttribute id="tooltip">Toggle the usability of cheats.</translatableAttribute>
    376386                    </object>
    377387                </object>
    378388
    379                 <object name="optionRating" size="14 338 94% 366" hidden="true">
     389                <object name="optionRating" size="14 368 94% 396" hidden="true">
    380390                    <object size="0 0 40% 28" hidden="false" type="text" style="ModernRightLabelText">
    381391                        <translatableAttribute id="caption">Rated Game:</translatableAttribute>
    382392                    </object>
    383393                    <object name="enableRatingText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
    384394                    <object name="enableRating" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">

  • binaries/data/mods/public/maps/scripts/WonderVictory.js

    Trigger.prototype.CheckWonderVictory = f  
    2929    var players = [-1];
    3030    for (var i = 1; i < numPlayers; i++)
    3131        if (i != data.to)
    3232            players.push(i);
    3333
    34     var time = cmpWonder.GetTimeTillVictory()*1000;
     34    var time = cmpWonder.GetVictoryDuration();
    3535    messages.otherMessage = cmpGuiInterface.AddTimeNotification({
    3636        "message": markForTranslation("%(player)s will have won in %(time)s"),
    3737        "players": players,
    3838        "parameters": {"player": cmpPlayer.GetName()},
    3939        "translateMessage": true,

  • binaries/data/mods/public/simulation/components/EndGameManager.js

    EndGameManager.prototype.Schema =  
    1313EndGameManager.prototype.Init = function()
    1414{
    1515    // Game type, initialised from the map settings.
    1616    // One of: "conquest" (default) and "endless"
    1717    this.gameType = "conquest";
    18    
     18
     19    this.wonderDuration = 10 * 60 * 1000;
     20
    1921    // Allied victory means allied players can win if victory conditions are met for each of them
    2022    // Would be false for a "last man standing" game (when diplomacy is fully implemented)
    2123    this.alliedVictory = true;
    2224};
    2325
    … … EndGameManager.prototype.SetGameType = f  
    3537EndGameManager.prototype.CheckGameType = function(type)
    3638{
    3739    return this.gameType == type;
    3840};
    3941
     42EndGameManager.prototype.SetWonderDuration = function(wonderDuration)
     43{
     44    this.wonderDuration = wonderDuration;
     45};
     46
     47EndGameManager.prototype.GetWonderDuration = function()
     48{
     49    return this.wonderDuration;
     50};
     51
    4052EndGameManager.prototype.MarkPlayerAsWon = function(playerID)
    4153{
    4254    var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
    4355    var numPlayers = cmpPlayerManager.GetNumPlayers();
    4456    for (var i = 1; i < numPlayers; i++)

  • binaries/data/mods/public/simulation/components/Wonder.js

     
    11function Wonder() {}
    22
    33Wonder.prototype.Schema =
    4     "<element name='TimeTillVictory'>" +
    5         "<data type='nonNegativeInteger'/>" +
     4    "<element name='DurationMultiplier' a:help='A civ-specific time-bonus/handicap for the wonder-victory-condition.'>" +
     5        "<ref name='nonNegativeDecimal'/>" +
    66    "</element>";
    77
    88Wonder.prototype.Init = function()
    99{
    1010};
    1111
    1212Wonder.prototype.Serialize = null;
    1313
    14 Wonder.prototype.GetTimeTillVictory = function()
     14/**
     15 * Returns the number of minutes that a player has to keep the wonder in order to win.
     16 */
     17Wonder.prototype.GetVictoryDuration = function()
    1518{
    16     return +this.template.TimeTillVictory;
     19    var cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
     20    return cmpEndGameManager.GetWonderDuration() * this.template.DurationMultiplier;
    1721};
    1822
    1923Engine.RegisterComponentType(IID_Wonder, "Wonder", Wonder);

  • binaries/data/mods/public/simulation/data/settings/wonder_times.json

     
     1{
     2    "Times": [1, 3, 5, 10, 15, 20, 25, 30, 45, 60],
     3    "Default": 15
     4}

  • binaries/data/mods/public/simulation/helpers/Setup.js

    function LoadMapSettings(settings)  
    4747    }
    4848
    4949    var cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
    5050    if (settings.GameType)
    5151        cmpEndGameManager.SetGameType(settings.GameType);
     52    warn(cmpEndGameManager.GetWonderDuration());
     53    if (settings.WonderDuration)
     54        cmpEndGameManager.SetWonderDuration(settings.WonderDuration * 60 * 1000);
    5255
    5356    if (settings.Garrison)
    5457    {
    5558        for (let holder in settings.Garrison)
    5659        {