Dgs-dxmemo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(14 intermediate revisions by 3 users not shown)
Line 17: Line 17:
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgColor",bgColor)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:'''  An integer of the color that can be converted by [[tocolor]].
*'''bgColor:'''  An integer of the color that can be converted by [[tocolor]].
===bgColorBlur===
This property determines the background color of the memo when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgColorBlur",bgColorBlur)</syntaxhighlight>
*'''bgColorBlur:'''  An integer of the color that can be converted by [[tocolor]], leave to nil to use bgColor.


===bgImage===
===bgImage===
Line 22: Line 27:
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgImage",bgImage)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:'''  A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget).
*'''bgImage:'''  A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget).
===bgImageBlur===
This property determines the background image of the memo when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgImageBlur",bgImageBlur)</syntaxhighlight>
*'''bgImageBlur:'''  A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget), leave to nil to use bgImage.


===caretColor===
===caretColor===
Line 35: Line 45:
===caretOffset===
===caretOffset===
The offset of the caret of the memo.
The offset of the caret of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretOffset",{offsetX,offsetY})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretOffset",offsetY)</syntaxhighlight>
*'''offsetX:'''  A float of the 2D X position offset of the caret of the memo.
*'''offsetY:'''  A float of the 2D Y position offset of the caret of the memo.
*'''offsetY:'''  A float of the 2D Y position offset of the caret of the memo.


Line 70: Line 79:
*'''font:'''  A [[Element/DX_font|dx font element]] of the text font of the memo.
*'''font:'''  A [[Element/DX_font|dx font element]] of the text font of the memo.


===memo===
===padding===
This property stores a gui-memo which is used to input characters.
This property determines the content padding from 4 sides of element (left/top/right/bottom)
<syntaxhighlight lang="lua">dgsSetProperty(memo,"memo",gmemo)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"padding", {horizontal, vertical})</syntaxhighlight>
*'''gmemo:''' A gui-memo.
*'''horizontal:'''  A float of the horizontal padding in pixels.
*'''vertical:'''  A float of the vertical padding in pixels.
 
===placeHolder===
This is equivalent to [[dgsEditSetPlaceHolder]]//[[dgsEditGetPlaceHolder]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolder",placeHolder)</syntaxhighlight>
*'''placeHolder''' : A string of the place holder text of dgs edit ( This text will show when there is no text in a blurred dgs edit ).
 
===placeHolderColor===
This property determines the color of the place holder text. The color which can be translated by [[tocolor]].
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderColor",placeHolderColor)</syntaxhighlight>
*'''placeHolderColor''' : An integer of the color of the place holder text of the edit.
 
===placeHolderColorcoded===
This property determines whether the place holder supports color code.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderColorcoded",placeHolderColorcoded)</syntaxhighlight>
*'''placeHolderColorcoded''' : A bool indicates whether the place holder supports color code.
 
===placeHolderFont===
This property changes the font of place holder.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderFont",placeHolderFont)</syntaxhighlight>
*'''placeHolderFont''' : A string/dx-font element of the font of the place holder.
 
===placeHolderIgnoreRenderTarget===
This property determines whether the place holder isn't restricted by render target.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderIgnoreRenderTarget",placeHolderIgnoreRenderTarget)</syntaxhighlight>
*'''placeHolderIgnoreRenderTarget''' : A bool indicates whether the place holder isn't restricted by render target.
 
===placeHolderOffset===
This property allows place holder has offsets relative to its original position.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderOffset",{ xOffset, yOffset })</syntaxhighlight>
*'''xOffset''' : An integer of 2D x offset.
*'''yOffset''' : An integer of 2D y offset.
 
===placeHolderVisibleWhenFocus===
This property allows place holder to be visible even when edit is focused.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderVisibleWhenFocus",placeHolderVisibleWhenFocus)</syntaxhighlight>
*'''placeHolderVisibleWhenFocus''' : A bool indicates whether the place holder when the edit is focused.


