Better Dialog

Author(s)
Antares
Tags
JASS, Lua, vJASS, System
Size
74.86 KB
Rating

(2 ratings)

Downloads
140
Created
Jan 4, 2024
Updated
Mar 14, 2025
Resources
2
State
Approved
This bundle is marked as recommended. It works and satisfies the submission rules.
View usage Statistics Legacy download
  • Like
  • Wow
  • Love
Reactions: Bain_Rebirth, Achille, _AssassinBraj_ and 10 others
A recreation of the Blizzard dialogs with custom frames, adding additional features such as tooltips and cycling buttons.

How often does it happen that, in a map you're playing, you are supposed to choose between different options from a dialog, often as the game host at the start of the game, but you have no idea what the different buttons are doing? The mapper doesn't tell you, and how could he? There's no room for any additional information anywhere.

This is where Better Dialogs comes in by giving the mapper the ability to add necessary information in the tooltips for the different buttons of a dialog.

Both Lua and vJASS versions available.

Keywords: Dialog

Lua: 
do
    --[[
    ===========================================================================================
                                        Better Dialogs
                                          by Antares
   
            		Create dialogs with button tooltips and cycle buttons.
           
                                        How to import:
									Requires TotalInitialization

    Copy this library into your map. Extract the .fdf files and the .toc file and import them
	into your map without a subfolder.
   
    The frame size values in the Config are designed to closely emulate the standard dialog.
	Edit them if you want to change the layout. You can also choose between standard tooltip 
	and EscMenu style tooltips.

	You can change the values in the .fdf files, such as the border size (BackdropCornerSize),
	the tooltip text size (FrameFont), textbox position (SetPoint) etc. Preset values might
	not be appropriate for every race UI.

	===========================================================================================

									How to create a dialog:
    
    Dialog creation functions expect a table that contains all data of the dialog buttons as an
	input argument. The table is a sequence containing:
	[1] ButtonTitle 1 (type string or table)
	[2] ButtonTooltip 1 (type string or table)
	[3] ButtonCallback 1 (type function)
	[4] ButtonTitle 2
	...

	If a string is passed as the argument for the buttonTitle, it is a regular dialog button. 
	Alternatively, you can pass a table as the argument to change the button into a cycle button. 
	When clicked, the button changes text to the next string in the sequence. The number of 
	strings stored in the sequence will determine the amount of states the button cycles through 
	before returning to the original state.
	
	If a button is defined as a cycle button, the tooltip can either be static (if a string is 
	passed) or cycling (if a string sequence is passed). If the tooltip is cycling, the table
	should have the same number of strings stored as the table of button titles. To omit the
	tooltip for a button, pass "".

	The button callback is the function that is executed upon clicking the button. It is expected
	to be function with three arguments:

    function myCallback(whichDialog, buttonName, whichPlayer)

	buttonName specifies the title of the button that was clicked. This allows you to use the
	same callback function for all buttons and execute the correct code based on which button
	was clicked. whichPlayer specifies the player that clicked the button. Alternatively, you can
	use a different callback function for each button.

	For cycling buttons, buttonName specifies the title that the button just cycled into.

	If the clicked button is supposed to close the associated dialog, include
	CloseDialog(whichDialog)
	in the callback function.

	If a dialog is created for multiple players, each player sees a completely different copy of
	that dialog.

	Examples are given in the test map.

    ===========================================================================================
    API
    ===========================================================================================
 
    CreateBetterDialogForPlayer(whichPlayer, dialogTitle, buttonData)
    CreateBetterDialogForForce(whichForce, dialogTitle, buttonData)
    CreateBetterDialogForAll(dialogTitle, buttonData)

	CloseDialog(whichDialog)
	CloseOpenDialogForPlayer(whichPlayer)
	GetOpenDialogOfPlayer(whichPlayer)
	SaveAndHideOpenDialogForPlayer(whichPlayer)
	ShowDialogToPlayer(whichDialog, whichPlayer)

    ===========================================================================================
    ]]

	--===========================================================================================
	--CONFIG
	--===========================================================================================

    local DIALOG_X                          = 0.4		--X-position of dialog center.
    local DIALOG_Y                          = 0.3		--Y-position of dialog center.
    local DIALOG_WIDTH                      = 0.285		--Should be integer multiple of BackdropCornerSize
    local DIALOG_BOTTOM_GAP                 = 0.045		--Gap between bottom of lowest button and bottom of dialog.
	local DIALOG_BORDER_TILE_SIZE			= 0.0475	--Fixes height of dialog to integer multiple of this value to ensure that texture is tiled smoothly. (same behavior as normal dialog)

    local DIALOG_TITLE_Y_OFFSET             = -0.07		--Gap between top of dialog and dialog title.

    local BUTTON_HEIGHT                     = 0.035
    local BUTTON_WIDTH                      = 0.225
    local BUTTON_SPACING                    = 0.003		--Gap between buttons.
    local BUTTON_Y_OFFSET                   = -0.07		--Gap between top of dialog and first button.
    
    local TOOLTIP_Y_OFFSET                  = -0.005	--Difference in y-position of top edge of dialog and tooltip.
    local TOOLTIP_WIDTH                     = 0.244		--Should be integer multiple of BackdropCornerSize
    local TOOLTIP_FRAME_HEIGHT_BUFFER       = 0.045		--Difference in height between tooltip border and tooltip text box.
	local TOOLTIP_STYLE						= "EscMenu" --"EscMenu" or "Tooltip"

	--===========================================================================================

    local BUTTON_X_OFFSET                   = (DIALOG_WIDTH - BUTTON_WIDTH)/2

	local CurrentlyOpenDialog = {}
	local ButtonTriggers = {}
	local ViewingPlayer = {}

	local function PlayButtonClickForPlayer(whichPlayer)
		local s = CreateSound("Sound\\Interface\\BigButtonClick.flac", false, false, false, 10, 10, "DefaultEAXON" )
		local volume
		if GetLocalPlayer() == whichPlayer then
			volume = 100
		else
			volume = 0
		end
		SetSoundVolumeBJ(s, volume)
		StartSound(s)
		KillSoundWhenDone(s)
	end

	local function SetupDialog(whichPlayer, dialogTitle, buttonTitles, buttonTooltips, buttonCallbacks)

        local numberOfButtons = #buttonTitles

		--===========================================================================================
		--Setup Dialog Background
		--===========================================================================================

		local dialogHeightEstimate = -BUTTON_Y_OFFSET + DIALOG_BOTTOM_GAP + numberOfButtons*BUTTON_HEIGHT + (numberOfButtons-1)*BUTTON_SPACING

		local dialogHeight = math.floor(dialogHeightEstimate/DIALOG_BORDER_TILE_SIZE + 0.5)*DIALOG_BORDER_TILE_SIZE
		local heightDifference = dialogHeight - dialogHeightEstimate

        local dialogParent = BlzCreateFrame("BetterDialog", BlzGetFrameByName("ConsoleUIBackdrop", 0), 0, 0) ---@type framehandle
		BlzFrameSetScale(dialogParent, 1)
		BlzFrameSetAbsPoint(dialogParent, FRAMEPOINT_TOPLEFT , DIALOG_X - DIALOG_WIDTH/2 , DIALOG_Y + dialogHeight/2 )
		BlzFrameSetAbsPoint(dialogParent, FRAMEPOINT_BOTTOMRIGHT , DIALOG_X + DIALOG_WIDTH/2 , DIALOG_Y - dialogHeight/2 )
		BlzFrameSetVisible( dialogParent, true )

		--===========================================================================================
		--Setup Dialog Title
		--===========================================================================================

		local dialogTitleFrame = BlzCreateFrameByType("TEXT", "dialogTitle", dialogParent, "", 0) ---@type framehandle
		BlzFrameSetText(dialogTitleFrame, dialogTitle)
		BlzFrameSetScale(dialogTitleFrame, 1.6)
		BlzFrameSetPoint(dialogTitleFrame, FRAMEPOINT_TOPLEFT, dialogParent, FRAMEPOINT_TOPLEFT, 0, 0)
		BlzFrameSetPoint(dialogTitleFrame, FRAMEPOINT_BOTTOMRIGHT, dialogParent, FRAMEPOINT_TOPRIGHT, 0, DIALOG_TITLE_Y_OFFSET - heightDifference/2)
        BlzFrameSetTextAlignment(dialogTitleFrame, TEXT_JUSTIFY_MIDDLE, TEXT_JUSTIFY_CENTER)

		--===========================================================================================

        local tooltipText ---@type framehandle

        local buttonFrames = {}
        local buttonTriggers = {}
        local buttonTooltipFrames = {}

        for i = 1, numberOfButtons do

			--===========================================================================================
			--Setup Dialog Button
			--===========================================================================================

			local isCycleButton ---@type boolean
			local cycleButtonState ---@type integer

            if type(buttonTitles[i]) == "table" then
				buttonFrames[i] = BlzCreateFrameByType("GLUETEXTBUTTON", buttonTitles[i][1] , dialogParent, "ScriptDialogButton", 0)
                isCycleButton = true
                BlzFrameSetText(buttonFrames[i], buttonTitles[i][1])
				cycleButtonState = 1
			elseif type(buttonTitles[i]) == "string" then
				buttonFrames[i] = BlzCreateFrameByType("GLUETEXTBUTTON", buttonTitles[i] , dialogParent, "ScriptDialogButton", 0)
                isCycleButton = false
                BlzFrameSetText(buttonFrames[i], buttonTitles[i])
            end
            BlzFrameSetPoint( buttonFrames[i], FRAMEPOINT_TOPLEFT, dialogParent, FRAMEPOINT_TOPLEFT, BUTTON_X_OFFSET , BUTTON_Y_OFFSET - (i-1)*(BUTTON_HEIGHT + BUTTON_SPACING) - heightDifference/2 )
            BlzFrameSetPoint( buttonFrames[i], FRAMEPOINT_BOTTOMRIGHT, dialogParent, FRAMEPOINT_TOPLEFT, BUTTON_X_OFFSET + BUTTON_WIDTH , BUTTON_Y_OFFSET - BUTTON_HEIGHT - (i-1)*(BUTTON_HEIGHT + BUTTON_SPACING) - heightDifference/2 )

			--===========================================================================================
			--Setup Button Tooltip
			--===========================================================================================

			if buttonTooltips[i] ~= "" then
				buttonTooltipFrames[i] = BlzCreateFrame("BetterDialogTooltip" .. TOOLTIP_STYLE, BlzGetOriginFrame(ORIGIN_FRAME_WORLD_FRAME, 0), 0, 0)
				BlzFrameSetAbsPoint( buttonTooltipFrames[i] , FRAMEPOINT_TOPLEFT , DIALOG_X + DIALOG_WIDTH/2 , DIALOG_Y + dialogHeight/2 + TOOLTIP_Y_OFFSET )
				BlzFrameSetTooltip( buttonFrames[i] , buttonTooltipFrames[i] )
				tooltipText = BlzFrameGetChild(buttonTooltipFrames[i], 0)
				
				if type(buttonTooltips[i]) == "table" then
					BlzFrameSetText( tooltipText, buttonTooltips[i][1] )
				else
					BlzFrameSetText( tooltipText, buttonTooltips[i] )
				end
				BlzFrameSetSize( tooltipText , TOOLTIP_WIDTH - 0.045 , 0.0 )
				BlzFrameSetSize(buttonTooltipFrames[i] , TOOLTIP_WIDTH , BlzFrameGetHeight(tooltipText) + TOOLTIP_FRAME_HEIGHT_BUFFER)
			end

			--===========================================================================================
			--Setup Callback Function
			--===========================================================================================

			buttonTriggers[i] = CreateTrigger()
			BlzTriggerRegisterFrameEvent(buttonTriggers[i], buttonFrames[i], FRAMEEVENT_CONTROL_CLICK)
			TriggerAddAction(buttonTriggers[i], function()
				PlayButtonClickForPlayer(whichPlayer)
				if isCycleButton then
					cycleButtonState = ModuloInteger(cycleButtonState, #buttonTitles[i]) + 1
					BlzFrameSetText(buttonFrames[i], buttonTitles[i][cycleButtonState])
					if type(buttonTooltips[i]) == "table" then
						tooltipText = BlzFrameGetChild(buttonTooltipFrames[i], 0)
						BlzFrameSetText( tooltipText, buttonTooltips[i][cycleButtonState] )
						BlzFrameSetSize( tooltipText , TOOLTIP_WIDTH - 0.045 , 0.0 )
						BlzFrameSetSize(buttonTooltipFrames[i] , TOOLTIP_WIDTH , BlzFrameGetHeight(tooltipText) + TOOLTIP_FRAME_HEIGHT_BUFFER)
					end
					buttonCallbacks[i](dialogParent, buttonTitles[i][cycleButtonState], GetTriggerPlayer())
				else
					buttonCallbacks[i](dialogParent, buttonTitles[i], GetTriggerPlayer())
				end
			end)
        end

		--===========================================================================================

		ButtonTriggers[dialogParent] = buttonTriggers
		CurrentlyOpenDialog[whichPlayer] = dialogParent
		ViewingPlayer[dialogParent] = whichPlayer

        BlzFrameSetVisible(dialogParent, GetLocalPlayer() == whichPlayer)
	end

	local function SetupButtons(buttonData)
        local buttonTitles = {}
        local buttonTooltips = {}
        local buttonCallbacks = {}
		local j = 1
        for i = 1, #buttonData - 2, 3 do
			if type(buttonData[i]) == "string" or type(buttonData[i]) == "table" then
            	buttonTitles[j] = buttonData[i]
			else
				print(type(buttonData[i]) .. " passed as argument for button title. Expected string or table...")
				return
			end
			if type(buttonData[i+1]) == "string" or type(buttonData[i+1]) == "table" then
            	buttonTooltips[j] = buttonData[i+1]
			else
				print(type(buttonData[i+1]) .. " passed as argument for button tooltip. Expected string or table...")
				return
			end
			if type(buttonData[i+2]) == "function" then
            	buttonCallbacks[j] = buttonData[i+2]
			else
				print(type(buttonData[i+2]) .. " passed as argument for button callback. Expected function...")
				return
			end
            j = j + 1
        end
		return buttonTitles, buttonTooltips, buttonCallbacks
	end

	--===========================================================================================
	--API
	--===========================================================================================

	---@param dialogTitle string
	---@param buttonData table
    function CreateBetterDialogForAll(dialogTitle, buttonData)
		local buttonTitles, buttonTooltips, buttonCallbacks = SetupButtons(buttonData)
		for i = 0, 23 do
			if GetPlayerSlotState(Player(i)) == PLAYER_SLOT_STATE_PLAYING and GetPlayerController(Player(i)) == MAP_CONTROL_USER then
				CloseDialog(CurrentlyOpenDialog[Player(i)])
				SetupDialog(Player(i), dialogTitle, buttonTitles, buttonTooltips, buttonCallbacks)
			end
		end
    end

	---@param whichForce table | force
	---@param dialogTitle string
	---@param buttonData table
    function CreateBetterDialogForForce(whichForce, dialogTitle, buttonData)
		local buttonTitles, buttonTooltips, buttonCallbacks = SetupButtons(buttonData)
		if type(whichForce) == "table" then
			for i = 1, #whichForce do
				SetupDialog(whichForce[i], dialogTitle, buttonTitles, buttonTooltips, buttonCallbacks)
			end
		else
			for i = 0, 23 do
				if IsPlayerInForce(Player(i), whichForce) then
					CloseDialog(CurrentlyOpenDialog[Player(i)])
					SetupDialog(Player(i), dialogTitle, buttonTitles, buttonTooltips, buttonCallbacks)
				end
			end
		end
    end

	---@param whichPlayer player
	---@param dialogTitle string
	---@param buttonData table
	---@return framehandle
    function CreateBetterDialogForPlayer(whichPlayer, dialogTitle, buttonData)
		local buttonTitles, buttonTooltips, buttonCallbacks = SetupButtons(buttonData)
		CloseDialog(CurrentlyOpenDialog[whichPlayer])
        SetupDialog(whichPlayer, dialogTitle, buttonTitles, buttonTooltips, buttonCallbacks)
		return CurrentlyOpenDialog[whichPlayer]
    end

	---@param whichDialog framehandle
	function CloseDialog(whichDialog)
		if whichDialog == nil then
			return
		end

		for j = 1, #ButtonTriggers[whichDialog] do
			DestroyTrigger(ButtonTriggers[whichDialog][j])
		end
		BlzDestroyFrame(whichDialog)
		CurrentlyOpenDialog[ViewingPlayer[whichDialog]] = nil
	end

	---@param whichPlayer player
	function CloseOpenDialogForPlayer(whichPlayer)
		CloseDialog(CurrentlyOpenDialog[whichPlayer])
	end

	---@param whichPlayer player
	---@return framehandle
	function GetOpenDialogOfPlayer(whichPlayer)
		return CurrentlyOpenDialog[whichPlayer]
	end

	---@param whichPlayer player
	---@return framehandle
	function SaveAndHideOpenDialogForPlayer(whichPlayer)
		local whichDialog = CurrentlyOpenDialog[whichPlayer]
		if GetLocalPlayer() == whichPlayer then
			BlzFrameSetVisible(whichDialog, false)
		end
		CurrentlyOpenDialog[whichPlayer] = nil
		return whichDialog
	end

	---@param whichDialog framehandle
	---@param whichPlayer player
	function ShowDialogToPlayer(whichDialog, whichPlayer)
		CloseOpenDialogForPlayer(whichPlayer)
		if GetLocalPlayer() == whichPlayer then
			BlzFrameSetVisible(whichDialog, true)
		end
		CurrentlyOpenDialog[whichPlayer] = whichDialog
	end

	OnInit.main(function()
		BlzLoadTOCFile("BetterDialogTemplates.toc")
	end)

	--===========================================================================================
end

JASS: 
library BetterDialogs initializer Init
    /*
    ===========================================================================================
                                        Better Dialogs
                                          by Antares
    
                    Create dialogs with button tooltips and cycle buttons.
            
                                        How to import:
 
    Copy this library into your map. Extract the .fdf files and the .toc file and import them
    into your map without a subfolder.
    
    The frame size values in the Config are designed to closely emulate the standard dialog.
    Edit them if you want to change the layout. You can also choose between standard tooltip 
    and escape menu style tooltips.
 
    You can change the values in the .fdf files, such as the border size (BackdropCornerSize),
    the tooltip text size (FrameFont), textbox position (SetPoint) etc. Preset values might
    not be appropriate for every race UI.
 
    ===========================================================================================
 
                                    How to create a dialog:

    Before creating a dialog, you have to create the data for the dialog buttons. Start with:

    local ButtonData myButtonData = InitButtonData()

    ButtonData is a container for the buttons you create for a dialog. Now create buttons and
    add them to the ButtonData container.

    local Button myButton = CreateButton(title, tooltip, callback)
    call AddButtonToData(myButtonData, myButton)

    or

    call CreateButtonForData(title, tooltip, callback, myButtonData)

    If the button shouldn't have a tooltip, pass null as the tooltip. If the button shouldn't
    have a callback, pass 0 as the callback.

    To create a cycle button, use:
    AddButtonCycleState(myButton, title, tooltip)
 
    The button callback is the function that is executed upon clicking the button. It is expected
    to be function with three arguments:
 
    function myCallback takes framehandle whichDialog, player whichPlayer, string buttonName returns nothing
 
    buttonName specifies the title of the button that was clicked. This allows you to use the
    same callback function for all buttons and execute the correct code based on which button
    was clicked. Alternatively, you can use a different callback function for each button.
    whichPlayer specifies the player that clicked the button.
 
    For cycling buttons, buttonName specifies the title that the button just cycled into.
 
    If the clicked button is supposed to close the associated dialog, include
    call CloseDialog(whichDialog)
    in the callback function.
 
    If a dialog is created for multiple players, each player sees a completely different copy of
    that dialog.

    The created ButtonData and Button structs will automatically be cleaned up when the dialog
    that is using them is closed for all players for which it was shown. You can disable this
    in the config.
 
    Examples are given in the test map.
 
    ===========================================================================================
    API
    ===========================================================================================
  
    CreateBetterDialogForPlayer takes player whichPlayer, string dialogTitle, ButtonData buttonData returns nothing
    CreateBetterDialogForForce takes force whichForce, string dialogTitle, ButtonData buttonData returns nothing
    CreateBetterDialogForAll takes string dialogTitle, ButtonData buttonData returns nothing
 
    CloseDialog takes framehandle whichDialog returns nothing
    CloseOpenDialogForPlayer takes player whichPlayer returns nothing
    GetOpenDialogOfPlayer takes player whichPlayer returns framehandle
    SaveAndHideOpenDialogForPlayer takes player whichPlayer returns framehandle
    ShowDialogToPlayer takes framehandle whichDialog, player whichPlayer

    InitButtonData takes nothing returns ButtonData
    CreateButton takes string title, string tooltip, buttonCallback callback returns Button
    AddButtonToData takes ButtonData whichButtonData, Button whichButton returns nothing
    CreateButtonForData takes string title, string tooltip, buttonCallback callback, ButtonData whichButtonData returns Button
    AddButtonCycleState takes Button whichButton, string title, string tooltip returns nothing
    RemoveButtonData takes ButtonData whichButtonData returns nothing
 
    ===========================================================================================*/
 
	globals
		//===========================================================================================
		//CONFIG
		//===========================================================================================	

		private constant real DIALOG_X                          = 0.4       //X-position of dialog center.
		private constant real DIALOG_Y                          = 0.3       //Y-position of dialog center.
		private constant real DIALOG_WIDTH                      = 0.285     //Should be integer multiple of BackdropCornerSize
		private constant real DIALOG_BOTTOM_GAP                 = 0.045     //Gap between bottom of lowest button and bottom of dialog.
		private constant real DIALOG_BORDER_TILE_SIZE           = 0.0475    //Fixes height of dialog to integer multiple of this value to ensure that texture is tiled smoothly. (same behavior as normal dialog)
	 
		private constant real DIALOG_TITLE_Y_OFFSET             = -0.07     //Gap between top of dialog and dialog title.
	 
		private constant real BUTTON_HEIGHT                     = 0.035
		private constant real BUTTON_WIDTH                      = 0.225
		private constant real BUTTON_SPACING                    = 0.003     //Gap between buttons.
		private constant real BUTTON_Y_OFFSET                   = -0.07     //Gap between top of dialog and first button.
	 
		private constant real TOOLTIP_Y_OFFSET                  = -0.005    //Difference in y-position of top edge of dialog and tooltip.
		private constant real TOOLTIP_WIDTH                     = 0.244     //Should be integer multiple of BackdropCornerSize
		private constant real TOOLTIP_FRAME_HEIGHT_BUFFER       = 0.045     //Difference in height between tooltip border and tooltip text box.
		private constant string TOOLTIP_STYLE                   = "EscMenu" //"EscMenu" or "Tooltip"
	 
		private constant boolean AUTO_CLEANUP_BUTTON_DATA       = true
	 
		//===========================================================================================
	 
		private constant real BUTTON_X_OFFSET                   = (DIALOG_WIDTH - BUTTON_WIDTH)/2
	 
		private framehandle array CurrentlyOpenDialog
		private hashtable hash                                  = InitHashtable()
		private boolean cleanUp                                 = false

		private integer BUTTON_KEY                              = 0
		private integer TOOLTIP_KEY                             = 1
		private integer STATE_KEY                               = 2
		private integer TRIGGER_KEY                             = 3
		private integer BUTTON_DATA_KEY                         = 0
		private integer PLAYER_KEY                              = -1
	endglobals
	
	private function Init takes nothing returns nothing
		call BlzLoadTOCFile("BetterDialogTemplates.toc")
	endfunction

    function interface buttonCallback takes framehandle dialogParent, player whichPlayer, string buttonName returns nothing
 
    private function PlayButtonClickForPlayer takes player whichPlayer returns nothing
        local sound s = CreateSound("Sound\\Interface\\BigButtonClick.flac", false, false, false, 10, 10, "DefaultEAXON" )
        local real volume
        if GetLocalPlayer() == whichPlayer then
            set volume = 100
        else
            set volume = 0
        endif
        call SetSoundVolumeBJ(s, volume)
        call StartSound(s)
        call KillSoundWhenDone(s)
        set s = null
    endfunction

    struct Button
        string array title[12]
        integer numCycleStates
        string array tooltip[12]
        buttonCallback callback

        static method create takes string title, string tooltip, buttonCallback callback returns Button
            local Button this = Button.allocate()
            set .numCycleStates = 1
            set .title[1] = title
            set .tooltip[1] = tooltip
            set .callback = callback
            return this
        endmethod

        method AddCycleState takes string title, string tooltip returns Button
            set .numCycleStates = .numCycleStates + 1
            set .title[.numCycleStates] = title
            set .tooltip[.numCycleStates] = tooltip
            return this
        endmethod
    endstruct

    struct ButtonData
        Button array buttons[12]
        integer numButtons
        integer numReferences

        static method create takes nothing returns ButtonData
            local ButtonData this = ButtonData.allocate()
            set .numButtons = 0
            set .numReferences = 0
            return this
        endmethod

        method AddButton takes Button whichButton returns ButtonData
            set .numButtons = .numButtons + 1
            set .buttons[.numButtons] = whichButton
            return this
        endmethod

        method ReduceReference takes nothing returns nothing
            set .numReferences = .numReferences - 1
            static if AUTO_CLEANUP_BUTTON_DATA then
                if .numReferences <= 0 then
                    call .destroy()
                endif
            endif
        endmethod

        method onDestroy takes nothing returns nothing
            local integer i = 1
            loop
                exitwhen i > .numButtons
                call .buttons[i].destroy()
                set i = i + 1
            endloop
        endmethod
    endstruct

    private function ButtonClick takes nothing returns nothing
        local player whichPlayer = GetTriggerPlayer()
        local trigger whichTrigger = GetTriggeringTrigger()
        local framehandle whichFrame = BlzGetTriggerFrame()
        local framehandle dialogParent = BlzFrameGetParent(whichFrame)
        local Button whichButton = LoadInteger(hash, GetHandleId(whichFrame), BUTTON_KEY)
        local integer whichState = LoadInteger(hash, GetHandleId(whichFrame), STATE_KEY)
        local framehandle tooltip
        local framehandle tooltipText
          
        call PlayButtonClickForPlayer(whichPlayer)

        if whichButton.numCycleStates > 1 then
            set whichState = ModuloInteger(whichState, whichButton.numCycleStates) + 1
            call BlzFrameSetText(whichFrame, whichButton.title[whichState])
            call SaveInteger(hash, GetHandleId(whichFrame), STATE_KEY, whichState)
            
            set tooltip = LoadFrameHandle(hash, GetHandleId(whichFrame), TOOLTIP_KEY)
            set tooltipText = BlzFrameGetChild(tooltip, 0)
            call BlzFrameSetText(tooltipText, whichButton.tooltip[whichState])
            call BlzFrameSetSize(tooltipText, TOOLTIP_WIDTH - 0.045, 0.0)
            call BlzFrameSetSize(tooltip, TOOLTIP_WIDTH, BlzFrameGetHeight(tooltipText) + TOOLTIP_FRAME_HEIGHT_BUFFER)
            call whichButton.callback.evaluate(dialogParent, GetTriggerPlayer(), whichButton.title[whichState])
        else
            call whichButton.callback.evaluate(dialogParent, GetTriggerPlayer(), whichButton.title[whichState])
        endif
		
		set whichPlayer = null
        set whichTrigger = null
        set whichFrame = null
        set dialogParent = null
        set tooltip = null
        set tooltipText = null
    endfunction
 
    private function SetupDialog takes player whichPlayer, string dialogTitle, ButtonData buttonData returns nothing

        local integer i
        local integer numberOfButtons = buttonData.numButtons

        local real dialogHeightEstimate = -BUTTON_Y_OFFSET + DIALOG_BOTTOM_GAP + numberOfButtons*BUTTON_HEIGHT + (numberOfButtons-1)*BUTTON_SPACING
        local real dialogHeight = R2I(dialogHeightEstimate/DIALOG_BORDER_TILE_SIZE + 0.5)*DIALOG_BORDER_TILE_SIZE
        local real heightDifference = dialogHeight - dialogHeightEstimate

        local framehandle dialogParent
        local framehandle dialogTitleFrame
        local framehandle tooltipText
        local framehandle buttonFrame
        local trigger buttonTrigger
        local framehandle tooltip

        local Button whichButton

        local integer parentId
        local integer id

        //===========================================================================================
        //Setup Dialog Background
        //===========================================================================================
 
        set dialogParent = BlzCreateFrame("BetterDialog", BlzGetFrameByName("ConsoleUIBackdrop", 0), 0, 0) //-@type framehandle
		call BlzFrameSetScale(dialogParent, 1)
        call BlzFrameSetAbsPoint(dialogParent, FRAMEPOINT_TOPLEFT , DIALOG_X - DIALOG_WIDTH/2 , DIALOG_Y + dialogHeight/2 )
        call BlzFrameSetAbsPoint(dialogParent, FRAMEPOINT_BOTTOMRIGHT , DIALOG_X + DIALOG_WIDTH/2 , DIALOG_Y - dialogHeight/2 )
        call BlzFrameSetVisible( dialogParent, true )
        set parentId = GetHandleId(dialogParent)

        //===========================================================================================
        //Setup Dialog Title
        //===========================================================================================
         
        set dialogTitleFrame = BlzCreateFrameByType("TEXT", "dialogTitle", dialogParent, "", 0) //-@type framehandle
        call BlzFrameSetText(dialogTitleFrame, dialogTitle)
        call BlzFrameSetScale(dialogTitleFrame, 1.6)
        call BlzFrameSetPoint(dialogTitleFrame, FRAMEPOINT_TOPLEFT, dialogParent, FRAMEPOINT_TOPLEFT, 0, 0)
        call BlzFrameSetPoint(dialogTitleFrame, FRAMEPOINT_BOTTOMRIGHT, dialogParent, FRAMEPOINT_TOPRIGHT, 0, DIALOG_TITLE_Y_OFFSET - heightDifference/2)
        call BlzFrameSetTextAlignment(dialogTitleFrame, TEXT_JUSTIFY_MIDDLE, TEXT_JUSTIFY_CENTER)
 
        //===========================================================================================
 
        set i = 1
        loop
            exitwhen i > numberOfButtons

            set whichButton = buttonData.buttons[i]
 
            //===========================================================================================
            //Setup Dialog Button
            //===========================================================================================
 
            set buttonFrame = BlzCreateFrameByType("GLUETEXTBUTTON", whichButton.tooltip[1] , dialogParent, "ScriptDialogButton", 0)
            call BlzFrameSetText(buttonFrame, whichButton.title[1])
            call BlzFrameSetPoint( buttonFrame, FRAMEPOINT_TOPLEFT, dialogParent, FRAMEPOINT_TOPLEFT, BUTTON_X_OFFSET , BUTTON_Y_OFFSET - (i-1)*(BUTTON_HEIGHT + BUTTON_SPACING) - heightDifference/2 )
            call BlzFrameSetPoint( buttonFrame, FRAMEPOINT_BOTTOMRIGHT, dialogParent, FRAMEPOINT_TOPLEFT, BUTTON_X_OFFSET + BUTTON_WIDTH , BUTTON_Y_OFFSET - BUTTON_HEIGHT - (i-1)*(BUTTON_HEIGHT + BUTTON_SPACING) - heightDifference/2 )

            call SaveFrameHandle(hash, parentId, i, buttonFrame)

            //===========================================================================================
            //Setup Button Tooltip
            //===========================================================================================
 
            if whichButton.tooltip[1] != null then
                set tooltip = BlzCreateFrame("BetterDialogTooltip" + TOOLTIP_STYLE, BlzGetOriginFrame(ORIGIN_FRAME_WORLD_FRAME, 0), 0, 0)
                call BlzFrameSetAbsPoint( tooltip , FRAMEPOINT_TOPLEFT , DIALOG_X + DIALOG_WIDTH/2 , DIALOG_Y + dialogHeight/2 + TOOLTIP_Y_OFFSET )
                call BlzFrameSetTooltip(buttonFrame, tooltip )
                set tooltipText = BlzFrameGetChild(tooltip, 0)
                call BlzFrameSetText( tooltipText, whichButton.tooltip[1] )
                call BlzFrameSetSize( tooltipText , TOOLTIP_WIDTH - 0.045 , 0.0 )
                call BlzFrameSetSize(tooltip , TOOLTIP_WIDTH , BlzFrameGetHeight(tooltipText) + TOOLTIP_FRAME_HEIGHT_BUFFER)
            endif
 
            //===========================================================================================
            //Setup Callback Function
            //===========================================================================================
 
            set buttonTrigger = CreateTrigger()
            call BlzTriggerRegisterFrameEvent(buttonTrigger, buttonFrame, FRAMEEVENT_CONTROL_CLICK)
            call TriggerAddAction(buttonTrigger, function ButtonClick)

            set id = GetHandleId(buttonFrame)
            call SaveInteger(hash, id, BUTTON_KEY, whichButton)
            call SaveInteger(hash, id, STATE_KEY, 1)
            call SaveFrameHandle(hash, id, TOOLTIP_KEY, tooltip)
            call SaveTriggerHandle(hash, id, TRIGGER_KEY, buttonTrigger)

            set i = i + 1
        endloop
 
        //===========================================================================================
 
        set CurrentlyOpenDialog[GetPlayerId(whichPlayer)] = dialogParent
        call SavePlayerHandle(hash, GetHandleId(dialogParent), PLAYER_KEY, whichPlayer)
        call SaveInteger(hash, GetHandleId(dialogParent), BUTTON_DATA_KEY, buttonData)
        set buttonData.numReferences = buttonData.numReferences + 1

        call BlzFrameSetVisible(dialogParent, GetLocalPlayer() == whichPlayer)
		
		set dialogParent = null
        set dialogTitleFrame = null
        set tooltipText = null
        set buttonFrame = null
        set buttonTrigger = null
        set tooltip = null
    endfunction
 
    //===========================================================================================
    //API
    //===========================================================================================

    function InitButtonData takes nothing returns ButtonData
        return ButtonData.create()
    endfunction

    function AddButtonToData takes ButtonData whichButtonData, Button whichButton returns nothing
        call whichButtonData.AddButton(whichButton)
    endfunction
    
    function CreateButton takes string title, string tooltip, buttonCallback callback returns Button
        return Button.create(title, tooltip, callback)
    endfunction

    function AddButtonCycleState takes Button whichButton, string title, string tooltip returns nothing
        call whichButton.AddCycleState(title, tooltip)
    endfunction

    function CreateButtonForData takes string title, string tooltip, buttonCallback callback, ButtonData buttonData returns Button
        local Button newButton = Button.create(title, tooltip, callback)
        call buttonData.AddButton(newButton)
		return newButton
    endfunction

    function RemoveButtonData takes ButtonData buttonData returns nothing
        call buttonData.destroy()
    endfunction

    function CloseDialog takes framehandle whichDialog returns nothing
        local integer i = 1
        local framehandle buttonFrame
        local integer parentId
        local integer id
        local ButtonData buttonData

        if whichDialog == null then
            return
        endif

        set parentId = GetHandleId(whichDialog)

        loop
            set buttonFrame = LoadFrameHandle(hash, parentId, i)
            exitwhen buttonFrame == null
            set id = GetHandleId(buttonFrame)
            call DestroyTrigger(LoadTriggerHandle(hash, id, TRIGGER_KEY))
            call BlzDestroyFrame(LoadFrameHandle(hash, id, TOOLTIP_KEY))
            call FlushChildHashtable(hash, id)
            call BlzDestroyFrame(buttonFrame)
            set i = i + 1
        endloop

        set buttonData = LoadInteger(hash, parentId, BUTTON_DATA_KEY)
        call buttonData.ReduceReference()
        set CurrentlyOpenDialog[GetPlayerId(LoadPlayerHandle(hash, parentId, PLAYER_KEY))] = null
        call FlushChildHashtable(hash, parentId)
        call BlzDestroyFrame(whichDialog)
        set buttonFrame = null
    endfunction

    function CloseOpenDialogForPlayer takes player whichPlayer returns nothing
        call CloseDialog(CurrentlyOpenDialog[GetPlayerId(whichPlayer)])
    endfunction
 
    function CreateBetterDialogForAll takes string dialogTitle, ButtonData buttonData returns nothing
        local integer i = 0
        loop
            exitwhen i > 23
            if GetPlayerSlotState(Player(i)) == PLAYER_SLOT_STATE_PLAYING and GetPlayerController(Player(i)) == MAP_CONTROL_USER then
                call CloseDialog(CurrentlyOpenDialog[i])
                call SetupDialog(Player(i), dialogTitle, buttonData)
            endif
			set i = i + 1
        endloop
    endfunction
 
    function CreateBetterDialogForForce takes force whichForce, string dialogTitle, ButtonData buttonData returns nothing
        local integer i = 0
        loop
            exitwhen i > 23
            if IsPlayerInForce(Player(i), whichForce) then
                call CloseDialog(CurrentlyOpenDialog[i])
                call SetupDialog(Player(i), dialogTitle, buttonData)
            endif
			set i = i + 1
        endloop
    endfunction
 
    function CreateBetterDialogForPlayer takes player whichPlayer, string dialogTitle, ButtonData buttonData returns framehandle
        call CloseDialog(CurrentlyOpenDialog[GetPlayerId(whichPlayer)])
        call SetupDialog(whichPlayer, dialogTitle, buttonData)
        return CurrentlyOpenDialog[GetPlayerId(whichPlayer)]
    endfunction

    function GetOpenDialogOfPlayer takes player whichPlayer returns framehandle
        return CurrentlyOpenDialog[GetPlayerId(whichPlayer)]
    endfunction
 
    function SaveAndHideOpenDialogForPlayer takes player whichPlayer returns framehandle
        local framehandle whichDialog = CurrentlyOpenDialog[GetPlayerId(whichPlayer)]
        if GetLocalPlayer() == whichPlayer then
            call BlzFrameSetVisible(whichDialog, false)
        endif
        set CurrentlyOpenDialog[GetPlayerId(whichPlayer)] = null
        return whichDialog
    endfunction
 
    function ShowDialogToPlayer takes framehandle whichDialog, player whichPlayer returns nothing
        call CloseOpenDialogForPlayer(whichPlayer)
        if GetLocalPlayer() == whichPlayer then
            call BlzFrameSetVisible(whichDialog, true)
        endif
        set CurrentlyOpenDialog[GetPlayerId(whichPlayer)] = whichDialog
    endfunction
 
    //===========================================================================================
endlibrary
Contents

Better Dialogs Lua (Map)

Author
Unknown
Filename
BetterDialogsLua.w3m
Suggested players
Any
Players
1
Required game
Warcraft 3: Reforged
Recommended version
2.00
Dimensions
52x52 (64x64)
Size
43.27 KB
Uploaded
Jan 4, 2024
Updated
Mar 14, 2025
Map Info View Resources In Use Preview Triggers Download

Better Dialogs vJASS (Map)

Author
Unknown
Filename
BetterDialogsJASS.w3m
Suggested players
Any
Players
2
Required game
Warcraft 3: Reforged
Recommended version
2.00
Dimensions
52x52 (64x64)
Size
31.59 KB
Uploaded
Jan 28, 2024
Updated
Mar 14, 2025
Map Info View Resources In Use Preview Triggers Download
Reviews
Wrda
Wrda
I like your use of emmy annotation ;) CreateBetterDialogForForce whichForce can be either a table or a force, you can use "|" to mean "or": ---@param whichForce table | force ---@param dialogTitle string ---@param buttonData table function...
Read full review...

