Difference between revisions of "Dgs-dxbutton"

From Multi Theft Auto: Wiki
 
(6 intermediate revisions by the same user not shown)
Line 8: Line 8:
  
 
==Properties==
 
==Properties==
===image===
+
===alignment===
Require [texture/shader] that can be used as the background of button.
+
Alignment of the text within the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"image",{defimg,hovimg,cliimg})</syntaxhighlight>
+
<syntaxhighlight lang="lua">dgsSetProperty(button,"alignment",{alignX,alignY})</syntaxhighlight>
*'''defimg:''' A texture/shader element of the background of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this image option )
+
*'''alignX:''' Horizontal alignment of the text within the button. Can be "left", "center" or "right".
*'''hovimg:''' A texture/shader element of the background of the button which is selected. ( You can pass a nil value to disable this image option )
+
*'''alignY:''' Vertical alignment of the text within the button. Can be "top", "center" or "bottom".
*'''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 )
+
 
 +
===clickoffset===
 +
The offset indicates that how much the text of the button will shift when it is clicked.
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"clickoffset",{offsetX,offsetY})</syntaxhighlight>
 +
*'''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===
 +
This indicates that which button of the mouse can have effect on the button.
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"clickType",clickType)</syntaxhighlight>
 +
*'''clickType''' : If set to 1, only "Left Mouse Button" can do. If set to 2, only "Right Mouse Button" can do. Otherwise it will be both.
  
 
===color===
 
===color===
 
The color which can be translated by [[tocolor]] of the background of the button.
 
