Ticket #4386: relics_poc.patch

binaries/data/mods/public/maps/scripts/Relics.js

@@ +1 @@
+Trigger.prototype.CheckRelicsVictory = function(data)
+{
+    let cmpIdentity = Engine.QueryInterface(data.entity, IID_Identity);
+    if (!cmpIdentity || !cmpIdentity.HasClass("Relic") || data.from == -1)
+        return;
+
+    if (data.from != 0)
+        --this.playerRelicsCount[data.from];
+
+    ++this.playerRelicsCount[data.to];
+
+    this.CheckCountdown();
+};
+
+/**
+ * Check if an individual player or a team has acquired all the relics
+ * Also check if the countdown needs to be stopped if a player/team no longer has all the relics
+ */
+Trigger.prototype.CheckCountdown = function()
+{
+    for (let playerID = 1; playerID < TriggerHelper.GetNumberOfPlayers(); ++playerID)
+    {
+        let playerAndAllies = QueryPlayerIDInterface(playerID).GetMutualAllies();
+        let teamRelicsOwned = 0;
+
+        for (let ally of playerAndAllies)
+            teamRelicsOwned += this.playerRelicsCount[ally];
+
+        if (teamRelicsOwned == this.relics.length - 1)
+        {
+            let data = { "entity": this.relics[playerID], "to": playerAndAllies };
+            this.StartCountdown(data, playerAndAllies.length > 1);
+            return;
+        }
+    }
+
+    this.DeleteRelicsVictoryMessages();
+};
+
+Trigger.prototype.DeleteRelicsVictoryMessages = function()
+{
+    let cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    let cmpGuiInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+
+    for (let ent in this.relicsVictoryMessages)
+    {
+        cmpGuiInterface.DeleteTimeNotification(this.relicsVictoryMessages[ent].ownMessage);
+        cmpGuiInterface.DeleteTimeNotification(this.relicsVictoryMessages[ent].otherMessage);
+        cmpTimer.CancelTimer(this.relicsVictoryTimers[ent]);
+    }
+};
+
+Trigger.prototype.StartCountdown = function(data, isTeam)
+{
+    let timer = this.relicsVictoryTimers[data.entity];
+    let messages = this.relicsVictoryMessages[data.entity] || {};
+
+    let cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    let cmpGuiInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+
+    if (timer)
+    {
+        cmpTimer.CancelTimer(timer);
+        cmpGuiInterface.DeleteTimeNotification(messages.ownMessage);
+        cmpGuiInterface.DeleteTimeNotification(messages.otherMessage);
+    }
+
+    let players = [-1];
+    for (let playerID = 1; playerID < TriggerHelper.GetNumberOfPlayers(); ++playerID)
+    {
+        let cmpPlayer = QueryPlayerIDInterface(playerID);
+        if (cmpPlayer.GetState() == "won")
+            return;
+        if (data.to.indexOf(playerID) == -1)
+            players.push(playerID);
+    }
+
+    let cmpPlayer = QueryOwnerInterface(data.entity, IID_Player);
+    messages.otherMessage = cmpGuiInterface.AddTimeNotification({
+        "message": isTeam ? markForTranslation("%(player)s's team has captured all of the relics. They will have won in %(time)s") :
+                            markForTranslation("%(player)s has captured all of the relics. They will have won in %(time)s"),
+        "players": players,
+        "parameters": {
+            "player": cmpPlayer.GetName()
+        },
+        "translateMessage": true,
+        "translateParameters": [],
+    }, 10 * 60 * 1000); // 10 min
+
+    messages.ownMessage = cmpGuiInterface.AddTimeNotification({
+        "message": isTeam ? markForTranslation("Your team has captured all of the relics. You will have won in %(time)s") :
+                            markForTranslation("You have captured all of the relics. You will have won in %(time)s"),
+        "players": data.to,
+        "translateMessage": true,
+    }, 10 * 60 * 1000);
+
+    timer = cmpTimer.SetTimeout(SYSTEM_ENTITY, IID_EndGameManager,
+        "MarkPlayerAsWon", 10 * 60 * 1000, data.to[0]);
+
+    this.relicsVictoryTimers[data.entity] = timer;
+    this.relicsVictoryMessages[data.entity] = messages;
+};
+
+Trigger.prototype.InitRelicsGame = function()
+{
+    // Attempt to spawn one relic per player randomly in neutral territory
+    let cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
+    let cmpWaterManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_WaterManager);
+    let cmpTerritoryManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TerritoryManager);
+
+    let validSpawnPoint = entity => {
+
+        let cmpIdentity = Engine.QueryInterface(entity, IID_Identity);
+        let cmpPosition = Engine.QueryInterface(entity, IID_Position);
+
+        if (!cmpIdentity || !cmpPosition || !cmpPosition.IsInWorld())
+            return false;
+
+        let pos = cmpPosition.GetPosition();
+
+        // do not spawn relics underwater
+        if (cmpIdentity.HasClass("SeaCreature") || pos.y <= cmpWaterManager.GetWaterLevel(pos.x, pos.z) ||
+            cmpTerritoryManager.GetOwner(cmpPosition.GetPosition2D().x, cmpPosition.GetPosition2D().y) != 0)
+            return false;
+
+        return true;
+    };
+
+    let gaiaEntities = cmpRangeManager.GetEntitiesByPlayer(0).filter(entity => validSpawnPoint(entity));
+
+    if (!gaiaEntities.length)
+    {
+        error("No relic spawn points on map");
+        return;
+    }
+
+    for (let i = 1; i < TriggerHelper.GetNumberOfPlayers(); ++i)
+    {
+        this.relics[i] = TriggerHelper.SpawnUnits(gaiaEntities[Math.floor(Math.random() * gaiaEntities.length)],
+            "special_units/special_relic", 1, 0)[0];
+        this.playerRelicsCount[i] = 0;
+
+        let cmpHealth = Engine.QueryInterface(this.relics[i], IID_Health);
+        cmpHealth.SetUndeletable(true);
+
+        let cmpDamageReceiver = Engine.QueryInterface(this.relics[i], IID_DamageReceiver);
+        cmpDamageReceiver.SetInvulnerability(true);
+    }
+};
+
+let cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
+cmpTrigger.relics = [];
+cmpTrigger.playerRelicsCount = [];
+cmpTrigger.relicsVictoryTimers = {};
+cmpTrigger.relicsVictoryMessages = {};
+
+cmpTrigger.DoAfterDelay(0, "InitRelicsGame", {});
+cmpTrigger.RegisterTrigger("OnOwnershipChanged", "CheckRelicsVictory", { "enabled": true });
+cmpTrigger.RegisterTrigger("OnDiplomacyChanged", "CheckCountdown", { "enabled": true });

