Merge pull request #127 from pyrrhicPachyderm/elements-hook

Add hooks for modifying elements and thresholds.

CUSTOM.md

@@ -405,3 +405,18 @@ This section is meant for users who are familiar with both the tts mod and progr
       - `major`: **boolean** - true if gaining majors, false if gaining minors
       - `count`: **number** - the number of cards being gained
     - return **number** - the number of cards to gain
+- Trigger to modify how a spirit's elements are counted
+  - Create object and tag with "Modify Elements"
+  - `modifyElements(params)`
+    - `params`: **table** - contains data about the player and their elements
+      - `color`: **string** - is the color of the player whose elements are being counted
+      - `elements`: **table** - a table of eight numbers, representing the number of each element in order, indexed by numbers 1-8 (1: Sun, 2: Moon, 3: Fire, 4: Air, 5: Water, 6: Earth, 7: Plant, 8: Animal)
+    - return **table** - the `elements` table, modified appropriately
+- Trigger to modify a elemental thresholds
+  - Create object and tag with "Modify Thresholds"
+  - `modifyThresholds(params)`
+    - `params`: **table** - contains data about the threshold
+      - `color`: **string** - is the color of the player for whom the threshold is being evaluated
+      - `object`: **object reference** - the object on which the threshold sits (e.g. spirit panel, aspect card, power card)
+      - `elements`: **table** - a table of eight numbers, representing the number of each element in order, indexed by numbers 1-8 (1: Sun, 2: Moon, 3: Fire, 4: Air, 5: Water, 6: Earth, 7: Plant, 8: Animal)
+    - return **table** - the `elements` table, modified appropriately

objects/aidBoard/script.lua

@@ -1040,17 +1040,22 @@ end
 function scanElements()
     local elements = Elements:new()
     for _, selected in pairs(Global.getVar("selectedColors")) do
-        elements:add(selected.nonTokenElements)
+        elements:add(selected.elementCounts)
     end
 
     local elementsTable = {"Sun","Moon","Fire","Air","Water","Earth","Plant","Animal"}
     for i,total in ipairs(elements) do
-        local elementTokensCount = #getObjectsWithTag(elementsTable[i])
+        for _,obj in pairs(getObjectsWithTag(elementsTable[i])) do
+            -- Don't count markers in player areas
+            if #obj.getZones() == 0 then
+                total = total + 1
+            end
+        end
         -- We double count tokens on the Island Board for the Elemental Invocation scenario
-        local invocationElementTokensCount = #getObjectsWithAllTags({elementsTable[i],"Invocation Element"})
+        total = total + #getObjectsWithAllTags({elementsTable[i],"Invocation Element"})
         getObjectFromGUID(elementGuids[i]).editButton({
             index = 0,
-            label = total + elementTokensCount + invocationElementTokensCount,
+            label = total,
         })
     end
 end

savegame.json

@@ -260,6 +260,14 @@
       {
         "displayed": "Modify Card Gain",
         "normalized": "modify_card_gain"
+      },
+      {
+        "displayed": "Modify Elements",
+        "normalized": "modify_elements"
+      },
+      {
+        "displayed": "Modify Thresholds",
+        "normalized": "modify_thresholds"
       }
     ]
   },

script.lua

@@ -5630,6 +5630,52 @@ function upCastPosSizRot(pos,size,rot,dist,types)
     end
     return hitObjects
 end
+-----
+local Elements = {}
+Elements.__index = Elements
+function Elements:new(init)
+    local outTable = {0,0,0,0,0,0,0,0}
+    setmetatable(outTable, self)
+    outTable:add(init)
+    return outTable
+end
+function Elements:add(other)
+    if other == nil then
+        return
+    elseif type(other) == "table" then
+        for i = 1, 8 do
+            self[i] = self[i] + other[i]
+        end
+    elseif type(other) == "string" then
+        for i = 1, string.len(other) do
+            self[i] = self[i] + math.floor(string.sub(other, i, i))
+        end
+    end
+end
+function Elements:threshold(threshold)
+    for i = 1, 8 do
+        if threshold[i] > self[i] then
+            return false
+        end
+    end
+    return true
+end
+function Elements:__tostring()
+    return table.concat(self, "")
+end
+
+local function modifyElements(params)
+    for _,object in pairs(getObjectsWithTag("Modify Elements")) do
+        params.elements = object.call("modifyElements", params)
+    end
+    return Elements:new(params.elements)
+end
+local function modifyThresholds(params)
+    for _,object in pairs(getObjectsWithTag("Modify Thresholds")) do
+        params.elements = object.call("modifyThresholds", params)
+    end
+    return Elements:new(params.elements)
+end
 
 -- Updates the selected player color's player area.  Does nothing if they don't have one.
 -- Returns TRUE if an update occured, FALSE if no such player area existed.
