adam/SCED
1
0
Fork 0
Code Actions Releases 8 Activity

integrated preview window

Browse Source
This commit is contained in:
Chr1Z93 2023-10-17 00:29:07 +02:00
parent 2edc6e5233
commit e045454ff7
5 changed files with 182 additions and 261 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

206
src/core/Global.ttslua
View File

@ -43,15 +43,16 @@ local hideTitleSplashWaitFunctionId = nil
-- online functionality related variables -- online functionality related variables
local MOD_VERSION = "3.3.0" local MOD_VERSION = "3.3.0"
local SOURCE_REPO = 'https://raw.githubusercontent.com/chr1z93/loadable-objects/main' local SOURCE_REPO = 'https://raw.githubusercontent.com/chr1z93/loadable-objects/main'
local library, requestObj, modMeta, contentToShow, currentListItem local library, requestObj, modMeta
local acknowledgedUpgradeVersions = {} local acknowledgedUpgradeVersions = {}
local contentToShow = "campaigns"
local currentListItem = 1
local xmlVisibility = { local xmlVisibility = {
updateNotification = false,
downloadWindow = false, downloadWindow = false,
previewWindow = false, optionPanel = false,
optionPanel = false updateNotification = false
} }
local idTable = { local tabIdTable = {
tab1 = "campaigns", tab1 = "campaigns",
tab2 = "scenarios", tab2 = "scenarios",
tab3 = "fanmadeCampaigns", tab3 = "fanmadeCampaigns",
@ -158,7 +159,7 @@ function onLoad(savedData)
-- initialization of loadable objects library (delay to let Navigation Overlay build) -- initialization of loadable objects library (delay to let Navigation Overlay build)
Wait.time(function() Wait.time(function()
WebRequest.get(SOURCE_REPO .. '/library.json', completed_list_update) WebRequest.get(SOURCE_REPO .. '/library.json', libraryDownloadCallback)
end, 1) end, 1)
end end
@ -638,48 +639,45 @@ end
--------------------------------------------------------- ---------------------------------------------------------
-- forwards the requested content type to the update function and sets highlight to clicked tab -- forwards the requested content type to the update function and sets highlight to clicked tab
---@param id String Id of the clicked tab ---@param tabId String Id of the clicked tab
function onClick_tab(_, _, id) function onClick_tab(_, _, tabId)
for listId, listContent in pairs(idTable) do for listId, listContent in pairs(tabIdTable) do
if listId == id then if listId == tabId then
UI.setClass(listId, 'downloadTab activeTab') UI.setClass(listId, 'downloadTab activeTab')
contentToShow = listContent contentToShow = listContent
else else
UI.setClass(listId, 'downloadTab') UI.setClass(listId, 'downloadTab')
end end
end end
currentListItem = 1
updateDownloadItemList() updateDownloadItemList()
-- select the first item
Wait.time(function() onClick_select(_, _, contentToShow .. "_1") end, 0.1)
end end
-- click function for the items in the download window -- click function for the items in the download window
-- updates backgroundcolor for row panel and fontcolor for list item -- updates backgroundcolor for row panel and fontcolor for list item
function onClick_select(_, _, id) function onClick_select(_, _, identificationKey)
if currentListItem then UI.setAttribute("panel" .. currentListItem, "color", "clear")
UI.setAttribute("panel" .. currentListItem, "color", "clear") UI.setAttribute(contentToShow .. "_" .. currentListItem, "color", "white")
UI.setAttribute(contentToShow .. "_" .. currentListItem, "color", "white")
end
-- parses the identification key (contentToShow_currentListItem) -- parses the identification key (contentToShow_currentListItem)
contentToShow = nil if identificationKey then
currentListItem = nil contentToShow = nil
for str in string.gmatch(id, "([^_]+)") do currentListItem = nil
if not contentToShow then for str in string.gmatch(identificationKey, "([^_]+)") do
-- grab the first part to know the content type if not contentToShow then
contentToShow = str -- grab the first part to know the content type
else contentToShow = str
-- get the index else
currentListItem = tonumber(str) -- get the index
break currentListItem = tonumber(str)
break
end
end end
end end
UI.setAttribute("panel" .. currentListItem, "color", "grey") UI.setAttribute("panel" .. currentListItem, "color", "grey")
UI.setAttribute(contentToShow .. "_" .. currentListItem, "color", "black") UI.setAttribute(contentToShow .. "_" .. currentListItem, "color", "black")
updatePreviewWindow()
updateAndShowPreviewWindow()
end end
-- click function for the download button in the preview window -- click function for the download button in the preview window
@ -691,7 +689,7 @@ end
---@param param Table contains url and guid of replacement object ---@param param Table contains url and guid of replacement object
function placeholder_download(param) function placeholder_download(param)
local url = SOURCE_REPO .. '/' .. param.url local url = SOURCE_REPO .. '/' .. param.url
requestObj = WebRequest.get(url, function (request) complete_obj_download(request, param) end) requestObj = WebRequest.get(url, function (request) contentDownloadCallback(request, param) end)
startLuaCoroutine(Global, 'downloadCoroutine') startLuaCoroutine(Global, 'downloadCoroutine')
end end
@ -720,7 +718,6 @@ function downloadCoroutine()
if xmlVisibility.downloadWindow then if xmlVisibility.downloadWindow then
xmlVisibility.downloadWindow = false xmlVisibility.downloadWindow = false
UI.hide('downloadWindow') UI.hide('downloadWindow')
UI.hide("previewWindow")
end end
return 1 return 1
end end
@ -731,48 +728,32 @@ end
function onClick_toggleUi(player, title) function onClick_toggleUi(player, title)
if title == "Navigation Overlay" then if title == "Navigation Overlay" then
navigationOverlayApi.cycleVisibility(player.color) navigationOverlayApi.cycleVisibility(player.color)
elseif title == "Downloadable Content" then
if xmlVisibility.downloadWindow then
UI.hide('downloadWindow')
UI.hide("previewWindow")
else
if xmlVisibility.previewWindow then
UI.show("previewWindow")
end
UI.show('downloadWindow')
end
xmlVisibility.downloadWindow = not xmlVisibility.downloadWindow
elseif title == "Options" then
if xmlVisibility.optionPanel then
UI.hide('optionPanel')
else
UI.show('optionPanel')
end
xmlVisibility.optionPanel = not xmlVisibility.optionPanel
end
end
-- updates + shows the preview window
function updateAndShowPreviewWindow()
xmlVisibility.previewWindow = false
UI.hide("previewWindow")
-- get metadata from library
local item = library[contentToShow][currentListItem]
-- error handling (only author + description can by empty)
if not item
or not item.name or item.name == ""
or not item.boxsize or item.boxsize == ""
or not item.boxart or item.boxart == "" then
return return
end end
UI.setValue("previewTitle", item.name) if xmlVisibility[title] then
UI.setValue("previewAuthor", "by " .. (item.author) or "Unknown") UI.hide(title)
UI.setValue("previewDescription", item.description or "") else
UI.show(title)
end
xmlVisibility[title] = not xmlVisibility[title]
end
-- update mask according to size -- updates the preview window
function updatePreviewWindow()
local item = library[contentToShow][currentListItem]
-- set default image if not defined
if item.boxsize == nil or item.boxsize == "" or item.boxart == nil or item.boxart == "" then
item.boxsize = "big"
item.boxart = "http://cloud-3.steamusercontent.com/ugc/762723517667628371/18438B0A0045038A7099648AA3346DFCAA267C66/"
end
UI.setValue("previewTitle", item.name)
UI.setValue("previewAuthor", "by " .. (item.author) or "- Author not found -")
UI.setValue("previewDescription", item.description or "- Description not found -")
-- update mask according to size (hardcoded values to align image in mask)
local maskData = {} local maskData = {}
if item.boxsize == "big" then if item.boxsize == "big" then
maskData = { maskData = {
@ -784,48 +765,22 @@ function updateAndShowPreviewWindow()
elseif item.boxsize == "small" then elseif item.boxsize == "small" then
maskData = { maskData = {
image = "box-cover-mask-small", image = "box-cover-mask-small",
width = "668", width = "792",
height = "501", height = "594",
offsetXY = "120 10" offsetXY = "135 13"
} }
elseif item.boxsize == "wide" then elseif item.boxsize == "wide" then
maskData = { maskData = {
image = "box-cover-mask-wide", image = "box-cover-mask-wide",
width = "780", width = "756",
height = "650", height = "630",
offsetXY = "-195 -70" offsetXY = "-190 -70"
} }
end end
-- insert the image itself -- insert the image itself
UI.setAttribute("previewArtImage", "image", item.boxart) UI.setAttribute("previewArtImage", "image", item.boxart)
-- update the preview window height according to box size
local hWindow, hArt, offsetXY
if item.boxsize == "big" then
hWindow = 560
hArt = 300
offsetXY = "-476 120"
elseif item.boxsize == "small" then
hWindow = 560
hArt = 300
offsetXY = "-476 120"
elseif item.boxsize == "wide" then
hWindow = 410
hArt = 150
offsetXY = "-476 195"
end
UI.setAttributes("previewArtMask", maskData) UI.setAttributes("previewArtMask", maskData)
UI.setAttribute("previewArtPanel", "preferredHeight", hArt)
UI.setAttributes("previewWindow", {
height = hWindow,
offsetXY = offsetXY
})
-- show the window
xmlVisibility.previewWindow = true
UI.show("previewWindow")
end end
-- formats the json response from the webrequest into a key-value lua table -- formats the json response from the webrequest into a key-value lua table
@ -866,22 +821,13 @@ end
function updateDownloadItemList() function updateDownloadItemList()
if not library then return end if not library then return end
-- set title according to type
local cleanName = {
campaigns = "Campaigns",
scenarios = "Scenarios",
fanmadeCampaigns = "Fan-Made Campaigns",
fanmadePlayerCards = "Fan-Made Player Cards",
fanmadeScenarios = "Fan-Made Scenarios"
}
UI.setValue("title", "Downloadable Content: " .. cleanName[contentToShow])
-- addition of list items according to library file -- addition of list items according to library file
local ui = UI.getXmlTable() local globalXml = UI.getXmlTable()
local update_point = find_tag_with_id(ui, 'ui_update_point') local contentList = getXmlTableElementById(globalXml, 'contentList')
update_point.children = {}
contentList.children = {}
for i, v in ipairs(library[contentToShow]) do for i, v in ipairs(library[contentToShow]) do
table.insert(update_point.children, table.insert(contentList.children,
{ {
tag = "Panel", tag = "Panel",
attributes = { id = "panel" .. i }, attributes = { id = "panel" .. i },
@ -897,13 +843,16 @@ function updateDownloadItemList()
}) })
end end
update_point.attributes.height = #update_point.children * 25 contentList.attributes.height = #contentList.children * 27
UI.setXmlTable(ui) UI.setXmlTable(globalXml)
-- select the first item
Wait.time(onClick_select, 0.2)
end end
-- called after the webrequest of downloading an item -- called after the webrequest of downloading an item
-- deletes the placeholder and spawns the downloaded item -- deletes the placeholder and spawns the downloaded item
function complete_obj_download(request, param) function contentDownloadCallback(request, param)
requestObj = nil requestObj = nil
-- error handling -- error handling
@ -939,7 +888,7 @@ function complete_obj_download(request, param)
end end
-- downloading of the library file -- downloading of the library file
function completed_list_update(request) function libraryDownloadCallback(request)
if request.is_error or request.response_code ~= 200 then if request.is_error or request.response_code ~= 200 then
print('error: ' .. request.error) print('error: ' .. request.error)
return return
@ -948,7 +897,6 @@ function completed_list_update(request)
local json_response = nil local json_response = nil
if pcall(function () json_response = JSON.decode(request.text) end) then if pcall(function () json_response = JSON.decode(request.text) end) then
formatLibrary(json_response) formatLibrary(json_response)
contentToShow = "campaigns"
updateDownloadItemList() updateDownloadItemList()
else else
print('error parsing downloaded library') print('error parsing downloaded library')
@ -958,11 +906,11 @@ end
-- loops through an XML table and returns the specified object -- loops through an XML table and returns the specified object
---@param ui Table XmlTable (get this via getXmlTable) ---@param ui Table XmlTable (get this via getXmlTable)
---@param id String Id of the object to return ---@param id String Id of the object to return
function find_tag_with_id(ui, id) function getXmlTableElementById(ui, id)
for _, obj in ipairs(ui) do for _, obj in ipairs(ui) do
if obj.attributes and obj.attributes.id and obj.attributes.id == id then return obj end if obj.attributes and obj.attributes.id and obj.attributes.id == id then return obj end
if obj.children then if obj.children then
local result = find_tag_with_id(obj.children, id) local result = getXmlTableElementById(obj.children, id)
if result then return result end if result then return result end
end end
end end
@ -1298,17 +1246,6 @@ function updateNotificationLoading()
UI.setAttribute("updateNotification", "height", 20*#highlights + 125) UI.setAttribute("updateNotification", "height", 20*#highlights + 125)
end end
-- triggered by clicking on the Finn Icon
function onClick_FinnIcon()
if xmlVisibility.updateNotification then
UI.hide("updateNotification")
xmlVisibility.updateNotification = false
else
UI.show("updateNotification")
xmlVisibility.updateNotification = true
end
end
-- close / don't show again buttons on the update notification -- close / don't show again buttons on the update notification
function onClick_notification(_, parameter) function onClick_notification(_, parameter)
if parameter == "dontShowAgain" then if parameter == "dontShowAgain" then
@ -1317,4 +1254,5 @@ function onClick_notification(_, parameter)
end end
UI.hide("FinnIcon") UI.hide("FinnIcon")
UI.hide("updateNotification") UI.hide("updateNotification")
xmlVisibility["updateNotification"] = false
end end

4
xml/Global/BottomBar.xml
View File

@ -18,11 +18,11 @@
<Button class="navbar" <Button class="navbar"
icon="devourer" icon="devourer"
tooltip="Downloadable Content" tooltip="Downloadable Content"
onClick="onClick_toggleUi(Downloadable Content)"/> onClick="onClick_toggleUi(downloadWindow)"/>
<Button class="navbar" <Button class="navbar"
icon="option-gear" icon="option-gear"
tooltip="Options" tooltip="Options"
onClick="onClick_toggleUi(Options)"/> onClick="onClick_toggleUi(optionPanel)"/>
</VerticalLayout> </VerticalLayout>
<!-- Navigation Overlay button (not visibly to Grey and Black) --> <!-- Navigation Overlay button (not visibly to Grey and Black) -->

225
xml/Global/DownloadWindow.xml
View File

@ -1,17 +1,14 @@
<Defaults> <Defaults>
<!-- download tab buttons -->
<Button class="downloadTab" <Button class="downloadTab"
hoverClass="hover" hoverClass="bGrey"
pressClass="press" pressClass="bWhite"
onClick="onClick_tab" onClick="onClick_tab"
color="#888888" color="#888888"
fontSize="24" fontSize="24"
font="font_teutonic-arkham"/> font="font_teutonic-arkham"/>
<Button class="hover" <Button class="bGrey"
color="grey"/> color="grey"/>
<Button class="press" <Button class="bWhite"
color="white"/>
<Button class="select"
color="white"/> color="white"/>
<Button class="activeTab" <Button class="activeTab"
color="#ffffff"/> color="#ffffff"/>
@ -22,138 +19,122 @@
visibility="Admin" visibility="Admin"
color="black" color="black"
active="false" active="false"
onMouseExit="onMouseExit_window"
width="650"
height="800" height="800"
outlineSize="1 1" width="900"
outlineSize="2 2"
outline="#303030"> outline="#303030">
<!-- header --> <!-- window header -->
<Panel preferredHeight="60" <Panel preferredHeight="60"
padding="10 10 5 0"> padding="10 10 5 5"
<Panel preferredWidth="500"> outlineSize="2 2"
<Text id="title" outline="#303030"
fontSize="32" color="black">
font="font_teutonic-arkham" <Text fontSize="32"
alignment="MiddleLeft">Downloadable Content</Text> font="font_teutonic-arkham"
</Panel> alignment="MiddleLeft">Downloadable Content</Text>
<Panel> <Panel>
<Button rectAlignment="MiddleRight" <Button rectAlignment="MiddleRight"
width="50" width="50"
color="clear" color="clear"
icon="close" icon="close"
tooltip="Close" tooltip="Close"
onClick="onClick_toggleUi(Downloadable Content)"/> tooltipPosition="Right"
tooltipBackgroundColor="rgba(0,0,0,1)"
onClick="onClick_toggleUi(downloadWindow)"/>
</Panel> </Panel>
</Panel> </Panel>
<!-- tab selection --> <HorizontalLayout>
<HorizontalLayout preferredHeight="60" <VerticalLayout preferredWidth="600">
padding="5" <!-- tab selection -->
spacing="5"> <HorizontalLayout preferredHeight="60"
<Button class="downloadTab activeTab" padding="5"
id="tab1">Official Campaigns</Button> spacing="5">
<Button class="downloadTab" <Button class="downloadTab activeTab"
id="tab2">Official Scenarios</Button> id="tab1">Official Campaigns</Button>
<Button class="downloadTab" <Button class="downloadTab"
id="tab3">Fan-Made Campaigns</Button> id="tab2">Official Scenarios</Button>
<Button class="downloadTab" <Button class="downloadTab"
id="tab4">Fan-Made Scenarios</Button> id="tab3">Fan-Made Campaigns</Button>
<Button class="downloadTab" <Button class="downloadTab"
id="tab5">Fan-Made Player Cards</Button> id="tab4">Fan-Made Scenarios</Button>
</HorizontalLayout> <Button class="downloadTab"
id="tab5">Fan-Made Player Cards</Button>
</HorizontalLayout>
<!-- content list --> <!-- content list -->
<VerticalScrollView color="transparent" <VerticalScrollView color="transparent"
minHeight="100" minHeight="100"
flexibleHeight="100" flexibleHeight="100"
scrollSensitivity="25" scrollSensitivity="27"
scrollbarColors="grey|grey|#C8C8C8|rgba(0.78,0.78,0.78,0.5)" scrollbarColors="grey|grey|#C8C8C8|rgba(0.78,0.78,0.78,0.5)"
horizontalScrollbarVisibility="AutohideAndExpandViewport"> horizontalScrollbarVisibility="AutohideAndExpandViewport"
<VerticalLayout id="ui_update_point" raycastTarget="true">
padding="10 25 0 0" <VerticalLayout id="contentList"
spacing="1"> padding="10 25 0 0">
<!-- this will be filled via scripting --> <!-- this will be filled via scripting -->
</VerticalLayout>
</VerticalScrollView>
</VerticalLayout> </VerticalLayout>
</VerticalScrollView>
</VerticalLayout>
<!-- content preview window (displayed on hover of list items) --> <!-- content preview window -->
<VerticalLayout id="previewWindow" <VerticalLayout preferredWidth="300"
visibility="Admin" padding="15 15 15 5">
color="black"
active="false"
width="300"
height="560"
padding="15 15 5 5"
outlineSize="1 1"
outline="#303030"
offsetXY="-476 120">
<!-- header --> <!-- header -->
<VerticalLayout preferredHeight="100"> <VerticalLayout preferredHeight="110">
<Text id="previewTitle" <Text id="previewTitle"
fontSize="28" fontSize="28"
font="font_teutonic-arkham">PreviewTitle</Text> preferredHeight="70"
<Text id="previewAuthor" font="font_teutonic-arkham">PreviewTitle</Text>
fontSize="20" <Text id="previewAuthor"
font="font_teutonic-arkham">by PreviewAuthor</Text> fontSize="20"
</VerticalLayout> preferredHeight="40"
font="font_teutonic-arkham">by PreviewAuthor</Text>
</VerticalLayout>
<!-- box art --> <!-- box art -->
<Panel id="previewArtPanel" <Panel id="previewArtPanel"
preferredHeight="300"> preferredHeight="390">
<Mask id="previewArtMask"> <Mask id="previewArtMask">
<Image id="previewArtImage" /> <!-- image will be set via scripting -->
</Mask> <Image id="previewArtImage" />
</Mask>
</Panel>
<!-- mask for scenario size boxes <!-- description -->
<Mask image="box-cover-mask-small" width="668" height="501" offsetXY="120 10"> <Panel preferredHeight="160">
<Image image="testArtSmall"/> <Text id="previewDescription"
</Mask> alignment="UpperLeft"
--> resizeTextForBestFit="true"
resizeTextMinSize="12"
resizeTextMaxSize="18">PreviewDescription</Text>
</Panel>
<!--mask for campaign size boxes <!-- download button / progress bar (visibility handled by lua code)-->
<Mask image="box-cover-mask-big" width="870" height="435" offsetXY="154 60"> <Panel preferredHeight="60">
<Image image="testArtBig"/> <!-- download progress bar -->
</Mask> <ProgressBar id="download_progress"
--> active="false"
height="50"
<!--mask for "return to" size boxes width="270"
<Mask image="box-cover-mask-wide" width="780" height="650" offsetXY="-195 -50"> percentage="0"
<Image image="testArtWide"/> color="#111111"
</Mask> textColor="#aaaaaa"
--> fillImageColor="#333333"/>
</Panel> <!-- download button -->
<Button id="download_button"
<!-- description --> hoverClass="bGrey"
<Panel preferredHeight="100"> pressClass="bWhite"
<Text id="previewDescription" selectClass="bWhite"
fontSize="20" onClick="onClick_download"
font="font_teutonic-arkham">PreviewDescription</Text> color="#888888"
</Panel> height="50"
width="270"
<!-- download button / progress bar (visibility handled by lua code)--> fontSize="28"
<Panel preferredHeight="50" font="font_teutonic-arkham">Download</Button>
padding="5"> </Panel>
<!-- download progress bar --> </VerticalLayout>
<ProgressBar id="download_progress" </HorizontalLayout>
active="false" </VerticalLayout>
height="40"
percentage="0"
color="#111111"
textColor="#aaaaaa"
fillImageColor="#333333"/>
<!-- download button -->
<Button id="download_button"
hoverClass="hover"
pressClass="press"
selectClass="select"
onClick="onClick_download"
color="#888888"
height="40"
width="250"
fontSize="24"
font="font_teutonic-arkham">Download</Button>
</Panel>
</VerticalLayout>

3
xml/Global/OptionPanel.xml
View File

@ -79,6 +79,7 @@
<!-- Option Panel --> <!-- Option Panel -->
<TableLayout id="optionPanel" <TableLayout id="optionPanel"
class="window" class="window"
visibility="Admin"
rectAlignment="LowerRight" rectAlignment="LowerRight"
offsetXY="-50 80" offsetXY="-50 80"
raycastTarget="true"> raycastTarget="true">
@ -358,7 +359,7 @@
<Button class="bottomButtons" <Button class="bottomButtons"
onClick="onClick_defaultSettings">Load defaults</Button> onClick="onClick_defaultSettings">Load defaults</Button>
<Button class="bottomButtons" <Button class="bottomButtons"
onClick="onClick_toggleUi(Options)">Close</Button> onClick="onClick_toggleUi(optionPanel)">Close</Button>
</HorizontalLayout> </HorizontalLayout>
</Cell> </Cell>
</Row> </Row>

5
xml/Global/UpdateNotification.xml
View File

@ -10,10 +10,11 @@
offsetXY="420 -5" offsetXY="420 -5"
height="90" height="90"
width="90" width="90"
onClick="onClick_FinnIcon" onClick="onClick_toggleUi(updateNotification)"
image="FinnIcon" image="FinnIcon"
tooltip="Update notification" tooltip="Update notification"
tooltipBackgroundColor="rgba(0,0,0,0.8)"/> tooltipPosition="Right"
tooltipBackgroundColor="rgba(0,0,0,1)"/>
<!-- main notification window --> <!-- main notification window -->
<TableLayout id="updateNotification" <TableLayout id="updateNotification"