Dgs-dxwindow: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 19: Line 19:
*'''alignX:''' Horizontal alignment of the title text of the windowl. Can be "left", "center" or "right".
*'''alignX:''' Horizontal alignment of the title text of the windowl. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the title text of the window. Can be "top", "center" or "bottom".
*'''alignY:''' Vertical alignment of the title text of the window. Can be "top", "center" or "bottom".
===borderSize===
This property determines the border size in pixels which is used to resize the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"borderSize",borderSize)</syntaxhighlight>
*'''borderSize:''' An integer of the size of the border of the window in pixels.
===color===
The color which can be translated by [[tocolor]] of the background of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"color",color)</syntaxhighlight>
*'''color:''' An integer of the color of the background of the window.
===colorcoded===
Whether the color code in the title text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(window,"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(window,"font",font)</syntaxhighlight>
*'''font:''' A [[Element/DX_font|dx font element]] of the title text font of the window.
===ignoreTitle===
This property determines whether to ignore the window title when calculating window's child elements (useful for gui to dgs).
<syntaxhighlight lang="lua">dgsSetProperty(window,"ignoreTitle",ignoreTitle)</syntaxhighlight>
*'''ignoreTitle:''' A bool of the state of whether to ignore the window title.


===image===
===image===
Line 25: Line 50:
*'''image:''' A texture element of the background of the window.
*'''image:''' A texture element of the background of the window.


===color===
===maxSize===
The color which can be translated by [[tocolor]] of the background of the window.
This property determines the maximum width and height of the window that users can resize to.
<syntaxhighlight lang="lua">dgsSetProperty(window,"color",color)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"maxSize",{maxWidth,maxHeight})</syntaxhighlight>
*'''color:''' An integer of the color of the background of the window.
*'''maxWidth:''' An integer of the maximum width of the window.
*'''maxHeight:''' An integer of the maximum height of the window.


===textColor===
===minSize===
The color which can be translated by [[tocolor]] of the title text of the window.
This property determines the minimum width and height of the window that users can resize to.
<syntaxhighlight lang="lua">dgsSetProperty(window,"textColor",textColor)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"minSize",{minWidth,minHeight})</syntaxhighlight>
*'''textColor:''' An integer of the color of the title text of the window.
*'''minWidth:''' An integer of the minimum width of the window.
*'''minHeight:''' An integer of the minimum height of the window.


===titleColorBlur===
===movable===
The color which can be translated by [[tocolor]] of the title of the window when the window is blurred.
This is equivalent to [[dgsWindowSetMovable]], which allows you to specify whether or not a user can move a DGS window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleColorBlur",titleColorBlur)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"movable",movable)</syntaxhighlight>
*'''titleColorBlur:''' An integer of the color of the title of the blurred window.
*'''movable:''' A boolean value indicating whether user can move the window or not.


===titleColor===
===moveType===
The color which can be translated by [[tocolor]] of the title of the window when the window is focused.
This property determines the moving type of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleColor",titleColor)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"moveType",moveType)</syntaxhighlight>
*'''titleColor:''' An integer of the color of the title of the focused window.
*'''moveType:''' A boolean value indicating the state of the moving type.
**'''true:''' User can move the window by clicking anywhere of the window.
**'''false:''' User can move the window by only clicking the title of the window.


===titleImage===
===sizable===
The texture element(texture/render target/screen source/shader etc) of the title background of the window.
This is equivalent to [[dgsWindowSetSizable]], which allows you to specify whether or not a user can resize a DGS window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleImage",titleImage)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"sizable",sizable)</syntaxhighlight>
*'''titleImage:''' A texture element of the title background of the window.
*'''movable:''' A boolean value indicating whether user can resize the window or not.


===text===
===text===
Line 56: Line 85:


===textColor===
===textColor===
The color which can be translated by [[tocolor]] of the text of the window.
The color which can be translated by [[tocolor]] of the title text of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"textColor",textColor)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the title text of the window.
*'''textColor:''' An integer of the color of the title text of the window.
Line 66: Line 95:
*'''scaleY:''' A float of the 2D Y scale of the title text of the window.
*'''scaleY:''' A float of the 2D Y scale of the title text of the window.


===font===
===titleColor===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
The color which can be translated by [[tocolor]] of the title of the window when the window is focused.
<syntaxhighlight lang="lua">dgsSetProperty(window,"font",font)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleColor",titleColor)</syntaxhighlight>
*'''font:''' A [[Element/DX_font|dx font element]] of the title text font of the window.
*'''titleColor:''' An integer of the color of the title of the focused window.


===colorcoded===
===titleColorBlur===
Whether the color code in the title text is enabled or not. ''Learn More [[dxDrawText]]''
The color which can be translated by [[tocolor]] of the title of the window when the window is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(window,"colorcoded",colorcoded)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleColorBlur",titleColorBlur)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.
*'''titleColorBlur:''' An integer of the color of the title of the blurred window.
 
===movetyp===
This property determines the moving type of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"movetyp",movetyp)</syntaxhighlight>
*'''movetyp:''' A boolean value indicating the state of the moving type.
**'''true:''' User can move the window by clicking anywhere of the window.
**'''false:''' User can move the window by only clicking the title of the window.
 
===movable===
This is equivalent to [[dgsWindowSetMovable]], which allows you to specify whether or not a user can move a DGS window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"movable",movable)</syntaxhighlight>
*'''movable:''' A boolean value indicating whether user can move the window or not.
 
