Merge pull request #162 from argonui/search-assistant

Search Assistant: Refactor and added to Option Panel

objects/Fan-MadeAccessories.aa8b38/SearchAssistant.17aed0.json

@@ -22,7 +22,7 @@
     "ImageURL": "http://cloud-3.steamusercontent.com/ugc/1838053776205435595/ECFB88938ADBD1EF7AEF713111A11330FD9FAA5A/",
     "WidthScale": 0
   },
-  "Description": "Searches your top X cards by setting your hand aside and putting the cards into your hand.\n\nPut the target of your search on your set aside hand.\n\nSelect \"Shuffle\" or \"No Shuffle\" to put the cards back in your deck.\n\nCheck context menu for additional information.",
+  "Description": "Searches the top X cards of the nearest playmat by setting your hand aside and putting the cards into your hand.\n\nPut the target of your search on your set aside hand.",
   "DragSelectable": true,
   "GMNotes": "",
   "GUID": "17aed0",
@@ -34,7 +34,7 @@
   "LayoutGroupSortIndex": 0,
   "Locked": false,
   "LuaScript": "require(\"accessories/SearchAssistant\")",
-  "LuaScriptState": "\"White\"",
+  "LuaScriptState": "",
   "MeasureMovement": false,
   "Name": "Custom_Tile",
   "Nickname": "Search Assistant",

objects/LuaScriptState.luascriptstate

@@ -1 +1 @@
-{"optionPanel":{"playAreaSnapTags":true,"showAttachmentHelper":false,"showChaosBagManager":false,"showCleanUpHelper":false,"useClueClickers":false,"showCustomPlaymatImages":false,"showCYOA":false,"showDisplacementTool":false,"showDrawButton":false,"showHandHelper":[],"showNavigationOverlay":false,"useSnapTags":true,"showTitleSplash":true,"showTokenArranger":false}}
+{"optionPanel":{"playAreaSnapTags":true,"showAttachmentHelper":false,"showChaosBagManager":false,"showCleanUpHelper":false,"useClueClickers":false,"showCustomPlaymatImages":false,"showCYOA":false,"showDisplacementTool":false,"showDrawButton":false,"showHandHelper":[],"showNavigationOverlay":false,"showSearchAssistant":[],"useSnapTags":true,"showTitleSplash":true,"showTokenArranger":false}}

src/accessories/SearchAssistant.ttslua

@@ -1,13 +1,17 @@
--- Search Assistant
+local playmatAPI = require("playermat/PlaymatApi")
--- made by:         Chr1Z
--- original by:     Tikatoy
--- description:     search the top X cards of your deck
-information = {
-    version = "1.4",
-    last_updated = "12.11.2022"
-}
 
-MAT_GUIDS = { "8b081b", "bd0ff4", "383d8b", "0840d5" }
+-- forward declaration of variables that are used across functions
+local matColor
+local setAsidePosition
+local setAsideRotation
+local drawDeckPosition
+
+local quickParameters          = {}
+quickParameters.function_owner = self
+quickParameters.font_size      = 165
+quickParameters.width          = 275
+quickParameters.height         = 275
+quickParameters.color          = "White"
 
 -- common parameters
 local buttonParameters          = {}
@@ -15,11 +19,12 @@ buttonParameters.function_owner = self
 buttonParameters.font_size      = 125
 buttonParameters.width          = 650
 buttonParameters.height         = 225
+buttonParameters.color          = "White"
 
 local inputParameters          = {}
 inputParameters.function_owner = self
 inputParameters.input_function = "updateSearchNumber"
-inputParameters.tooltip        = "number of cards to search"
+inputParameters.tooltip        = "custom search amount"
 inputParameters.label          = "#"
 inputParameters.font_size      = 175
 inputParameters.width          = 400
@@ -28,236 +33,161 @@ inputParameters.position       = { 0, 0.11, 0 }
 inputParameters.alignment      = 3
 inputParameters.validation     = 2
 
