76 lines
3.1 KiB
Plaintext
76 lines
3.1 KiB
Plaintext
do
|
|
local PlayAreaApi = { }
|
|
|
|
local PLAY_AREA_GUID = "721ba2"
|
|
|
|
-- Returns the current value of the investigator counter from the playmat
|
|
---@return Integer. Number of investigators currently set on the counter
|
|
PlayAreaApi.getInvestigatorCount = function()
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("getInvestigatorCount")
|
|
end
|
|
|
|
-- Move all contents on the play area (cards, tokens, etc) one slot in the given direction. Certain
|
|
-- fixed objects will be ignored, as will anything the player has tagged with
|
|
-- 'displacement_excluded'
|
|
---@param playerColor Color of the player requesting the shift. Used solely to send an error
|
|
--- message in the unlikely case that the scripting zone has been deleted
|
|
PlayAreaApi.shiftContentsUp = function(playerColor)
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("shiftContentsUp", playerColor)
|
|
end
|
|
|
|
PlayAreaApi.shiftContentsDown = function(playerColor)
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("shiftContentsDown", playerColor)
|
|
end
|
|
|
|
PlayAreaApi.shiftContentsLeft = function(playerColor)
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("shiftContentsLeft", playerColor)
|
|
end
|
|
|
|
PlayAreaApi.shiftContentsRight = function(playerColor)
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("shiftContentsRight", playerColor)
|
|
end
|
|
|
|
-- Reset the play area's tracking of which cards have had tokens spawned.
|
|
PlayAreaApi.resetSpawnedCards = function()
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("resetSpawnedCards")
|
|
end
|
|
|
|
-- Event to be called when the current scenario has changed.
|
|
---@param scenarioName Name of the new scenario
|
|
PlayAreaApi.onScenarioChanged = function(scenarioName)
|
|
getObjectFromGUID(PLAY_AREA_GUID).call("onScenarioChanged", scenarioName)
|
|
end
|
|
|
|
-- Sets this playmat's snap points to limit snapping to locations or not.
|
|
-- If matchTypes is false, snap points will be reset to snap all cards.
|
|
---@param matchTypes Boolean Whether snap points should only snap for the matching card types.
|
|
PlayAreaApi.setLimitSnapsByType = function(matchCardTypes)
|
|
getObjectFromGUID(PLAY_AREA_GUID).call("setLimitSnapsByType", matchCardTypes)
|
|
end
|
|
|
|
-- Receiver for the Global tryObjectEnterContainer event. Used to clear vector lines from dragged
|
|
-- cards before they're destroyed by entering the container
|
|
PlayAreaApi.tryObjectEnterContainer = function(container, object)
|
|
getObjectFromGUID(PLAY_AREA_GUID).call("tryObjectEnterContainer",
|
|
{ container = container, object = object })
|
|
end
|
|
|
|
-- counts the VP on locations in the play area
|
|
PlayAreaApi.countVP = function()
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("countVP")
|
|
end
|
|
|
|
-- highlights all locations in the play area without metadata
|
|
---@param state Boolean True if highlighting should be enabled
|
|
PlayAreaApi.highlightMissingData = function(state)
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("highlightMissingData", state)
|
|
end
|
|
|
|
-- Checks if an object is in the play area (returns true or false)
|
|
PlayAreaApi.isInPlayArea = function(object)
|
|
return getObjectFromGUID(PLAY_AREA_GUID).call("isInPlayArea", object)
|
|
end
|
|
|
|
return PlayAreaApi
|
|
end
|