===readOnly===
===readOnly===
Line 105: Line 151:
<syntaxhighlight lang="lua">dgsSetProperty(memo,"scrollSize",scrollSize)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"scrollSize",scrollSize)</syntaxhighlight>
*'''scrollSize:'''  Lines to be scrolled.
*'''scrollSize:'''  Lines to be scrolled.
===selectColorBlur===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the memo when blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectColorBlur",selectColorBlur)</syntaxhighlight>
*'''selectColorBlur:'''  An integer of the color of the rectangle of text selection of the memo when blurred.


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


===selectFrom===
===selectFrom===
Line 116: Line 167:
*'''index:'''  An integer of the index of the text in the line where the text is selected from of the memo.
*'''index:'''  An integer of the index of the text in the line where the text is selected from of the memo.
*'''line:'''  An integer of the line where the text is selected from of the memo.
*'''line:'''  An integer of the line where the text is selected from of the memo.
===shadow===
The shadow text of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''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.
*'''outline:''' An integer of the outline style of the shadow text.


===showLine===
===showLine===
The min value of the line of the text of the memo starts to show in the render target. ( I don't know how to explain it also. XD )
This property stores the value of how many lines does the text move to top.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"showLine",line)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"showLine",line)</syntaxhighlight>
*'''line:'''  An integer indicates how many lines are moved to top.
*'''line:'''  An integer indicates how many lines does the text move to top.


===showPos===
===showPos===
The min value of the x position of the text of the memo starts to show in the render target. ( I don't know how to explain it. XD )
This property stores the value of how many pixels of the text are moved to left.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"showPos",posX)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"showPos",posX)</syntaxhighlight>
*'''posX:'''  An integer indicates how many the pixels of the text are moved to left.
*'''posX:'''  An integer indicates how many pixels of the text are moved to left.


===text===
===text===
Line 153: Line 212:
*'''typingSound:'''  A string of the path/url of typing sound.
*'''typingSound:'''  A string of the path/url of typing sound.


===wordWarp===
===typingSoundVolume===
This property determines the word warp state of dgs memo. This is equivalent to [[dgsMemoSetWordWarpState]]/[[dgsMemoGetWordWarpState]]
Typing sound, nil for disabled. This is equivalent to [[dgsMemoSetTypingSoundVolume]]/[[dgsMemoGetTypingSoundVolume]]
<syntaxhighlight lang="lua">dgsSetProperty(memo,"wordWarp",wordWarp)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"typingSoundVolume",typingSoundVolume)</syntaxhighlight>
*'''wordWarp:'''  An integer or a bool of word warp state, vaild state are as follows:
*'''typingSoundVolume:'''  A float of the volume of the typing sound. Range is from 0.0 to 1.0. This can go above 1.0 for amplification.
**'''false:''' Non-wordwarp
 
===wordWrap===
This property determines the word wrap state of dgs memo. This is equivalent to [[dgsMemoSetWordWrapState]]/[[dgsMemoGetWordWrapState]]
<syntaxhighlight lang="lua">dgsSetProperty(memo,"wordWrap",wordWrap)</syntaxhighlight>
*'''wordWarp:'''  An integer or a bool of word wrap state, vaild state are as follows:
**'''false:''' Non-wordwrap
**'''1:''' Split via single character ( This will break a word into 2 parts )
**'''1:''' Split via single character ( This will break a word into 2 parts )
**'''2:''' Split via word
**'''2:''' Split via word

Latest revision as of 06:24, 11 June 2023

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

allowCopy

This property determines whether the content of memo can be copy(ctrl+c)/cut(ctrl+x) 

dgsSetProperty(memo,"allowCopy",allowCopy)
  • allowCopy: A boolean value of the state of whether this memo allows users to copy something from it.

bgColor

This property determines the background color of the memo. 

dgsSetProperty(memo,"bgColor",bgColor)
  • bgColor: An integer of the color that can be converted by tocolor.

bgColorBlur

This property determines the background color of the memo when it is blurred. 

dgsSetProperty(memo,"bgColorBlur",bgColorBlur)
  • bgColorBlur: An integer of the color that can be converted by tocolor, leave to nil to use bgColor.