-function onSave() return JSON.encode(playerColor) end
+function onLoad()
-
+  normalView()
-function onLoad(save_state)
-    if save_state ~= nil then
-        playerColor = JSON.decode(save_state)
-    end
-
-    if playerColor == nil then
-        playerColor = Player.getAvailableColors()[1]
-    end
-
-    normalView()
-
-    self.addContextMenuItem("More Information", function()
-        printToAll("------------------------------", "White")
-        printToAll("Search Assistant v" .. information["version"] .. " by Chr1Z", "Orange")
-        printToAll("last updated: " .. information["last_updated"], "White")
-        printToAll("original concept by Tikatoy", "White")
-    end)
 end
 
--- regular view with search box and color switcher
+-- regular view with search box
 function normalView()
-    self.clearButtons()
+  self.clearButtons()
-    self.clearInputs()
+  self.clearInputs()
+  self.createInput(inputParameters)
 
-    createSearchButton()
+  -- create custom search button
-    changeColor("initialize")
+  buttonParameters.click_function = "searchCustom"
-    self.createInput(inputParameters)
+  buttonParameters.tooltip        = "Search the entered number of cards"
+  buttonParameters.position       = { 0, 0.11, 0.65 }
+  buttonParameters.label          = "Search"
+  self.createButton(buttonParameters)
+
+  -- create buttons to search 3, 6 or 9 cards
+  quickParameters.click_function = "search3"
+  quickParameters.label          = "3"
+  quickParameters.position       = { -0.65, 0.11, -0.65 }
+  self.createButton(quickParameters)
+
+  quickParameters.click_function = "search6"
+  quickParameters.label          = "6"
+  quickParameters.position       = { 0, 0.11, -0.65 }
+  self.createButton(quickParameters)
+
+  quickParameters.click_function = "search9"
+  quickParameters.label          = "9"
+  quickParameters.position       = { 0.65, 0.11, -0.65 }
+  self.createButton(quickParameters)
 end
 
+-- click functions
+function search3(_, playerColor) startSearch(playerColor, 3) end
+function search6(_, playerColor) startSearch(playerColor, 6) end
+function search9(_, playerColor) startSearch(playerColor, 9) end
+
 -- view during a search with "done" buttons
 function searchView()
-    self.clearButtons()
+  self.clearButtons()
-    self.clearInputs()
+  self.clearInputs()
 
-    createDoneButton(true)
+  -- create the "End Search" button
-    createDoneButton(false)
+  buttonParameters.click_function = "endSearch"
-end
+  buttonParameters.tooltip        = "Left-click: Return cards and shuffle\nRight-click: Return cards without shuffling"
-
+  buttonParameters.position       = { 0, 0.11, 0 }
--- change color (or initialize button)
+  buttonParameters.label          = "End Search"
-function changeColor(arg, _, isRightClick)
+  self.createButton(buttonParameters)
-    if arg ~= "initialize" then
-        -- update table with colors
-        COLORS = Player.getAvailableColors()
-        local pos = indexOf(COLORS, playerColor)
-
-        if isRightClick then
-            if pos == nil or pos == 1 then pos = #COLORS
-            else pos = pos - 1 end
-        else
-            if pos == nil or pos == #COLORS then pos = 1
-            else pos = pos + 1 end
-        end
-
-        -- update playerColor
-        playerColor = COLORS[pos]
-
-        -- remove button and recreate it afterwards
-        self.removeButton(1)
-    end
-
-    buttonParameters.click_function = "changeColor"
-    buttonParameters.tooltip        = "change color"
-    buttonParameters.position       = { 0, 0.11, -0.65 }
-    buttonParameters.label          = playerColor
-    buttonParameters.color          = Color.fromString(playerColor)
-    buttonParameters.hover_color    = buttonParameters.color
-    self.createButton(buttonParameters)
-end
-
--- create the search button
-function createSearchButton()
-    buttonParameters.click_function = "startSearch"
-    buttonParameters.tooltip        = "start the search"
-    buttonParameters.position       = { 0, 0.11, 0.65 }
-    buttonParameters.label          = "Search"
-    buttonParameters.color          = Color.fromString("White")
-    buttonParameters.hover_color    = nil
-    self.createButton(buttonParameters)
-end
-
--- create the done buttons (with and without shuffle)
-function createDoneButton(arg)
-    if arg then
-        buttonParameters.click_function = "endSearch1"
-        buttonParameters.tooltip        = "Done (Shuffle)"
-        buttonParameters.position       = { 0, 0.11, -0.65 }
-        buttonParameters.label          = "Shuffle"
-    else
-        buttonParameters.click_function = "endSearch2"
-        buttonParameters.tooltip        = "Done (No Shuffle)"
-        buttonParameters.position       = { 0, 0.11, 0.65 }
-        buttonParameters.label          = "No Shuffle"
-    end
-
-    buttonParameters.color       = Color.fromString("White")
-    buttonParameters.hover_color = nil
-    self.createButton(buttonParameters)
-end
-
--- get the draw deck from the player mat
-function getDrawDeck()
-    mat.call("getDrawDiscardDecks")
-    return mat.getVar("drawDeck")
 end
 
 -- input_function to get number of cards to search
 function updateSearchNumber(_, _, input)