The color which can be translated by [[tocolor]] of the background of the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"color",{defcolor,hovcolor,clicolor})</syntaxhighlight>
+
<syntaxhighlight lang="lua">dgsSetProperty(button,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''defcolor:''' An integer of the color of the background of the button ( neither selected nor clicked by mouse ).
+
*'''normalColor:''' An integer of the color of the background of the button ( neither selected nor clicked by mouse ).
*'''hovcolor:''' An integer of the color of the background of the button which is selected.
+
*'''hoveringColor:''' 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.
+
*'''clickedColor:''' An integer of the color of the background of the button which is clicked.
 +
 
 +
===colorcoded===
 +
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"colorcoded",colorcoded)</syntaxhighlight>
 +
*'''colorcoded''' : Set to true to enable embedded #FFFFFF color codes.
 +
 
 +
===font===
 +
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"font",font)</syntaxhighlight>
 +
*'''font''' : A [[Element/DX_font|dx font element]] of the text font of the button.
 +
 
 +
===iconColor===
 +
This property enables you to change the icon color (Work with '''iconImage''').
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconColor",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
 +
*'''normalColor:''' An integer of the color of the icon image of the button ( neither selected nor clicked by mouse ).
 +
*'''hoveringColor:''' An integer of the color of the icon image of the button which is selected.
 +
*'''clickedColor:''' An integer of the color of the icon image of the button which is clicked.
 +
 
 +
===iconDirection===
 +
This property enables you to change the direction of the icon (Work with '''iconImage''').
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconDirection",iconDirection)</syntaxhighlight>
 +
*'''iconDirection''' : A string determines where will the icon image be. Available values are "left" and "right".
 +
 
 +
===iconImage===
 +
Require [texture/shader] that can be used as the icon image of button.
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconImage",{normalImage,hoveringImage,ClickedImage})</syntaxhighlight>
 +
*'''normalImage:''' A texture/shader element of the icon image of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this option )
 +
*'''hoveringImage:''' A texture/shader element of the  icon image of the button which is selected. ( You can pass a nil value to disable this option )
 +
*'''clickedImage:''' A texture/shader element of the  icon image of the button which is clicked. ( You can pass a nil value to disable this option )
 +
 
 +
===iconOffset===
 +
This property enables you to change the offset of the icon from the text (Work with '''iconImage''').
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconOffset",iconOffset)</syntaxhighlight>
 +
*'''iconOffset''' : An integer of the 2D X offset in pixels to the position of the text.
 +
 
 +
===iconSize===
 +
This property enables you to change the icon size (Work with '''iconImage''').
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})</syntaxhighlight>
 +
*'''iconSizeX''' : An integer of the 2D X scale to the position of the icon image.
 +
*'''iconSizeY''' : An integer of the 2D Y scale to the position of the icon image.
 +
*'''relative''' : A bool of whether the iconSize is relative to the height of text or absolute pixels.
 +
 
 +
===image===
 +
Require [texture/shader] that can be used as the background of button.
 +
<syntaxhighlight lang="lua">dgsSetProperty(button,"image",{normalImage,hoveringImage,ClickedImage})</syntaxhighlight>
 +
*'''normalImage:''' A texture/shader element of the background of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this image option )
 +
*'''hoveringImage:''' A texture/shader element of the background of the button which is selected. ( You can pass a nil value to disable this image option )
 +
*'''clickedImage:''' A texture/shader element of the background of the button which is clicked. ( You can pass a nil value to disable this image option )
  
 
===text===
 
===text===
Line 34: Line 92:
 
===textOffset===
 
===textOffset===
 
The offset of the text on button.
 
The offset of the text on button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"textOffset",{offsetX,offsetY,relative)</syntaxhighlight>
+
<syntaxhighlight lang="lua">dgsSetProperty(button,"textOffset",{offsetX,offsetY,relative})</syntaxhighlight>
 
*'''offsetX''' : A float of the 2D X offset relative to the position of the button, depends on '''relative'''.
 
*'''offsetX''' : A float of the 2D X offset relative to the position of the button, depends on '''relative'''.
 
*'''offsetY''' : A float of the 2D Y offset relative to the position of the button, depends on '''relative'''.
 
*'''offsetY''' : A float of the 2D Y offset relative to the position of the button, depends on '''relative'''.
*'''relative''' : A bool of whether the offset is relative or not.
+
*'''relative''' : A bool of whether the offset is relative or absolute.
  
 
===textSize===
 
===textSize===
Line 51: Line 109:
 
*'''offsetY''' : A float of the 2D Y 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.
 
*'''color''' : An integer of the color of the shadow text of the button.
===font===
 
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
 
<syntaxhighlight lang="lua">dgsSetProperty(button,"font",font)</syntaxhighlight>
 
*'''font''' : A [[Element/DX_font|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.
 
<syntaxhighlight lang="lua">dgsSetProperty(button,"clickoffset",{offsetX,offsetY})</syntaxhighlight>
 
*'''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===
 
This indicates that which button of the mouse can have effect on the button.
 
<syntaxhighlight lang="lua">dgsSetProperty(button,"clickType",clickType)</syntaxhighlight>
 
*'''clickType''' : If set to 1, only "Left Mouse Button" can do. If set to 2, only "Right Mouse Button" can do. Otherwise it will be both.
 
  
 
===wordbreak===
 
===wordbreak===
Line 71: Line 114:
 
<syntaxhighlight lang="lua">dgsSetProperty(button,"wordbreak",wordbreak)</syntaxhighlight>
 
<syntaxhighlight lang="lua">dgsSetProperty(button,"wordbreak",wordbreak)</syntaxhighlight>
 
*'''wordbreak''' : If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.
 
*'''wordbreak''' : If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.
 
===colorcoded===
 
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
 
<syntaxhighlight lang="lua">dgsSetProperty(button,"colorcoded",colorcoded)</syntaxhighlight>
 
*'''colorcoded''' : Set to true to enable embedded #FFFFFF color codes.
 
 
===rightbottom===
 
Alignment of the text within the button
 
<syntaxhighlight lang="lua">dgsSetProperty(button,"rightbottom",{alignX,alignY})</syntaxhighlight>
 
*'''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".
 
  
 
==See Also==
 
==See Also==
 
{{DGSPROPERTIES}}
 
{{DGSPROPERTIES}}

Latest revision as of 15:28, 13 May 2020

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

alignment

Alignment of the text within the button.

dgsSetProperty(button,"alignment",{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".

clickoffset

The offset indicates that how much the text of the button will shift when it is clicked.

dgsSetProperty(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

This indicates that which button of the mouse can have effect on the button.

dgsSetProperty(button,"clickType",clickType)
  • clickType : If set to 1, only "Left Mouse Button" can do. If set to 2, only "Right Mouse Button" can do. Otherwise it will be both.

color

The color which can be translated by tocolor of the background of the button.

dgsSetProperty(button,"color",{normalColor,hoveringColor,clickedColor})
  • normalColor: An integer of the color of the background of the button ( neither selected nor clicked by mouse ).
  • hoveringColor: An integer of the color of the background of the button which is selected.
  • clickedColor: An integer of the color of the background of the button which is clicked.

colorcoded

Whether the color code is enabled or not. Learn More dxDrawText

dgsSetProperty(button,"colorcoded",colorcoded)
  • colorcoded : Set to true to enable embedded #FFFFFF color codes.

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText

dgsSetProperty(button,"font",font)

iconColor

This property enables you to change the icon color (Work with iconImage).

dgsSetProperty(button,"iconColor",{normalColor,hoveringColor,clickedColor})
  • normalColor: An integer of the color of the icon image of the button ( neither selected nor clicked by mouse ).
  • hoveringColor: An integer of the color of the icon image of the button which is selected.
  • clickedColor: An integer of the color of the icon image of the button which is clicked.

iconDirection

This property enables you to change the direction of the icon (Work with iconImage).

dgsSetProperty(button,"iconDirection",iconDirection)
  • iconDirection : A string determines where will the icon image be. Available values are "left" and "right".

iconImage

Require [texture/shader] that can be used as the icon image of button.

dgsSetProperty(button,"iconImage",{normalImage,hoveringImage,ClickedImage})
  • normalImage: A texture/shader element of the icon image of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this option )
  • hoveringImage: A texture/shader element of the icon image of the button which is selected. ( You can pass a nil value to disable this option )
  • clickedImage: A texture/shader element of the icon image of the button which is clicked. ( You can pass a nil value to disable this option )

iconOffset

This property enables you to change the offset of the icon from the text (Work with iconImage).

dgsSetProperty(button,"iconOffset",iconOffset)
  • iconOffset : An integer of the 2D X offset in pixels to the position of the text.

iconSize

This property enables you to change the icon size (Work with iconImage).

dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})
  • iconSizeX : An integer of the 2D X scale to the position of the icon image.
  • iconSizeY : An integer of the 2D Y scale to the position of the icon image.
  • relative : A bool of whether the iconSize is relative to the height of text or absolute pixels.

image

Require [texture/shader] that can be used as the background of button.

dgsSetProperty(button,"image",{normalImage,hoveringImage,ClickedImage})
  • normalImage: A texture/shader element of the background of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this image option )
  • hoveringImage: A texture/shader element of the background of the button which is selected. ( You can pass a nil value to disable this image option )
  • clickedImage: A texture/shader element of the background of the button which is clicked. ( You can pass a nil value to disable this image option )

text

This is equivalent to dgsSetText/dgsGetText.

dgsSetProperty(button,"text",text)
  • text : A string of the text of the button.

textColor

The color which can be translated by tocolor of the text of the button.

dgsSetProperty(button,"textColor",textColor)
  • textColor : An integer of the color of the text of the button.

textOffset

The offset of the text on button.

dgsSetProperty(button,"textOffset",{offsetX,offsetY,relative})
  • offsetX : A float of the 2D X offset relative to the position of the button, depends on relative.
  • offsetY : A float of the 2D Y offset relative to the position of the button, depends on relative.
  • relative : A bool of whether the offset is relative or absolute.

textSize

The scale of the text of the button. Learn More dxDrawText

dgsSetProperty(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.

dgsSetProperty(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.

wordbreak

Whether the word-break is enabled or not. Learn More dxDrawText

dgsSetProperty(button,"wordbreak",wordbreak)
  • wordbreak : If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

See Also

General Properties

Unique Properties