Dgs-dxbutton: Difference between revisions
Line 58: | Line 58: | ||
===wordbreak=== | ===wordbreak=== | ||
===colorcoded=== | ===colorcoded=== | ||
Whether the color code is enabled or not. | Whether the color code is enabled or not. ''Learn More [[dxDrawText]]'' | ||
<syntaxhighlight lang="lua">dgsDxGUISetProperty(button,"colorcoded",colorcoded)</syntaxhighlight> | <syntaxhighlight lang="lua">dgsDxGUISetProperty(button,"colorcoded",colorcoded)</syntaxhighlight> | ||
*'''colorcoded''' : Set to true to enable embedded #FFFFFF color codes | *'''colorcoded''' : Set to true to enable embedded #FFFFFF color codes. | ||
===rightbottom=== | ===rightbottom=== |
Revision as of 13:28, 9 September 2017
DGS Properties is always used to change the gui style and make it more fantastic.
This page shows the properties of dgs-dxbutton that you could use.
Main Functions
Properties
image
Require [texture/shader] that can be used as the background of button.
dgsDxGUISetProperty(button,"image",{defimg,hovimg,cliimg})
- defimg: A texture/shader element of the background of the button ( neither selected npr clicked by mouse ). ( You can pass a nil value to disable this image option )
- selimg: A texture/shader element of the background of the button which is selected. ( You can pass a nil value to disable this image option )
- cliimg: A texture/shader element of the background of the button which is clicked. ( You can pass a nil value to disable this image option )
color
Require integer that can be used as the background color of button.
dgsDxGUISetProperty(button,"color",{defcolor,hovcolor,clicolor})
- defcolor: An integer of the color of the background of the button ( neither selected nor clicked by mouse ).
- selcolor: An integer of the color of the background of the button which is selected.
- clicolor: An integer of the color of the background of the button which is clicked.
text
This is equivalent to dgsDxGUISetText/dgsDxGUIGetText.
dgsDxGUISetProperty(button,"text",text)
- text : A string of the text of the button.
textcolor
The color of the text of the button which can be translated by tocolor.
dgsDxGUISetProperty(button,"textcolor",textcolor)
- textcolor : An integer of the color of the text of the button.
textsize
The scale of the text of the button. Learn More dxDrawText
dgsDxGUISetProperty(button,"textsize",{scaleX,scaleY})
- scaleX : A float of the 2D X scale of the text of the button.
- scaleY : A float of the 2D Y scale of the text of the button.
shadow
The shadow text of the button.
dgsDxGUISetProperty(button,"shadow",{offsetX,offsetY,color})
- offsetX : A float of the 2D X offset of the shadow text of the button.
- offsetY : A float of the 2D Y offset of the shadow text of the button.
- color : An integer of the color of the shadow text of the button.
font
This is equivalent to dgsDxGUISetFont/dgsDxGUIGetFont. Learn More dxDrawText
dgsDxGUISetProperty(button,"font",font)
- font : A dx font element of the text font of the button.
clickoffset
The offset indicates that how much the text of the button will shift when it is clicked.
dgsDxGUISetProperty(button,"clickoffset",{offsetX,offsetY})
- offsetX : A float of the 2D X offset relative to the position of the button.
- offsetY : A float of the 2D Y offset relative to the position of the button.
clickType
wordbreak
colorcoded
Whether the color code is enabled or not. Learn More dxDrawText
dgsDxGUISetProperty(button,"colorcoded",colorcoded)
- colorcoded : Set to true to enable embedded #FFFFFF color codes.
rightbottom
Alignment of the text within the button
dgsDxGUISetProperty(button,"rightbottom",{alignX,alignY})
- alignX : Horizontal alignment of the text within the button. Can be "left", "center" or "right".
- alignY : Vertical alignment of the text within the button. Can be "top", "center" or "bottom".