Dgs-dxmemo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 14: Line 14:


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


===textsize===
===textsize===
The scale of the text of the label. ''Learn More [[dxDrawText]]''
The scale of the text of the memo. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsDxGUISetProperty(label,"textsize",{scaleX,scaleY})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsDxGUISetProperty(memo,"textsize",{scaleX,scaleY})</syntaxhighlight>
*'''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 memo.
*'''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 memo.


===shadow===
===shadow===
The shadow text of the label.
The shadow text of the memo.
<syntaxhighlight lang="lua">dgsDxGUISetProperty(label,"shadow",{offsetX,offsetY,color})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsDxGUISetProperty(memo,"shadow",{offsetX,offsetY,color})</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 memo.
*'''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 memo.
*'''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 memo.
===font===
===font===
This is equivalent to [[dgsDxGUISetFont]]/[[dgsDxGUIGetFont]]. ''Learn More [[dxDrawText]]''
This is equivalent to [[dgsDxGUISetFont]]/[[dgsDxGUIGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsDxGUISetProperty(label,"font",font)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsDxGUISetProperty(memo,"font",font)</syntaxhighlight>
*'''font''' : A [[Element/DX_font|dx font element]] of the text font of the label.
*'''font''' : A [[Element/DX_font|dx font element]] of the text font of the memo.


===wordbreak===
===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(label,"wordbreak",wordbreak)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsDxGUISetProperty(memo,"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===
===colorcoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsDxGUISetProperty(label,"colorcoded",colorcoded)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsDxGUISetProperty(memo,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded''' : Set to true to enable embedded #FFFFFF color codes.
*'''colorcoded''' : Set to true to enable embedded #FFFFFF color codes.


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


===rightbottom===
===rightbottom===
Alignment of the text within the label
Alignment of the text within the memo
<syntaxhighlight lang="lua">dgsDxGUISetProperty(label,"rightbottom",{alignX,alignY})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsDxGUISetProperty(memo,"rightbottom",{alignX,alignY})</syntaxhighlight>
*'''alignX''' : Horizontal alignment of the text within the label. Can be "left", "center" or "right".
*'''alignX''' : Horizontal alignment of the text within the memo. Can be "left", "center" or "right".
*'''alignY''' : Vertical alignment of the text within the label. Can be "top", "center" or "bottom".
*'''alignY''' : Vertical alignment of the text within the memo. Can be "top", "center" or "bottom".

Revision as of 12:07, 18 November 2017

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

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

Main Functions

Properties

text

This is equivalent to dgsDxGUISetText/dgsDxGUIGetText.

dgsDxGUISetProperty(memo,"text",text)
  • text : A table of the text of the memo.( Because of multi lines, I use table instead of string )

textcolor

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

dgsDxGUISetProperty(memo,"textcolor",textcolor)
  • textcolor : An integer of the color of the text of the memo.

textsize

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

dgsDxGUISetProperty(memo,"textsize",{scaleX,scaleY})
  • scaleX : A float of the 2D X scale of the text of the memo.
  • scaleY : A float of the 2D Y scale of the text of the memo.

shadow

The shadow text of the memo.

dgsDxGUISetProperty(memo,"shadow",{offsetX,offsetY,color})
  • offsetX : A float of the 2D X offset of the shadow text of the memo.
  • offsetY : A float of the 2D Y offset of the shadow text of the memo.
  • color : An integer of the color of the shadow text of the memo.

font

This is equivalent to dgsDxGUISetFont/dgsDxGUIGetFont. Learn More dxDrawText

dgsDxGUISetProperty(memo,"font",font)

wordbreak

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

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

colorcoded

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

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

clip

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

dgsDxGUISetProperty(memo,"clip",clip)
  • clip : If set to true, the parts of the text that don't fit within the bounding box will be cut off.

rightbottom

Alignment of the text within the memo

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