bgImage

This property determines the background image of the memo. 

dgsSetProperty(memo,"bgImage",bgImage)
  • bgImage: A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget).

bgImageBlur

This property determines the background image of the memo when it is blurred. 

dgsSetProperty(memo,"bgImageBlur",bgImageBlur)
  • bgImageBlur: A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget), leave to nil to use bgImage.

caretColor

This property determines the color of the caret 

dgsSetProperty(memo,"caretColor",caretColor)
  • caretColor: An integer of the color that can be converted by tocolor.

caretHeight

The height of the caret of the memo (multiple of the font height). 

dgsSetProperty(memo,"caretHeight",caretHeight)
  • caretHeight: A float of the caret height.

caretOffset

The offset of the caret of the memo. 

dgsSetProperty(memo,"caretOffset",offsetY)
  • offsetY: A float of the 2D Y position offset of the caret of the memo.

caretPos

The position in which the caret stays. 

dgsSetProperty(memo,"caretPos",{index,line})
  • index: An integer of the index of the text in current line of the memo.
  • line: An integer of the line of the memo.

caretStyle

This is equivalent to dgsMemoSetCaretStyle/dgsMemoGetCaretStyle.

This property allows us to change the style of caret of the memo. ( 0 is "|"; 1 is "_" )

Example(0):

This is Text|

Example(1):

This is Text_ 

dgsSetProperty(memo,"caretStyle",caretStyle)
  • caretStyle: An integer of the caret style of the memo.

caretThick

This property allows us to change the thickness of caret of the memo. 

dgsSetProperty(memo,"caretThick",caretThick)
  • caretThick: An integer of the thickness of the caret of the memo.

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText 

dgsSetProperty(memo,"font",font)

padding

This property determines the content padding from 4 sides of element (left/top/right/bottom) 

dgsSetProperty(memo,"padding", {horizontal, vertical})
  • horizontal: A float of the horizontal padding in pixels.
  • vertical: A float of the vertical padding in pixels.

placeHolder

This is equivalent to dgsEditSetPlaceHolder//dgsEditGetPlaceHolder 

dgsSetProperty(edit,"placeHolder",placeHolder)
  • placeHolder : A string of the place holder text of dgs edit ( This text will show when there is no text in a blurred dgs edit ).

placeHolderColor

This property determines the color of the place holder text. The color which can be translated by tocolor. 

dgsSetProperty(edit,"placeHolderColor",placeHolderColor)
  • placeHolderColor : An integer of the color of the place holder text of the edit.

placeHolderColorcoded

This property determines whether the place holder supports color code. 

dgsSetProperty(edit,"placeHolderColorcoded",placeHolderColorcoded)
  • placeHolderColorcoded : A bool indicates whether the place holder supports color code.

placeHolderFont

This property changes the font of place holder. 

dgsSetProperty(edit,"placeHolderFont",placeHolderFont)
  • placeHolderFont : A string/dx-font element of the font of the place holder.

placeHolderIgnoreRenderTarget

This property determines whether the place holder isn't restricted by render target. 

dgsSetProperty(edit,"placeHolderIgnoreRenderTarget",placeHolderIgnoreRenderTarget)
  • placeHolderIgnoreRenderTarget : A bool indicates whether the place holder isn't restricted by render target.

placeHolderOffset

This property allows place holder has offsets relative to its original position. 

dgsSetProperty(edit,"placeHolderOffset",{ xOffset, yOffset })
  • xOffset : An integer of 2D x offset.
  • yOffset : An integer of 2D y offset.

placeHolderVisibleWhenFocus

This property allows place holder to be visible even when edit is focused. 

dgsSetProperty(edit,"placeHolderVisibleWhenFocus",placeHolderVisibleWhenFocus)
  • placeHolderVisibleWhenFocus : A bool indicates whether the place holder when the edit is focused.

readOnly

This is equivalent to dgsMemoSetReadOnly/dgsMemoGetReadOnly. 

dgsSetProperty(memo,"readOnly",readOnly)
  • readOnly: A bool indicates whether the memo is only readable.

