Dgs-dxbutton: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[https://wiki.multitheftauto.com/wiki/Dgs|DGS] Properties is always used to change the gui style and make it more fantastic.
[[Dgs|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.
This page shows the properties of dgs-dxbutton that you could use.


==Main Functions==
==Main Functions==
*[[dgsDxGUISetProperty]]
*[[dgsSetProperty]]
*[[dgsDxGUIGetProperty]]
*[[dgsGetProperty]]


==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">dgsDxGUISetProperty(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.


===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">dgsDxGUISetProperty(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.
 
===disabledColor===
The color which can be translated by [[tocolor]] of the background of the button when disabled.
<syntaxhighlight lang="lua">dgsSetProperty(button,"disabledColor",disabledColor)</syntaxhighlight>
*'''disabledColor:''' An integer of the color of the background of the button when disabled.
 
===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.
 
===colorTransitionPeriod===
This property sets the transition period among colors (normal, hovering, clicked).
<syntaxhighlight lang="lua">dgsSetProperty(button,"colorTransitionPeriod",colorTransitionPeriod)</syntaxhighlight>
*'''colorTransitionPeriod''' : An integer indicates the transition time in miliseconds. ( Set to 0 to disable )
 
===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.
 
===iconAlignment===
Alignment of the icon within the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the icon within the button. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the icon within the button. Can be "top", "center" or "bottom".
 
===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.
 
===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",{iconOffsetX,iconOffsetY,relative})</syntaxhighlight>
*'''iconOffsetX''' : An integer of the 2D X offset in pixels to the position of the icon.
*'''iconOffsetY''' : An integer of the 2D Y offset in pixels to the position of the icon.
*'''relative''' : A bool of whether the iconOffset is relative to the height of text or absolute pixels.
 
===iconRelative===
This property determines whether the icon is relative to the text or button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconRelative",iconRelative)</syntaxhighlight>
*'''iconRelative:''' A bool  determines whether the icon is relative to the text or button.
 
===iconShadow===
The shadow icon image of the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconShadow",{offsetX,offsetY,color})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X offset of the shadow icon of the button.
*'''offsetY''' : A float of the 2D Y offset of the shadow icon of the button.
*'''color''' : An integer of the color of the shadow icon of the button.
 
===iconSize===
This property enables you to change the icon size (Work with '''iconImage''').
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})</syntaxhighlight>
*'''iconSizeX''' : A number of the 2D X scale to the size of the icon image.
*'''iconSizeY''' : A number of the 2D Y scale to the size 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",image)</syntaxhighlight>
*'''image:''' A texture/shader element of the background of the button
Or
<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===
This is equivalent to [[dgsDxGUISetText]]/[[dgsDxGUIGetText]].
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsDxGUISetProperty(button,"text",text)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(button,"text",text)</syntaxhighlight>
*'''text''' : A string of the text of the button.
*'''text''' : A string of the text of the button.


===textcolor===
===textColor===
The color which can be translated by [[tocolor]] of the text of the button.
The color which can be translated by [[tocolor]] of the text of the button.
<syntaxhighlight lang="lua">dgsDxGUISetProperty(button,"textcolor",textcolor)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(button,"textColor",textColor)</syntaxhighlight>
*'''textcolor''' : An integer of the color of the text of the button.
*'''textColor''' : An integer of the color of the text of the button.


===textsize===
===textOffset===
The offset of the text on button.
<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'''.
*'''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.
 
 
===textPadding===
The text padding of the text on button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"textPadding",{offsetX,offsetY,relative})</syntaxhighlight>
*'''textPaddingX''' : A float of the 2D horizontal padding relative to the size of the button, depends on '''relative'''.
*'''textPaddingY''' : A float of the 2D vertical padding offset relative to the size of the button, depends on '''relative'''.
*'''relative''' : A bool of whether the padding is relative or absolute.
 
===textSize===
The scale of the text of the button. ''Learn More [[dxDrawText]]''
The scale of the text of the button. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsDxGUISetProperty(button,"textsize",{scaleX,scaleY})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(button,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : A float of the 2D X scale of the text of the button.
*'''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.
*'''scaleY''' : A float of the 2D Y scale of the text of the button.
Line 40: Line 136:
===shadow===
===shadow===
The shadow text of the button.
The shadow text of the button.
<syntaxhighlight lang="lua">dgsDxGUISetProperty(button,"shadow",{offsetX,offsetY,color})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(button,"shadow",{offsetX,offsetY,color})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X offset of the shadow text of the button.
*'''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.
*'''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 [[dgsDxGUISetFont]]/[[dgsDxGUIGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsDxGUISetProperty(button,"font",font)</syntaxhighlight>
*'''font''' : A [[Element/DX_font|dx font element]] of the text font of the button.


===clickoffset===
===wordBreak===
The offset indicates that how much the text of the button will shift when it is clicked.
<syntaxhighlight lang="lua">dgsDxGUISetProperty(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">dgsDxGUISetProperty(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===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsDxGUISetProperty(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.
 
==See Also==
===colorcoded===
{{DGSPROPERTIES}}
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsDxGUISetProperty(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">dgsDxGUISetProperty(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".

Latest revision as of 12:01, 8 November 2023

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.

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.

disabledColor

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

dgsSetProperty(button,"disabledColor",disabledColor)
  • disabledColor: An integer of the color of the background of the button when disabled.

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.

colorTransitionPeriod

This property sets the transition period among colors (normal, hovering, clicked). 

dgsSetProperty(button,"colorTransitionPeriod",colorTransitionPeriod)
  • colorTransitionPeriod : An integer indicates the transition time in miliseconds. ( Set to 0 to disable )

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText 

dgsSetProperty(button,"font",font)

iconAlignment

Alignment of the icon within the button. 

dgsSetProperty(button,"iconAlignment",{alignX,alignY})
  • alignX: Horizontal alignment of the icon within the button. Can be "left", "center" or "right".
  • alignY: Vertical alignment of the icon within the button. Can be "top", "center" or "bottom".

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.

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",{iconOffsetX,iconOffsetY,relative})
  • iconOffsetX : An integer of the 2D X offset in pixels to the position of the icon.
  • iconOffsetY : An integer of the 2D Y offset in pixels to the position of the icon.
  • relative : A bool of whether the iconOffset is relative to the height of text or absolute pixels.

iconRelative

This property determines whether the icon is relative to the text or button. 

dgsSetProperty(button,"iconRelative",iconRelative)
  • iconRelative: A bool determines whether the icon is relative to the text or button.

iconShadow

The shadow icon image of the button. 

dgsSetProperty(button,"iconShadow",{offsetX,offsetY,color})
  • offsetX : A float of the 2D X offset of the shadow icon of the button.
  • offsetY : A float of the 2D Y offset of the shadow icon of the button.
  • color : An integer of the color of the shadow icon of the button.

iconSize

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

dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})
  • iconSizeX : A number of the 2D X scale to the size of the icon image.
  • iconSizeY : A number of the 2D Y scale to the size 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",image)
  • image: A texture/shader element of the background of the button

Or 

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.


textPadding

The text padding of the text on button. 

dgsSetProperty(button,"textPadding",{offsetX,offsetY,relative})
  • textPaddingX : A float of the 2D horizontal padding relative to the size of the button, depends on relative.
  • textPaddingY : A float of the 2D vertical padding offset relative to the size of the button, depends on relative.
  • relative : A bool of whether the padding 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 For DGS Core Elements

Extra Properties For DGS Plugins

Retrieved from "https://wiki.multitheftauto.com/wiki/Dgs-dxbutton?oldid=78566"