﻿[DzIsKeyDown]
title = "Determine whether the button is pressed"
description = "Determine whether ${button} is pressed"
comment = ""
category = BZ_GUI
returns = boolean
[[.args]]
type = gamekey
default = "GameKey_TriggerGameKey"

[DzFrameGetEnable]
title = "Whether the control is enabled"
description = "${frame} Whether to enable"
comment = ""
category = BZ_GUI
returns = boolean
[[.args]]
type = frame

[DzFrameGetValue]
title = "Get current value"
description = "Get ${frame} current value"
comment = "（Support Slider、SimpleStatusBar、StatusBar）"
category = BZ_GUI
returns = real
[[.args]]
type = frame

[DzIsMouseOverUI]
title = "The mouse is in the game or not"
description = "The mouse is in the game or not"
comment = ""
category = BZ_HW
returns = boolean

[DzIsWindowActive]
title = "Determine whether the game window is active status"
description = "Determine whether the window is active status"
comment = ""
category = BZ_HW
returns = boolean

[DzGetMouseTerrainX]
title = "Get the coordinate X of the mouse in the game"
description = "Get the coordinate X of the mouse in the game"
comment = ""
category = BZ_HW
returns = real

[DzGetMouseTerrainY]
title = "Get the coordinate Y of the mouse in the game"
description = "Get the coordinate Y of the mouse in the game"
comment = ""
category = BZ_HW
returns = real

[DzGetMouseTerrainZ]
title = "Get the coordinate Z of the mouse in the game"
description = "Get the coordinate Z of the mouse in the game"
comment = ""
category = BZ_HW
returns = real

[DzGetMouseX]
title = "Get the coordinate X of the mouse on the screen"
description = "Get the coordinate X of the mouse on the screen"
comment = ""
category = BZ_HW
returns = integer

[DzGetMouseY]
title = "Get the coordinate Y of the mouse on the screen"
description = "Get the coordinate Y of the mouse on the screen"
comment = ""
category = BZ_HW
returns = integer

[DzGetMouseXRelative]
title = "Get mouse game window coordinate X"
description = "Get mouse game window coordinate X"
comment = ""
category = BZ_HW
returns = integer

[DzGetMouseYRelative]
title = "Get mouse game window coordinate Y"
description = "Get mouse game window coordinate Y"
comment = ""
category = BZ_HW
returns = integer

[DzGetWindowWidth]
title = "Get the width of war3 window"
description = "Get the width of war3 window"
comment = ""
category = BZ_HW
returns = integer

[DzGetWindowHeight]
title = "Get the height of war3 window"
description = "Get the height of war3 window"
comment = ""
category = BZ_HW
returns = integer

[DzGetWindowX]
title = "Get the X coordinate of the War3 window"
description = "Get the X coordinate of the War3 window"
comment = ""
category = BZ_HW
returns = integer

[DzGetWindowY]
title = "Get the Y coordinate of the War3 window"
description = "Get the Y coordinate of the War3 window"
comment = ""
category = BZ_HW
returns = integer

[DzGetTriggerSyncData]
title = "event response - Get synchronized data"
description = "Get synchronized data"
comment = "Response [Sync]-Synchronize message event"
category = BZ_SYNC
returns = string

[DzGetTriggerSyncPlayer]
title = "event response - Players who get synchronized data"
description = "Players who get synchronized data"
comment = "Response [Sync]-Synchronize message event"
category = BZ_SYNC
returns = player

[DzGetTriggerKey]
title = "event response - Get the triggered key"
description = "Get the triggered key"
comment = "Response [hardware]-key event"
category = BZ_HW
returns = gamekey

[DzGetWheelDelta]
title = "event response - Get the wheel change value"
description = "Get the wheel change value"
comment = "Response [Hardware]-Mouse wheel event, positive and negative distinguish up and down"
category = BZ_HW
returns = integer

[DzGetTriggerKeyPlayer]
title = "event response - Get the player who triggered the hardware event"
description = "Get the player who triggered the hardware event"
comment = "Response [Hardware]-Key event, scroll wheel event, window size change event"
category = BZ_HW
returns = player

[DzGetUnitUnderMouse]
title = "Get the unit pointed by the mouse"
description = "The unit pointed by the mouse"
comment = ""
category = BZ_HW
returns = unit

[DzGetLocale]
title = "Get client language [NEW]"
description = "Get client language"
comment = "Different client returns for different languages"
category = BZ_HW
returns = string

[DzGetUnitNeededXP]
title = "Get the experience needed to upgrade [NEW]"
description = "Get unit${unit} ${level} level experience required to upgrade"
comment = ""
category = TC_UNIT
returns = integer
[[.args]]
type = string
[[.args]]
type = integer