===sizable===
This is equivalent to [[dgsWindowSetSizable]], which allows you to specify whether or not a user can resize a DGS window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"sizable",sizable)</syntaxhighlight>
*'''movable:''' A boolean value indicating whether user can resize the window or not.
 
===minSize===
This property determines the minimum width and height of the window that users can resize to.
<syntaxhighlight lang="lua">dgsSetProperty(window,"minSize",{minWidth,minHeight})</syntaxhighlight>
*'''minWidth:''' An integer of the minimum width of the window.
*'''minHeight:''' An integer of the minimum height of the window.
 
===maxSize===
This property determines the maximum width and height of the window that users can resize to.
<syntaxhighlight lang="lua">dgsSetProperty(window,"maxSize",{maxWidth,maxHeight})</syntaxhighlight>
*'''maxWidth:''' An integer of the maximum width of the window.
*'''maxHeight:''' An integer of the maximum height of the window.
 
===borderSize===
This property determines the border size in pixels which is used to resize the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"borderSize",borderSize)</syntaxhighlight>
*'''borderSize:''' An integer of the size of the border of the window in pixels.


===titleHeight===
===titleHeight===
Line 115: Line 110:
*'''titleHeight:''' An integer of the size of the title of the window in pixels.
*'''titleHeight:''' An integer of the size of the title of the window in pixels.


===ignoreTitle===
===titleImage===
This property determines whether to ignore the window title when calculating window's child elements (useful for gui to dgs).
The texture element(texture/render target/screen source/shader etc) of the title background of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"ignoreTitle",ignoreTitle)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleImage",titleImage)</syntaxhighlight>
*'''ignoreTitle:''' A bool of the state of whether to ignore the window title.
*'''titleImage:''' A texture element of the title background of the window.


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

Revision as of 05:58, 17 February 2021

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

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

Main Functions

Properties

alignment

Alignment of the title text of the window.

The functions as follows are based on this property.

dgsWindowSetHorizontalAlign/dgsWindowGetHorizontalAlign

dgsWindowSetVerticalAlign/dgsWindowGetVerticalAlign 

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

borderSize

This property determines the border size in pixels which is used to resize the window. 

dgsSetProperty(window,"borderSize",borderSize)
  • borderSize: An integer of the size of the border of the window in pixels.

color

The color which can be translated by tocolor of the background of the window. 

dgsSetProperty(window,"color",color)
  • color: An integer of the color of the background of the window.

colorcoded

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

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

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText 

dgsSetProperty(window,"font",font)

ignoreTitle

This property determines whether to ignore the window title when calculating window's child elements (useful for gui to dgs). 

dgsSetProperty(window,"ignoreTitle",ignoreTitle)
  • ignoreTitle: A bool of the state of whether to ignore the window title.

image

The texture element(texture/render target/screen source/shader etc) of the background of the window. 

dgsSetProperty(window,"image",image)
  • image: A texture element of the background of the window.

maxSize

This property determines the maximum width and height of the window that users can resize to. 

dgsSetProperty(window,"maxSize",{maxWidth,maxHeight})
  • maxWidth: An integer of the maximum width of the window.
  • maxHeight: An integer of the maximum height of the window.

minSize

This property determines the minimum width and height of the window that users can resize to. 

dgsSetProperty(window,"minSize",{minWidth,minHeight})
  • minWidth: An integer of the minimum width of the window.
  • minHeight: An integer of the minimum height of the window.

movable

This is equivalent to dgsWindowSetMovable, which allows you to specify whether or not a user can move a DGS window. 

dgsSetProperty(window,"movable",movable)
  • movable: A boolean value indicating whether user can move the window or not.

moveType

This property determines the moving type of the window. 

dgsSetProperty(window,"moveType",moveType)
  • moveType: A boolean value indicating the state of the moving type.
    • true: User can move the window by clicking anywhere of the window.
    • false: User can move the window by only clicking the title of the window.

sizable

This is equivalent to dgsWindowSetSizable, which allows you to specify whether or not a user can resize a DGS window. 

dgsSetProperty(window,"sizable",sizable)
  • movable: A boolean value indicating whether user can resize the window or not.

text

This is equivalent to dgsSetText/dgsGetText. 

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

textColor

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

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

textSize

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

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

titleColor

The color which can be translated by tocolor of the title of the window when the window is focused. 

dgsSetProperty(window,"titleColor",titleColor)
  • titleColor: An integer of the color of the title of the focused window.

titleColorBlur

The color which can be translated by tocolor of the title of the window when the window is blurred. 

dgsSetProperty(window,"titleColorBlur",titleColorBlur)
  • titleColorBlur: An integer of the color of the title of the blurred window.

titleHeight

This property determines the title size in pixels which is also used to move the window. 

dgsSetProperty(window,"titleHeight",titleHeight)
  • titleHeight: An integer of the size of the title of the window in pixels.

titleImage

The texture element(texture/render target/screen source/shader etc) of the title background of the window. 

dgsSetProperty(window,"titleImage",titleImage)
  • titleImage: A texture element of the title background of the window.

See Also

General Properties

Unique Properties For DGS Core Elements

Extra Properties For DGS Plugins

Retrieved from "https://wiki.multitheftauto.com/wiki/Dgs-dxwindow?oldid=69040"