binaries/data/mods/public/simulation/components/Identity.js

@@ -54 +54 @@
         "</element>" +
     "</optional>" +
     "<optional>" +
-        "<element name='Classes' a:help='Optional list of space-separated classes applying to this entity. Choices include: Animal, Apadana, ArmyCamp, Ashoka, BarterMarket, Celt, CitizenSoldier, CivCentre, Colony, ConquestCritical, Defensive, Domestic, DropsiteFood, DropsiteMetal, DropsiteStone, DropsiteWood, Elephant, Female, FishingBoat, ForestPlant, Fortress, GarrisonFortress, GarrisonTower, Gates, Human, Iberian, Immortal, Italian, Juggernaut, Kennel, Lighthouse, LongWall, MercenaryCamp, Naval, NavalMarket, Organic, Palace, Palisade, Player, PtolemyIV, SeaCreature, SiegeWall, SpecialBuilding, StoneWall, Structure, Syssiton, Theater, Tower, Unit, WoodenTower'>" +
+        "<element name='Classes' a:help='Optional list of space-separated classes applying to this entity. Choices include: Animal, Apadana, ArmyCamp, Ashoka, BarterMarket, Celt, CitizenSoldier, CivCentre, Colony, ConquestCritical, Defensive, Domestic, DropsiteFood, DropsiteMetal, DropsiteStone, DropsiteWood, Elephant, Female, FishingBoat, ForestPlant, Fortress, GarrisonFortress, GarrisonTower, Gates, Human, Iberian, Immortal, Italian, Juggernaut, Kennel, Lighthouse, LongWall, MercenaryCamp, Naval, NavalMarket, Organic, Palace, Palisade, Player, PtolemyIV, Relic, SeaCreature, SiegeWall, SpecialBuilding, StoneWall, Structure, Syssiton, Theater, Tower, Unit, WoodenTower'>" +
             "<attribute name='datatype'>" +
                 "<value>tokens</value>" +
             "</attribute>" +

