Dgs-dxlabel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 8: Line 8:


==Properties==
==Properties==
===text===
===alignment===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
Alignment of the text within the label.
<syntaxhighlight lang="lua">dgsSetProperty(label,"text",text)</syntaxhighlight>
 
*'''text''' : A string of the text of the label.
The functions as follows are based on this property.
 
[[dgsLabelSetHorizontalAlign]]/[[dgsLabelGetHorizontalAlign]]
 
[[dgsLabelSetVerticalAlign]]/[[dgsLabelGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(label,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the label. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the label. Can be "top", "center" or "bottom".
 
===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"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.


===textColor===
===colorCoded===
The color which can be translated by [[tocolor]] of the text of the label.
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"textColor",textColor)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(label,"colorCoded",colorCoded)</syntaxhighlight>
*'''textColor''' : An integer of the color of the text of the label.
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.


===textSize===
===font===
The scale of the text of the label. ''Learn More [[dxDrawText]]''
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"textSize",{scaleX,scaleY})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(label,"font",font)</syntaxhighlight>
*'''scaleX''' : A float of the 2D X scale of the text of the label.
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the label.
*'''scaleY''' : A float of the 2D Y scale of the text of the label.


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


===font===
===subPixelPositioning===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
This property determines whether the '''subPixelPositioning''' is enabled or not, by default, it is disable. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"font",font)</syntaxhighlight>
*'''font''' : A string or a [[Element/DX_font|dx font element]] of the text font of the label.


===wordbreak===
'''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.
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"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.


===colorcoded===
If you are using dgs animation library, you'd better turn this on.
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"subPixelPositioning",subPixelPositioning)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(label,"colorcoded",colorcoded)</syntaxhighlight>
*'''subPixelPositioning:''' A bool indicates whether to enable subPixelPositioning or not.
*'''colorcoded''' : Set to true to enable embedded #FFFFFF color codes.


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


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


The functions as follows are basic on this property.
===textOffset===
The offset of the text on label.
<syntaxhighlight lang="lua">dgsSetProperty(label,"textOffset",{offsetX,offsetY,relative})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X offset relative to the position of the label, depends on '''relative'''.
*'''offsetY''' : A float of the 2D Y offset relative to the position of the label, depends on '''relative'''.
*'''relative''' : A bool of whether the offset is relative or absolute.


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


[[dgsLabelSetVerticalAlign]]/[[dgsLabelGetVerticalAlign]]
===wordBreak===
<syntaxhighlight lang="lua">dgsSetProperty(label,"alignment",{alignX,alignY})</syntaxhighlight>
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
*'''alignX''' : Horizontal alignment of the text within the label. Can be "left", "center" or "right".
<syntaxhighlight lang="lua">dgsSetProperty(label,"wordBreak",wordBreak)</syntaxhighlight>
*'''alignY''' : Vertical alignment of the text within the label. Can be "top", "center" or "bottom".
*'''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==
==See Also==
{{DGSPROPERTIES}}
{{DGSPROPERTIES}}

Latest revision as of 09:01, 14 June 2022

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

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

Main Functions

Properties

alignment

Alignment of the text within the label.

The functions as follows are based on this property.

dgsLabelSetHorizontalAlign/dgsLabelGetHorizontalAlign

dgsLabelSetVerticalAlign/dgsLabelGetVerticalAlign 

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

clip

Whether the clip property is enabled or not. Learn More dxDrawText 

dgsSetProperty(label,"clip",clip)
  • 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 

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

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText 

dgsSetProperty(label,"font",font)

shadow

The shadow text of the label. 

dgsSetProperty(label,"shadow",{offsetX,offsetY,color,outline})
  • offsetX: A float of the 2D X offset of the shadow text of the label.
  • offsetY: A float of the 2D Y offset of the shadow text of the label.
  • color: An integer of the color of the shadow text of the label.
  • outline: An integer of the outline style 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. 

dgsSetProperty(label,"subPixelPositioning",subPixelPositioning)
  • subPixelPositioning: A bool indicates whether to enable subPixelPositioning or not.

text

This is equivalent to dgsSetText/dgsGetText. 

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

textColor

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

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

textOffset

The offset of the text on label. 

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

textSize

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

dgsSetProperty(label,"textSize",{scaleX,scaleY})
  • scaleX: A float of the 2D X scale of the text of the label.
  • scaleY: A float of the 2D Y scale of the text of the label.

wordBreak

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

dgsSetProperty(label,"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-dxlabel?oldid=75164"