Wrda

Wrda

Wrda

Spell Reviewer
Level 28
Joined
Nov 18, 2012
Messages
2,010
I like your use of emmy annotation ;)

CreateBetterDialogForForce whichForce can be either a table or a force, you can use "|" to mean "or":
Lua: 
---@param whichForce table | force
---@param dialogTitle string
---@param buttonData table
function CreateBetterDialogForForce(whichForce, dialogTitle, buttonData)
Can also apply it to the ButtonsData case.

PlayButtonClickForPlayer could be local since it's not part of the API.

Otherwise, this is pretty good, very useful for host or players to get more detailed information about what a certain button does. Users can now blame the map maker for not doing this!

Approved
 

DarkePacific

DarkePacific

DarkePacific

Level 27
Joined
Jul 9, 2008
Messages
1,248
Works well after the most recent JASS changes

Also, here's and additional function that I found useful

JASS: 
    function CloseOpenDialogForAll takes nothing returns nothing
        local integer i = 0
        loop
            exitwhen i > 23
            if GetPlayerSlotState(Player(i)) == PLAYER_SLOT_STATE_PLAYING and GetPlayerController(Player(i)) == MAP_CONTROL_USER then
                call CloseDialog(CurrentlyOpenDialog[GetPlayerId(Player(i))])
            endif
            set i = i + 1
        endloop
    endfunction
 
