Thisdp at 10:09, 29 August 2021

2021-08-29T10:09:39Z

← Older revision		Revision as of 10:09, 29 August 2021
Line 46:		Line 46:

	===isReversed===		===isReversed===
	This property determines whether the selector is reversed ( ~~mirrored~~ ).		This property determines whether the selector is reversed ( mirrorred ).
	<syntaxhighlight lang="lua">dgsSetProperty(selector,"isReversed",isReversed)</syntaxhighlight>		<syntaxhighlight lang="lua">dgsSetProperty(selector,"isReversed",isReversed)</syntaxhighlight>
	*'''isReversed:''' A bool indicates whether the selector is reversed ( ~~mirrored~~ ).		*'''isReversed:''' A bool indicates whether the selector is reversed ( mirrorred ).

	===itemData===		===itemData===

Thisdp at 10:09, 29 August 2021

2021-08-29T10:09:22Z

@@ Line 39: / Line 39: @@
 <syntaxhighlight lang="lua">dgsSetProperty(selector,"font",font)</syntaxhighlight>
 *'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the selector.
 ===itemData===

Thisdp: Created page with "DGS Properties is always used to change the gui style and make it more fantastic. This page shows the properties of dgs-dxselector that you could use. ==Main Functio..."

2021-04-13T19:12:14Z

Created page with "DGS Properties is always used to change the gui style and make it more fantastic. This page shows the properties of dgs-dxselector that you could use. ==Main Functio..."

New page

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxselector that you could use.

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

==Properties==
===alignment===
Alignment of the text within the selector.

The functions as follows are based on this property.

[[dgsSelectorSetHorizontalAlign]]/[[dgsSelectorGetHorizontalAlign]]

[[dgsSelectorSetVerticalAlign]]/[[dgsSelectorGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(selector,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the selector. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the selector. Can be "top", "center" or "bottom".

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(selector,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorcoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(selector,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===enableScroll===
Enable/disable mouse wheel scroll items.
<syntaxhighlight lang="lua">dgsSetProperty(selector,"enableScroll",enableScroll)</syntaxhighlight>
*'''enableScroll:''' A bool indicates whether to enable wheel scrolling on selector.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(selector,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the selector.

===itemData===
This property stores item data.
<syntaxhighlight lang="lua">dgsSetProperty(selector,"itemData",itemData)</syntaxhighlight>
*'''itemData:''' A table stores all item data.

'''Data Structure:'''
<syntaxhighlight lang="lua">
{
{text,alignment,color,colorcoded,sizex,sizey,font,translationTest,data,imageData},
{text,alignment,color,colorcoded,sizex,sizey,font,translationTest,data,imageData},
{text,alignment,color,colorcoded,sizex,sizey,font,translationTest,data,imageData},
}
</syntaxhighlight>

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

===itemTextSize===
The scale of the item text of the selector. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(selector,"itemTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the item text of the selector.
*'''scaleY:''' A float of the 2D Y scale of the item text of the selector.

===placeHolder===
This property determines what text will be when there's no items in selector
<syntaxhighlight lang="lua">dgsSetProperty(selector,"placeHolder",placeHolder)</syntaxhighlight>
*'''placeHolder:''' A string of the text of the placeHolder of the selector.

===select===
This property stores the selected item of the selector.
<syntaxhighlight lang="lua">dgsSetProperty(selector,"select",select)</syntaxhighlight>
*'''select:''' A integer of the index of selected item .

===selectorSize===
This property determines the size of selector button.
<syntaxhighlight lang="lua">dgsSetProperty(selector,"selectorSize",{selectorSizeX,selectorSizeY,relative})</syntaxhighlight>
*'''selectorSizeX:''' A float of the 2D X size of selector button, set to ''nil'' to use '''selectorSizeY'''.
*'''selectorSizeY:''' A float of the 2D Y size of selector button, set to ''nil'' to use '''selectorSizeX'''.
*'''relative:''' A bool of whether the selectorSize is relative to the size of selector or absolute pixels.

===selectorText===
The text of selector button of the selector.
<syntaxhighlight lang="lua">dgsSetProperty(selector,"selectorText",{selectorTextLeft,selectorTextRight})</syntaxhighlight>
*'''selectorTextLeft:''' A string of the text of left selector button of the selector.
*'''selectorTextRight:''' A string of the text of right selector button of the selector.

===selectorTextColor===
The color which can be translated by [[tocolor]] of the text of selector button of the selector.
<syntaxhighlight lang="lua">dgsSetProperty(selector,"selectorTextColor",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the text of selector button of the selector ( neither hovering nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the text of selector button of the selector which is hovering.
*'''clickedColor:''' An integer of the color of the text of selector button of the selector which is clicked.

===selectorTextSize===
The scale of the text of the button of the selector. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(selector,"selectorTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the selector button of the selector.
*'''scaleY:''' A float of the 2D Y scale of the text of the selector button of the selector.

===shadow===
The shadow text of the selector.
<syntaxhighlight lang="lua">dgsSetProperty(selector,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the selector.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the selector.
*'''color:''' An integer of the color of the shadow text of the selector.
*'''outline:''' A bool of the outline state of the shadow text.

===subPixelPositioning===
This property determines whether the '''subPixelPositioning''' is enabled or not, by default, it is disable. ''Learn More [[dxDrawText]]''

'''subPixelPositioning''' Will make positioning and resizing animation looks better, but you should know, it may blur your static text with unrounded position and size, or alignment.

If you are using dgs animation library, you'd better turn this on.
<syntaxhighlight lang="lua">dgsSetProperty(selector,"subPixelPositioning",subPixelPositioning)</syntaxhighlight>
*'''subPixelPositioning:''' A bool indicates whether to enable subPixelPositioning or not.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(selector,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the selector.

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

===textSize===
The scale of the text of the selector. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(selector,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the selector.
*'''scaleY:''' A float of the 2D Y scale of the text of the selector.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxselector - Revision history

Thisdp at 10:09, 29 August 2021

Thisdp at 10:09, 29 August 2021

Thisdp: Created page with "DGS Properties is always used to change the gui style and make it more fantastic. This page shows the properties of dgs-dxselector that you could use. ==Main Functio..."