feat(jukebox): add sound menu search filter fields

Author: perry519

README.md

@@ -2,6 +2,8 @@
 
 Adds a search/filter field to the top of the BLT mod options list and Mod Overrides list.
 
+Also adds filter fields to the Jukebox heist playlist, heist tracks, and menu playlist screens.
+
 Type in the `Filter` input to narrow the visible mods by mod name or description.
 
 ## Requirements

mod.txt

@@ -2,7 +2,7 @@
 	"name": "Mod Options Search Filter",
 	"description": "Adds search filter fields to the BLT mod options and installed mod_overrides lists.",
 	"author": "Perry",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"blt_version": 2,
 	"priority": 1,
 	"updates": [

modoptionssearchfilter.lua

@@ -14,6 +14,7 @@ local modules = {
 	"modules/shared/context.lua",
 	"modules/blt/context.lua",
 	"modules/mo/context.lua",
+	"modules/jukebox/context.lua",
 	"modules/shared/input.lua",
 	"modules/shared/order.lua",
 	"modules/shared/filter.lua",
@@ -22,6 +23,7 @@ local modules = {
 	"modules/blt/order.lua",
 	"modules/blt/menu.lua",
 	"modules/mo/menu.lua",
+	"modules/jukebox/menu.lua",
 	"modules/shared/core.lua",
 }
 

modules/jukebox/context.lua

@@ -0,0 +1,95 @@
+_G.ModOptionsSearchFilter = _G.ModOptionsSearchFilter or {}
+
+local ModOptionsSearchFilter = _G.ModOptionsSearchFilter
+
+local MARKER = "_mod_options_search_jukebox_context"
+
+ModOptionsSearchFilter.JUKEBOX_CONTEXT_MARKER = MARKER
+ModOptionsSearchFilter.JUKEBOX_HEIST_PLAYLIST_INPUT_ID = "jukebox_heist_playlist_search_filter"
+ModOptionsSearchFilter.JUKEBOX_HEIST_TRACKS_INPUT_ID = "jukebox_heist_tracks_search_filter"
+ModOptionsSearchFilter.JUKEBOX_MENU_PLAYLIST_INPUT_ID = "jukebox_menu_playlist_search_filter"
+ModOptionsSearchFilter.CALLBACKS.open_jukebox_heist_playlist_search = "jukebox_heist_playlist_search_open"
+ModOptionsSearchFilter.CALLBACKS.open_jukebox_heist_tracks_search = "jukebox_heist_tracks_search_open"
+ModOptionsSearchFilter.CALLBACKS.open_jukebox_menu_playlist_search = "jukebox_menu_playlist_search_open"
+
+function ModOptionsSearchFilter:NodeHasJukeboxCallback(node, callback_name)
+	if not node or not callback_name then
+		return false
+	end
+
+	local items = self.GetNodeItems and self:GetNodeItems(node) or node._items or {}
+
+	for _, item in pairs(items) do
+		local parameters = self.ItemParameters and self:ItemParameters(item) or item and item._parameters or {}
+
+		if parameters.callback == callback_name then
+			return true
+		end
+	end
+
+	return false
+end
+
+function ModOptionsSearchFilter:IsJukeboxSearchNode(node_gui, node, context_key, callback_name)
+	local target_node = node or node_gui and node_gui.node or node_gui
+
+	if not target_node then
+		return false
+	end
+
+	if target_node[MARKER] == context_key then
+		return true
+	end
+
+	local parameters = self:GetNodeParameters(target_node)
+
+	if parameters and parameters[MARKER] == context_key then
+		return true
+	end
+
+	return self:NodeHasJukeboxCallback(target_node, callback_name)
+end
+
+ModOptionsSearchFilter:RegisterSearchContext({
+	key = "jukebox_heist_playlist",
+	menu_id = "jukebox_heist_playlist",
+	input_id = ModOptionsSearchFilter.JUKEBOX_HEIST_PLAYLIST_INPUT_ID,
+	callback_id = ModOptionsSearchFilter.CALLBACKS.open_jukebox_heist_playlist_search,
+	handle_field = "JukeboxHeistPlaylistSearchInput",
+	text_field = "jukebox_heist_playlist_search_text",
+	desc = "Filter custom heist playlist.",
+	accepts_search_item = true,
+	matches = function(owner, node_gui, node)
+		return owner:IsJukeboxSearchNode(node_gui, node, "jukebox_heist_playlist", "jukebox_option_heist_playlist")
+	end
+})
+
+ModOptionsSearchFilter:RegisterSearchContext({
+	key = "jukebox_heist_tracks",
+	menu_id = "jukebox_heist_tracks",
+	input_id = ModOptionsSearchFilter.JUKEBOX_HEIST_TRACKS_INPUT_ID,
+	callback_id = ModOptionsSearchFilter.CALLBACKS.open_jukebox_heist_tracks_search,
+	handle_field = "JukeboxHeistTracksSearchInput",
+	text_field = "jukebox_heist_tracks_search_text",
+	desc = "Filter custom heist tracks.",
+	accepts_search_item = true,
+	matches = function(owner, node_gui, node)
+		return owner:IsJukeboxSearchNode(node_gui, node, "jukebox_heist_tracks", "jukebox_option_heist_tracks")
+	end
+})
+
+ModOptionsSearchFilter:RegisterSearchContext({
+	key = "jukebox_menu_playlist",
+	menu_id = "jukebox_menu_playlist",
+	input_id = ModOptionsSearchFilter.JUKEBOX_MENU_PLAYLIST_INPUT_ID,
+	callback_id = ModOptionsSearchFilter.CALLBACKS.open_jukebox_menu_playlist_search,
+	handle_field = "JukeboxMenuPlaylistSearchInput",
+	text_field = "jukebox_menu_playlist_search_text",
+	desc = "Filter custom menu playlist.",
+	accepts_search_item = true,
+	matches = function(owner, node_gui, node)
+		return owner:IsJukeboxSearchNode(node_gui, node, "jukebox_menu_playlist", "jukebox_option_menu_playlist")
+	end
+})
+
+return ModOptionsSearchFilter