-    inputParameters.value = tonumber(input)
+  inputParameters.value = tonumber(input)
 end
 
--- start the search (change UI, set hand aside, draw cards)
+-- starts the search with the number from the input field
-function startSearch(_, color)
+function searchCustom(_, messageColor)
-    if inputParameters.value == nil then
+  local number = inputParameters.value
-        printToColor("Enter the number of cards to search in the textbox.", color, "Orange")
+  if number ~= nil then
-        return
+    startSearch(messageColor, number)
-    end
+  else
-
+    printToColor("Enter the number of cards to search in the textbox.", messageColor, "Orange")
-    local hand_data = Player[playerColor].getHandTransform()
+  end
-
-    -- make distinction between players based on hand position
-    if hand_data.position.x < -30 then
-        if hand_data.position.z > 0 then
-            playerNumber = 1
-        else
-            playerNumber = 2
-        end
-    else
-        if hand_data.position.z > 0 then
-            playerNumber = 3
-        else
-            playerNumber = 4
-        end
-    end
-
-    mat = getObjectFromGUID(MAT_GUIDS[playerNumber])
-    local zoneID = mat.getVar("zoneID")
-
-    drawDeck = getDrawDeck()
-    if drawDeck == nil then
-        printToColor("Draw pile could not be found!", color, "Red")
-        return
-    end
-
-    drawDeckPos = drawDeck.getPosition()
-    printToColor("Place target(s) of search on set aside hand.", color, "Green")
-
-    -- get position for set aside cards
-    local hand = Player[playerColor].getHandObjects()
-    deck_rotation = { hand_data.rotation.x, hand_data.rotation.y + 180, 180 }
-
-    -- for left players (p1 and p3) move to the left, for right players (p2 and p4) to the right
-    if playerNumber == 1 or playerNumber == 3 then
-        set_aside_pos = hand_data.position - 15 * hand_data.right
-    else
-        set_aside_pos = hand_data.position + 15 * hand_data.right
-    end
-
-    for i = #hand, 1, -1 do
-        hand[i].setPosition(set_aside_pos - Vector(0, i * 0.3, 0))
-        hand[i].setRotation(deck_rotation)
-    end
-
-    searchView()
-
-    -- handling for Norman Withers
-    for _, object in ipairs(getObjectFromGUID(zoneID).getObjects()) do
-        local pos = self.positionToLocal(object.getPosition())
-        if pos.z < -0.5 and object.tag == "Card" and not object.is_face_down then
-            object.flip()
-            Wait.time(function() drawDeck = getDrawDeck() end, 1)
-            break
-        end
-    end
-
-    Wait.time(function() drawDeck.deal(inputParameters.value, playerColor) end, 1)
 end
 