Last edited:

Antares

Antares

Antares

Spell Reviewer
Level 32
Joined
Dec 13, 2009
Messages
982
Thanks, that's a good function to add! You can simplify the condition though: :psmile:

JASS: 
    function CloseOpenDialogForAll takes nothing returns nothing
        local integer i = 0
        loop
            exitwhen i > 23
            if CurrentlyOpenDialog[i] != null then
                call CloseDialog(CurrentlyOpenDialog[i])
            endif
            set i = i + 1
        endloop
    endfunction

DarkePacific said:
Works well after the most recent JASS changes
Click to expand...
What did I change again? :plol:
 

Yevhen Snizhko

Yevhen Snizhko

Yevhen Snizhko

Level 8
Joined
May 13, 2023
Messages
64
1. Easy to use and modify. Recommended if you have 3+ options per button.

2. Can be used to save settings for maps and custom campaigns, although it seems to require script coding exclusively (not much of a problem for me).

3. In the library description probably should add a note that Config is in the library itself - I spent a few minutes checking the imported files.

4. I'm not sure if it is possible to register pressing these dialog buttons via GUI.

5. In placement (X,Y) should mention that (0,0) is at the bottom left corner. I expected it to be in top left.

6. Not sure for Lua, but for Jass should mention that this requires enabling the JassHelper - I did not have it enabled before this, and spent some time figuring out why these triggers were constantly disabling in my map.