[DzCreateFrame]
title = "New Frame"
description = "New Frame name:${frame} Parent node:${parent} ID:${Id}"
comment = "The name is the name in the fdf file, and the ID is filled with 0 by default. Repeated creation of a frame with the same name will cause a crash message to be displayed when the game exits. If you need to avoid it, you can use Tag to create it"
category = BZ_GUI
returns = frame
[[.args]]
type = string
default = "name"
[[.args]]
type = frame
default = DzGetGameUI
[[.args]]
type = integer
default = 0

[DzCreateFrameByTagName]
title = "New Frame [Tag]"
description = "New type:${type} name:${frame} Parent node:${parent} stencil:${template} ID:${Id}"
comment = "The name right here can be customized, type and template fill in the content in the fdf file. The Frame created by this function cannot get the sub-Frame."
category = BZ_GUI
returns = frame
[[.args]]
type = string
default = FRAME
[[.args]]
type = string
default = "name"
[[.args]]
type = frame
default = DzGetGameUI
[[.args]]
type = string
default = "template"
[[.args]]
type = integer
default = 0

[DzFrameFindByName]
title = "Get sub Frame"
description = "Get name is ${name} sub Frame  ID:${Id}"
comment = "The ID is filled with 0 by default, and the last created one is given priority when the same name is used. Frame types that are not Simple classes use this function to obtain sub-Frames."
category = BZ_GUI
returns = frame
[[.args]]
type = string
[[.args]]
type = integer
default = 0

[DzSimpleFrameFindByName]
title = "Get sub SimpleFrame"
description = "Get name is ${name} sub SimpleFrame  ID:${Id}"
comment = "The ID is filled with 0 by default, and the last created one is given priority when the same name is used. SimpleFrame is the Frame type in fdf."
category = BZ_GUI
returns = frame
[[.args]]
type = string
[[.args]]
type = integer
default = 0

[DzSimpleFontStringFindByName]
title = "Get sub SimpleFontString"
description = "Get name is ${name} sub SimpleFontString  ID:${Id}"
comment = "The ID is filled with 0 by default, and the last created one is given priority when the same name is used. SimpleFontString is the Frame type in fdf."
category = BZ_GUI
returns = frame
[[.args]]
type = string
[[.args]]
type = integer
default = 0

[DzSimpleTextureFindByName]
title = Get sub SimpleTexture"
description = "Get name is ${name} sub SimpleTexture  ID:${Id}"
comment = "The ID is filled with 0 by default, and the last created one is given priority when the same name is used. SimpleTexture is the Frame type in fdf."
category = BZ_GUI
returns = frame
[[.args]]
type = string
[[.args]]
type = integer

[DzGetTriggerUIEventFrame]
title = "Event response - Frame triggered"
description = "Frame triggered"
comment = ""
category = BZ_GUI
returns = frame

[DzGetTriggerUIEventPlayer]
title = "Event response - Get the player who triggered the ui"
description = "Get the player who triggered the ui"
comment = ""
category = BZ_GUI
returns = player

[DzGetMouseFocus]
title = "Frame control pointer where the mouse is located"
description = "Frame control pointer where the mouse is located"
comment = "Not all types of Frame can respond to the mouse, but can respond to BUTTON, TEXT, etc."
category = BZ_GUI
returns = frame

[DzFrameGetPortrait]
title = "Native - Unit big avatar"
description = "Unit big avatar"
comment = "The big avatar on the right side of the minimap"
category = BZ_GUI
returns = frame

[DzFrameGetMinimap]
title = "Native - minimap"
description = "minimap"
comment = ""
category = BZ_GUI
returns = frame

[DzFrameGetCommandBarButton]
title = "Native - Skill button"
description = "Skill button:(${row}, ${calumn})"
comment = "Skill button in reference(x,y)coordinate"
category = BZ_GUI
returns = frame
[[.args]]
type = integer
default = 0
[[.args]]
type = integer
default = 0

[DzFrameGetHeroBarButton]
title = "Native - Hero button"
description = "Hero button:${buttnoid}"
comment = "The hero portrait on the left, the parameter represents the N+1th hero, and the index starts from 0"
category = BZ_GUI
returns = frame
[[.args]]
type = integer
default = 0

[DzFrameGetHeroHPBar]
title = "Native - Hero Health Bar"
description = "Hero Health Bar:${buttnoid}"
comment = "The health bar under the hero portrait on the left, the parameter indicates the N+1th hero, and the index starts from 0"
category = BZ_GUI
returns = frame
[[.args]]
type = integer
default = 0