binaries/data/mods/public/simulation/components/Trigger.js

@@ -11 +11 @@
     "CinemaPathEnded",
     "CinemaQueueEnded",
     "ConstructionStarted",
+    "DiplomacyChanged",
     "Interval",
     "OwnershipChanged",
     "PlayerCommand",
@@ -265 +266 @@
     this.CallEvent("PlayerWon", msg);
 };
 
+Trigger.prototype.OnGlobalDiplomacyChanged = function(msg)
+{
+    this.CallEvent("DiplomacyChanged", msg);
+};
+
 /**
  * Execute a function after a certain delay.
  *

binaries/data/mods/public/simulation/data/settings/victory_conditions/relics.json

@@ +1 @@
+{
+    "TranslatedKeys": ["Title", "Description"],
+    "Data":
+    {
+        "Title": "Relics",
+        "Description": "Collect all of the relics spread across the map and keep them for a certain time to win the game.",
+        "Scripts":
+        [
+            "scripts/TriggerHelper.js",
+            "scripts/ConquestCommon.js",
+            "scripts/Conquest.js",
+            "scripts/Relics.js"
+        ]
+    }
+}

binaries/data/mods/public/simulation/templates/special_units/special_relic.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Entity parent="template_unit">
+  <Capturable>
+    <CapturePoints>100</CapturePoints>
+    <RegenRate>1</RegenRate>
+    <GarrisonRegenRate>10</GarrisonRegenRate>
+  </Capturable>
+  <Cost>
+    <Population>0</Population>
+  </Cost>
+  <Footprint replace="">
+    <Square width="5.0" depth="12.0"/>
+    <Height>2.0</Height>
+  </Footprint>
+  <Identity>
+    <Civ>gaia</Civ>
+    <Classes datatype="tokens">Relic</Classes>
+    <GenericName>Relic</GenericName>
+    <Icon>technologies/metal_pot.png</Icon>
+    <Tooltip>Special unit for Relics games.</Tooltip>
+  </Identity>
+  <Selectable>
+    <Overlay>
+      <Texture>
+        <MainTexture>circle/256x256.png</MainTexture>
+        <MainTextureMask>circle/256x256_mask.png</MainTextureMask>
+      </Texture>
+    </Overlay>
+  </Selectable>
+  <UnitMotion>
+    <WalkSpeed>6</WalkSpeed>
+    <Run>
+      <Speed>12.0</Speed>
+    </Run>
+  </UnitMotion>
+  <VisualActor>
+    <Actor>units/athenians/siege_spear_packed.xml</Actor>
+  </VisualActor>
+</Entity>

source/tools/atlas/AtlasUI/ScenarioEditor/Sections/Map/Map.cpp

@@ -149 +149 @@
     gameTypes.Add(_T("wonder"));
     gameTypes.Add(_T("endless"));
     gameTypes.Add(_T("regicide"));
+    gameTypes.Add(_T("relics"));
 
     wxFlexGridSizer* gridSizer = new wxFlexGridSizer(2, 5, 5);
     gridSizer->AddGrowableCol(1);