Dgs-dxlabel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:


==Properties==
==Properties==
===alignment===
Alignment of the text within the label.
The functions as follows are basic 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.
===colorcoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"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(label,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the label.
===shadow===
The shadow text of the label.
<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.
*'''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:''' A bool of the outline state of the shadow text.
===text===
===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
Line 23: Line 58:
*'''scaleX:''' A float of the 2D X scale of the text of the label.
*'''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.
*'''scaleY:''' A float of the 2D Y scale of the text of the label.
===shadow===
The shadow text of the label.
<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.
*'''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:''' A bool of the outline state of the shadow text.
===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''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===
===wordbreak===
Line 41: Line 63:
<syntaxhighlight lang="lua">dgsSetProperty(label,"wordbreak",wordbreak)</syntaxhighlight>
<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.
*'''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(label,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.
===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.
===alignment===
Alignment of the text within the label.
The functions as follows are basic 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".


==See Also==
==See Also==
{{DGSPROPERTIES}}
{{DGSPROPERTIES}}

Revision as of 14:21, 1 October 2019

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 basic 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: A bool of the outline state of the shadow text.

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.

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=64448"