readOnlyCaretShow

Whether the caret of memo will show/hide under read-only mode. 

dgsSetProperty(memo,"readOnlyCaretShow",readOnlyCaretShow)
  • readOnlyCaretShow: A bool indicates whether the caret is shown or hidden when the memo is read-only.

renderTarget

This property stores a render target of the memo. 

dgsSetProperty(memo,"renderTarget",renderTarget)
  • renderTarget: A render target that is used to render the text.

scrollbars

This property stores two scroll bars which can be got by dgsMemoGetScrollBar of the memo. 

dgsSetProperty(memo,"scrollbars",{Vertical,Horizontal})
  • Vertical: A vertical scroll bar of the memo.
  • Horizontal: A horizontal scroll bar of the memo.

scrollBarThick

This property allows us to change the thickness of scroll bars of the memo. 

dgsSetProperty(memo,"scrollBarThick",scrollBarThick)
  • scrollBarThick: An integer of the thickness of scroll bars of the memo.

scrollSize

This property determines how many lines will get scrolled out of the rendering area once when you are scrolling your mouse wheel. 

dgsSetProperty(memo,"scrollSize",scrollSize)
  • scrollSize: Lines to be scrolled.

selectColorBlur

The color which can be translated by tocolor of the rectangle of text selection of the memo when blurred. 

dgsSetProperty(memo,"selectColorBlur",selectColorBlur)
  • selectColorBlur: An integer of the color of the rectangle of text selection of the memo when blurred.

selectColor

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

dgsSetProperty(memo,"selectColor",selectColor)
  • selectColor: An integer of the color of the rectangle of text selection of the memo.

selectFrom

The position from which the text is selected. 

dgsSetProperty(memo,"selectFrom",{index,line})
  • index: An integer of the index of the text in the line where the text is selected from of the memo.
  • line: An integer of the line where the text is selected from of the memo.

shadow

The shadow text of the memo. 

dgsSetProperty(memo,"shadow",{offsetX,offsetY,color,outline})
  • 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.
  • outline: An integer of the outline style of the shadow text.

showLine

This property stores the value of how many lines does the text move to top. 

dgsSetProperty(memo,"showLine",line)
  • line: An integer indicates how many lines does the text move to top.

showPos

This property stores the value of how many pixels of the text are moved to left. 

dgsSetProperty(memo,"showPos",posX)
  • posX: An integer indicates how many pixels of the text are moved to left.

text

This is equivalent to dgsSetText/dgsGetText. 

dgsSetProperty(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 which can be translated by tocolor of the text of the memo. 

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

textLength

This is for scroll bar detection. You had better not touch it. 

dgsSetProperty(memo,"textLength",textlen)
  • textlen: A table stores the length of text in every line.

textSize

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

dgsSetProperty(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.

typingSound

Typing sound, nil for disabled. This is equivalent to dgsMemoSetTypingSound/dgsMemoGetTypingSound 

dgsSetProperty(memo,"typingSound",typingSound)
  • typingSound: A string of the path/url of typing sound.

typingSoundVolume

Typing sound, nil for disabled. This is equivalent to dgsMemoSetTypingSoundVolume/dgsMemoGetTypingSoundVolume 

dgsSetProperty(memo,"typingSoundVolume",typingSoundVolume)
  • typingSoundVolume: A float of the volume of the typing sound. Range is from 0.0 to 1.0. This can go above 1.0 for amplification.

wordWrap

This property determines the word wrap state of dgs memo. This is equivalent to dgsMemoSetWordWrapState/dgsMemoGetWordWrapState 

dgsSetProperty(memo,"wordWrap",wordWrap)
  • wordWarp: An integer or a bool of word wrap state, vaild state are as follows:
    • false: Non-wordwrap
    • 1: Split via single character ( This will break a word into 2 parts )
    • 2: Split via word

See Also

General Properties

Unique Properties For DGS Core Elements

Extra Properties For DGS Plugins

Retrieved from "https://wiki.multitheftauto.com/wiki/Dgs-dxmemo?oldid=76890"