@@ -5749,39 +5795,6 @@ function setupPlayerArea(params)
         selected.zone.editButton({index=5, label="", click_function="nullFunc", color="White", height=0, width=0, tooltip=""})
     end
 
-    local Elements = {}
-    Elements.__index = Elements
-    function Elements:new(init)
-        local outTable = {0,0,0,0,0,0,0,0}
-        setmetatable(outTable, self)
-        outTable:add(init)
-        return outTable
-    end
-    function Elements:add(other)
-        if other == nil then
-            return
-        elseif type(other) == "table" then
-            for i = 1, 8 do
-                self[i] = self[i] + other[i]
-            end
-        elseif type(other) == "string" then
-            for i = 1, string.len(other) do
-                self[i] = self[i] + math.floor(string.sub(other, i, i))
-            end
-        end
-    end
-    function Elements:threshold(threshold)
-        for i = 1, 8 do
-            if threshold[i] > self[i] then
-                return false
-            end
-        end
-        return true
-    end
-    function Elements:__tostring()
-        return table.concat(self, "")
-    end
-
     local function calculateTrackElements(spiritBoard)
         local elements = Elements:new()
         if spiritBoard.script_state ~= "" then
@@ -5802,6 +5815,7 @@ function setupPlayerArea(params)
         local positions = {}
         for _, threshold in pairs(thresholds) do
             local decal
+            local thresholdElements = modifyThresholds({color = color, object = object, elements = Elements:new(threshold.elements)})
             local vec = Vector(threshold.position)
             local vecString = vec:string()
             if positions[vecString] then
@@ -5814,7 +5828,7 @@ function setupPlayerArea(params)
                     scale    = scale,
                 }
             end
-            if elements:threshold(Elements:new(threshold.elements)) then
+            if elements:threshold(thresholdElements) then
                 decal.url = "http://cloud-3.steamusercontent.com/ugc/1752434998238112918/1438FD310432FAA24898C44212AB081770C923B9/"
             elseif not positions[vecString] then
                 decal.url = "http://cloud-3.steamusercontent.com/ugc/1752434998238120811/7B41881EE983802C10E4ECEF57123443AE9F11BA/"
@@ -5850,11 +5864,8 @@ function setupPlayerArea(params)
     end
 
     local function countItems()
+        color = getTableColor(params.obj) -- In case the player has swapped color
         local elements = Elements:new()
-        -- We track the elements separately, since we count tokens *everywhere*
-        -- for the choice event element helper, and don't want to double count
-        -- the tokens in the scan zones.
-        local nonTokenElements = Elements:new()
 
         local spirit = nil
         local aspects = {}
@@ -5866,7 +5877,6 @@ function setupPlayerArea(params)
                 if entry.hasTag("Spirit") then
                     local trackElements = calculateTrackElements(entry)
                     elements:add(trackElements)
-                    nonTokenElements:add(trackElements)
                     spirit = entry
                 elseif entry.type == "Card" then
                     if entry.hasTag("Aspect") and not entry.is_face_down then
@@ -5877,13 +5887,11 @@ function setupPlayerArea(params)
                         if entry.hasTag("Aspect") then -- Count elements on aspects regardless of location or locking
                             local cardElements = entry.getVar("elements")
                             elements:add(cardElements)
-                            nonTokenElements:add(cardElements)
                         elseif entry.getPosition().z > selected.zone.getPosition().z then -- Skip counting power cards below spirit panel
                             -- Skip counting locked card's elements (exploratory Aid from Lesser Spirits)
                             if not entry.getLock() or not (blightedIsland and blightedIslandCard ~= nil and blightedIslandCard.guid == "ad5b9a") then
                                 local cardElements = entry.getVar("elements")
                                 elements:add(cardElements)
-                                nonTokenElements:add(cardElements)
                             end
                             -- Skip counting locked card's energy (Aid from Lesser Spirits)
                             if not entry.getLock() then
@@ -5902,7 +5910,8 @@ function setupPlayerArea(params)
                 end
             end
         end
-        costs = modifyCost({color = getTableColor(params.obj), costs = costs})
+        elements = modifyElements({color = color, elements = elements})
+        costs = modifyCost({color = color, costs = costs})
         local energy = 0
         for _,cost in pairs(costs) do
             energy = energy + cost
@@ -5913,9 +5922,11 @@ function setupPlayerArea(params)
         --Updates the number display
         selected.zone.editButton({index=0, label="Energy Cost: "..energy})
         for i, v in ipairs(elements) do
-            selected.elements[i].editButton({index=0, label=v})
+            if selected.elements[i] then
+                selected.elements[i].editButton({index=0, label=v})
+            end
         end
-        selected.nonTokenElements = nonTokenElements
+        selected.elementCounts = elements
     end
     countItems()    -- Update counts immediately.
     if timer then