--- place hand back into deck and optionally shuffle
+-- start the search (change UI, set handCards aside, draw cards)
-function endSearch1() endSearch(true) end
+function startSearch(messageColor, number)
+  matColor = playmatAPI.getMatColorByPosition(self.getPosition())
 
-function endSearch2() endSearch(false) end
+  -- get draw deck
+  local drawDeck = playmatAPI.getDrawDeck(matColor)
+  if drawDeck == nil then
+    printToColor(matColor .. " draw deck could not be found!", messageColor, "Red")
+    return
+  end
 
-function endSearch(shuffle)
+  drawDeckPosition = drawDeck.getPosition()
-    local hand = Player[playerColor].getHandObjects()
+  printToColor("Place target(s) of search on set aside hand.", messageColor, "Green")
 
-    for i = #hand, 1, -1 do
+  -- get playmat orientation
-        hand[i].setPosition(drawDeckPos + Vector(0, 6 - i * 0.3, 0))
+  local offset = -15
-        hand[i].setRotation(deck_rotation)
+  if matColor == "Orange" or matColor == "Red" then
+    offset = 15
+  end
+
+  -- get position and rotation for set aside cards
+  local handData   = Player[matColor].getHandTransform()
+  local handCards  = Player[matColor].getHandObjects()
+  setAsidePosition = handData.position + offset * handData.right
+  setAsideRotation = { handData.rotation.x, handData.rotation.y + 180, 180 }
+
+  for i = #handCards, 1, -1 do
+    handCards[i].setPosition(setAsidePosition - Vector(0, i * 0.3, 0))
+    handCards[i].setRotation(setAsideRotation)
+  end
+
+  -- handling for Norman Withers
+  for _, v in ipairs(searchArea(drawDeckPosition)) do
+    local object = v.hit_object
+    if object.tag == "Card" and not object.is_face_down then
+      object.flip()
+      Wait.time(function() drawDeck = playmatAPI.getDrawDeck(matColor) end, 1)
+      break
     end
+  end
 