7. Question: Can I rename the triggers ('better dialogs', 'test'), and if yes, what do I have to change in the code to keep it from breaking?
 

Antares

Antares

Antares

Spell Reviewer
Level 32
Joined
Dec 13, 2009
Messages
982
Thank you for your feedback!

3. It's probably not ideal that there the documentation is above the config; that's not how I would do it today, but there's only one script file that you need to import, so I don't really see this as a big issue.
4. There's no GUI version right now.
5. Yes, I can add that.
6. Sure.
7. The name of script files in your map is of no relevance.
 

Antares

Antares

Antares

Spell Reviewer
Level 32
Joined
Dec 13, 2009
Messages
982
Aldeia said:
Can you add GUI implementation please?
Click to expand...
Sorry, I have too many resources to attend to and I always feel like my GUI translations are terrible. Maybe someone who is currently working with this system can do a translation? I would add it here and give credit, of course. @Yevhen Snizhko @Regno @DarkePacific
 

Yevhen Snizhko

Yevhen Snizhko

Yevhen Snizhko

Level 8
Joined
May 13, 2023
Messages
64
Found an interesting problem when HUD is scaled down.

What happens if I reduce HUD scale in Reforged 2.0.1 during gameplay:
1741784885318.png



Image 2:What happens if HUD is set to 0% in Reforged 2.0.1 when level starts:
1741784771312.png


All buttons work properly, but they have issues with scaling.

I'll just put a note for my campaign that users shouldn't open settings with downscaled HUD.
 
You must log in or register to reply here.

Similar threads

KhaosMachine
JumpSystem v1.1[GUI][Better]
Replies
17
Views
8K
Magtheridon96
Magtheridon96
loktar
Dialog Pages
Replies
9
Views
5K
loktar
loktar
Zoson
Dialog System v2.1.0
Replies
16
Views
9K
MyPad
MyPad
HellvsHeaven
Dialog Bank Storage
Replies
6
Views
11K
userid907
userid907
millzy
millzys Advanced Dialogs 2.0
Replies
13
Views
14K
millzy
millzy
Top