[DzFrameGetHeroManaBar]
title = "Native - Hero Blue Bar"
description = "Hero Blue Bar:${buttnoid}"
comment = "The blue bar under the hero portrait on the left, the parameter indicates the N+1th hero, and the index starts from 0"
category = BZ_GUI
returns = frame
[[.args]]
type = integer
default = 0

[DzFrameGetItemBarButton]
title = "Native - Inventory button"
description = "Inventory button:${buttnoid}"
comment = "Index starts from 0"
category = BZ_GUI
returns = frame
[[.args]]
type = integer
default = 0

[DzFrameGetMinimapButton]
title = "Native - minimap button"
description = "minimap button:${buttnoid}"
comment = "Vertical buttons on the right side of the minimap, the index starts from 0"
category = BZ_GUI
returns = frame
[[.args]]
type = integer
default = 0

[DzFrameGetUpperButtonBarButton]
title = "Native - Interface buttons"
description = "Interface buttons:${buttnoid}"
comment = "Menu buttons on the upper left, index starts from 0"
category = BZ_GUI
returns = frame
[[.args]]
type = integer
default = 0

[DzFrameGetTooltip]
title = "Native - Mouse tip"
description = "Mouse tip"
comment = "Move the mouse to the prompt window displayed on the item or skill button, initially located above the skill bar"
category = BZ_GUI
returns = frame

[DzFrameGetChatMessage]
title = "Native - Player chat message box"
description = "Player chat message box"
comment = ""
category = BZ_GUI
returns = frame

[DzFrameGetUnitMessage]
title = "Native - System message box"
description = "System message box"
comment = "Including displaying messages to players and displaying Debug messages, etc."
category = BZ_GUI
returns = frame

[DzFrameGetTopMessage]
title = "Native - Message box above"
description = "Message box above"
comment = "High maintenance costs and other news"
category = BZ_GUI
returns = frame

[DzGetGameUI]
title = "Native - game UI"
description = "game UI"
comment = "Generally used as a parent node to create a custom UI"
category = BZ_GUI
returns = frame

[DzFrameGetText]
title = "Get the text in the frame"
description = "Get ${buttnoid} text"
comment = "（Support EditBox, TextFrame, TextArea, SimpleFontString）"
category = BZ_GUI
returns = string
[[.args]]
type = frame

[DzFrameGetAlpha]
title = "Get the transparency of Frame(0-255)"
description = "Get ${Frame} transparency"
comment = ""
category = BZ_GUI
returns = integer
[[.args]]
type = frame

[DzFrameGetTextSizeLimit]
title = "Get the word limit of Frame"
description = "Get ${frame} the word limit"
comment = "（Support EditBox）"
category = BZ_GUI
returns = integer
[[.args]]
type = frame

[DzFrameGetHeight]
title = "Get the height of the frame [NEW]"
description = "Get ${frame} height"
comment = ""
category = BZ_GUI
returns = real
[[.args]]
type = frame

[DzFrameGetParent]
title = "Get the Parent of Frame [NEW]"
description = "Get ${frame} Parent"
comment = ""
category = BZ_GUI
returns = frame
[[.args]]
type = frame

[DzFrameGetName]
title = "Get the name of the frame[NEW]"
description = "Get ${frame} name"
comment = ""
category = BZ_GUI
returns = string
[[.args]]
type = frame

[DzGetColor]
title = "Take RGBA color value"
description = "Red:${Red} Green:${Green} Blue:${Blue} transparency:${Alpha}"
comment = "Returns an integer, used to set the frame color"
category = BZ_GUI
returns = integer
[[.args]]
type = integer
default = "255"
min = 0
max = 255
[[.args]]
type = integer
default = "255"
min = 0
max = 255
[[.args]]
type = integer
default = "255"
min = 0
max = 255
[[.args]]
type = integer
default = "255"
min = 0
max = 255

[DzF2I]
title = "Convert Frame to integer"
description = "Convert ${Frame} to integer"
comment = ""
category = BZ_GUI
returns = integer
[[.args]]
type = frame

[DzI2F]
title = "Convert Integer to Frame"
description = "Convert ${Integer} to Frame"
comment = ""
category = BZ_GUI
returns = frame
[[.args]]
type = integer

[DzK2I]
title = "Convert key to integer"
description = "Convert ${Key} to integer"
comment = ""
category = BZ_HW
returns = integer
[[.args]]
type = gamekey

[DzI2K]
title = "Convert integer to key"
description = "Convert ${Integer} to key"
comment = ""
category = BZ_HW
returns = gamekey
[[.args]]
type = integer