-    if shuffle then
+  Wait.time(function() drawDeck.deal(number, matColor) end, 1)
-        Wait.time(function()
+  searchView()
-            local deck = getDrawDeck()
-            if deck ~= nil then
-                deck.shuffle()
-            end
-        end, 2)
-    end
-
-    -- draw set aside cards (from the ground!)
-    local objs = Physics.cast({
-        origin = set_aside_pos - Vector(0, 5, 0),
-        direction = { 0, 1, 0 },
-        type = 3,
-        size = { 2, 2, 2 },
-        max_distance = 0
-    })
-
-    for _, v in ipairs(objs) do
-        local obj = v.hit_object
-        if obj.tag == "Deck" then
-            Wait.time(function()
-                obj.deal(#obj.getObjects(), playerColor)
-            end, 1)
-            break
-        elseif obj.tag == "Card" then
-            obj.setPosition(Player[playerColor].getHandTransform().position)
-            obj.flip()
-            break
-        end
-    end
-
-    normalView()
 end
 
--- helper to search array
+-- place handCards back into deck and optionally shuffle
-function indexOf(array, value)
+function endSearch(_, _, isRightClick)
-    for i, v in ipairs(array) do
+  local handCards = Player[matColor].getHandObjects()
-        if v == value then return i end
+
+  for i = #handCards, 1, -1 do
+    handCards[i].setPosition(drawDeckPosition + Vector(0, 6 - i * 0.3, 0))
+    handCards[i].setRotation(setAsideRotation)
+  end
+
+  if not isRightClick then
+    Wait.time(function()
+      local deck = playmatAPI.getDrawDeck(matColor)
+      if deck ~= nil then
+        deck.shuffle()
+      end
+    end, 2)
+  end
+
+  -- draw set aside cards (from the ground!)
+  for _, v in ipairs(searchArea(setAsidePosition - Vector(0, 5, 0))) do
+    local obj = v.hit_object
+    if obj.tag == "Deck" then
+      Wait.time(function()
+        obj.deal(#obj.getObjects(), matColor)
+      end, 1)
+      break
+    elseif obj.tag == "Card" then
+      obj.setPosition(Player[matColor].getHandTransform().position)
+      obj.flip()
+      break
     end
+  end
+
+  normalView()
+end
+
+-- utility function
+function searchArea(position)
+  return Physics.cast({
+    origin = position,
+    direction = { 0, 1, 0 },
+    type = 3,
+    size = { 2, 2, 2 },
+    max_distance = 0
+  })
 end

src/core/Global.ttslua

@@ -850,6 +850,13 @@ function applyOptionPanelChange(id, state)
     optionPanel[id][3] = spawnOrRemoveHelper(state, "Hand Helper", {-39.27, 1.6, 22.44}, {0, 000, 0}, "Green")
     optionPanel[id][4] = spawnOrRemoveHelper(state, "Hand Helper", {-21.51, 1.6, -22.44}, {0, 180, 0}, "Red")
 
+  -- option: Show search assistant for each player
+  elseif id == "showSearchAssistant" then
+    optionPanel[id][1] = spawnOrRemoveHelper(state, "Search Assistant", {-50.84, 1.6, 10.16}, {0, 270, 0})
+    optionPanel[id][2] = spawnOrRemoveHelper(state, "Search Assistant", {-50.90, 1.6, -21.96}, {0, 270, 0})
+    optionPanel[id][3] = spawnOrRemoveHelper(state, "Search Assistant", {-36.21, 1.6, 22.44}, {0, 000, 0})
+    optionPanel[id][4] = spawnOrRemoveHelper(state, "Search Assistant", {-24.46, 1.6, -22.44}, {0, 180, 0})
+
   -- option: Show chaos bag manager
   elseif id == "showChaosBagManager" then
     optionPanel[id] = spawnOrRemoveHelper(state, "Chaos Bag Manager", {-67.8, 1.6, -49.5})
@@ -936,6 +943,7 @@ function removeHelperObject(name)
     ["Token Arranger"]                 = "showTokenArranger",
     ["Clean Up Helper"]                = "showCleanUpHelper",
     ["Hand Helper"]                    = "showHandHelper",
+    ["Search Assistant"]               = "showSearchAssistant",
     ["Chaos Bag Manager"]              = "showChaosBagManager",
     ["jaqenZann's Navigation Overlay"] = "showNavigationOverlay",
     ["Displacement Tool"]              = "showDisplacementTool",
@@ -983,6 +991,7 @@ function onClick_defaultSettings()
     showDrawButton = false,
     showHandHelper = {},
     showNavigationOverlay = false,
+    showSearchAssistant = {},
     showTitleSplash = true,
     showTokenArranger = false,
     useClueClickers = false,

xml/OptionPanel.xml

@@ -247,6 +247,20 @@
             </Cell>
           </Row>
 
+          <!-- Option: show search assistant -->
+          <Row class="option-text">
+            <Cell class="option-text">
+              <VerticalLayout class="text-column">
+                <Text class="option-header">Search Assistant</Text>
+                <Text class="description">Quickly search 3, 6, 9 or the top X cards of your deck!</Text>
+              </VerticalLayout>
+            </Cell>
+            <Cell class="option-button">
+              <Toggle id="showSearchAssistant"
+                onValueChanged="onClick_toggleOption(showSearchAssistant)"/>
+            </Cell>
+          </Row>
+
           <!-- Option: show chaos bag manager -->
           <Row class="option-text">
             <Cell class="option-text">